A simple utility class for generically masking elements while loading data. If the
Package: | Ext |
Defined In: | LoadMask.js |
Class: | LoadMask |
Extends: | Object |
A simple utility class for generically masking elements while loading data. If the
store
config option is specified, 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 Updater load indicator and will be destroyed after the initial load.
Example usage:
// Basic mask:
var myMask = new Ext.LoadMask(Ext.getBody(), {msg:"Please wait..."});
-myMask.show();
Config Options
|
| msg : String The text to display in a centered loading message box (defaults to 'Loading...') | LoadMask |
| msgCls : String The CSS class to apply to the loading message element (defaults to "x-mask-loading") | LoadMask |
| removeMask : BooleanTrue to create a single-use mask that is automatically destroyed after loading (useful for page loads),
+myMask.show(); Config Options|
| msg : String The text to display in a centered loading message box (defaults to 'Loading...') | LoadMask | | msgCls : String The CSS class to apply to the loading message element (defaults to "x-mask-loading") | LoadMask | | removeMask : BooleanTrue to create a single-use mask that is automatically destroyed after loading (useful for page loads),
False to pers... 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. | LoadMask | | store : Ext.data.StoreOptional Store to which the mask is bound. The mask is displayed when a load request is issued, and
+False to persist the mask element reference for multiple uses (e.g., for paged data widgets). Defaults to false. | LoadMask | | store : Ext.data.StoreOptional Store to which the mask is bound. The mask is displayed when a load request is issued, and
hidden on either ... Optional Store to which the mask is bound. The mask is displayed when a load request is issued, and
-hidden on either load sucess, or load fail. | LoadMask |
Public Properties|
| disabled : Boolean Read-only. True if the mask is currently disabled so that it will not be displayed (defaults to false) | LoadMask |
Public Methods|
| LoadMask( Mixed el , Object config )
- | LoadMask | | disable()
- :
- voidDisables the mask to prevent it from being displayed Disables the mask to prevent it from being displayed | LoadMask | | enable()
- :
- voidEnables the mask so that it can be displayed Enables the mask so that it can be displayed | LoadMask | | hide()
- :
- void | LoadMask | | show()
- :
+hidden on either load sucess, or load fail. | LoadMask |
Public Properties|
| disabled : Boolean Read-only. True if the mask is currently disabled so that it will not be displayed (defaults to false) | LoadMask |
Public Methods|
| LoadMask( Mixed el , Object config )
+ | LoadMask | | disable()
+ :
+ voidDisables the mask to prevent it from being displayed Disables the mask to prevent it from being displayed | LoadMask | | enable()
+ :
+ voidEnables the mask so that it can be displayed Enables the mask so that it can be displayed | LoadMask | | hide()
+ :
+ void | LoadMask | | show()
+ :
voidShow this LoadMask over the configured Element. Show this LoadMask over the configured Element. | LoadMask |
Public EventsThis class has no public events.
\ No newline at end of file
|