| java.lang.Object
 com.gwtext.client.core.JsObject
com.gwtext.client.widgets.LoadMask
| LoadMask | | public class LoadMask extends JsObject (Code) | | A simple utility class for generically masking elements while loading data. If the element being masked has an
underlying
com.gwtext.client.data.Store , the masking will be automatically synchronized with the store's
loading process and the mask element will be cached for reuse. For all other elements, this mask will replace the
element's UpdateManager load indicator and will be destroyed after the initial load.
|
| Method Summary | |
| native public void | disable()
Disables the mask to prevent it from being displayed. | | native public void | enable()
Enables the mask so that it can be displayed. | | public String | getMessage()
The text to display in a centered loading message box (defaults to 'Loading...'). | | public String | getMessageCls()
The CSS class to apply to the loading message element (defaults to "x-mask-loading"). | | native public boolean | isDisabled()
| | public boolean | isRemoveMask()
True to create a single-use mask that is automatically destroyed after loading (useful for page loads), False to persist the mask element reference for multiple uses (e.g., for paged data widgets). |
| LoadMask | | public LoadMask(Element element, String message)(Code) | | Create a new LoadMask.
Parameters:
element - the element to mask
Parameters:
message - the text to display in a centered loading message box |
| LoadMask | | public LoadMask(Element element, String message, String messageCls, boolean removeMask)(Code) | | Create a new LoadMask.
Parameters:
element - the element to mask
Parameters:
message - the text to display in a centered loading message box
Parameters:
messageCls - the CSS class to apply to the loading message element (defaults to "x-mask-loading").
Parameters:
removeMask - true to create a single-use mask that is automatically destroyed after loading (useful for page loads),false to persist the mask element reference for multiple uses (e.g., for paged data widgets). |
| LoadMask | | public LoadMask(String id, String message)(Code) | | Create a new LoadMask.
Parameters:
id - the element ID to mask
Parameters:
message - the text to display in a centered loading message box |
| LoadMask | | public LoadMask(String id, String message, String messageCls, boolean removeMask)(Code) | | Create a new LoadMask.
Parameters:
id - the element ID to mask
Parameters:
message - the text to display in a centered loading message box
Parameters:
messageCls - the CSS class to apply to the loading message element (defaults to "x-mask-loading").
Parameters:
removeMask - true to create a single-use mask that is automatically destroyed after loading (useful for page loads),false to persist the mask element reference for multiple uses (e.g., for paged data widgets). |
| disable | | native public void disable()(Code) | | Disables the mask to prevent it from being displayed.
|
| enable | | native public void enable()(Code) | | Enables the mask so that it can be displayed.
|
| getMessage | | public String getMessage()(Code) | | The text to display in a centered loading message box (defaults to 'Loading...').
the messsage text |
| getMessageCls | | public String getMessageCls()(Code) | | The CSS class to apply to the loading message element (defaults to "x-mask-loading").
the message CSS class |
| isDisabled | | native public boolean isDisabled()(Code) | | True if the mask is currently disabled so that it will not be displayed (defaults to false)
true if mask disabled |
| isRemoveMask | | public boolean isRemoveMask()(Code) | | True to create a single-use mask that is automatically destroyed after loading (useful for page loads), False to persist the mask element reference for multiple uses (e.g., for paged data widgets).
Defaults to false.
true to create a single-use mask |
| Fields inherited from com.gwtext.client.core.JsObject | protected JavaScriptObject jsObj(Code)(Java Doc)
|
|
|