Ext JS 3.4.0 Sencha Docs

Ext.LoadMask

Files

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();

Available since: 1.1.0

Defined By

Config options

Ext.LoadMask
view source
: String
The text to display in a centered loading message box (defaults to 'Loading...') ...

The text to display in a centered loading message box (defaults to 'Loading...')

Defaults to: 'Loading...'

Available since: 1.1.0

The CSS class to apply to the loading message element (defaults to "x-mask-loading") ...

The CSS class to apply to the loading message element (defaults to "x-mask-loading")

Defaults to: 'x-mask-loading'

Available since: 1.1.0

Ext.LoadMask
view source
: Boolean
True 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.

Available since: 1.1.0

Optional Store to which the mask is bound. ...

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.

Available since: 2.3.0

Defined By

Properties

Ext.LoadMask
view source
: Boolean
Read-only. ...

Read-only. True if the mask is currently disabled so that it will not be displayed (defaults to false)

Defaults to: false

Available since: 1.1.0

Defined By

Methods

Ext.LoadMask
view source
new( el, config ) : Ext.LoadMask
Create a new LoadMask ...

Create a new LoadMask

Available since: 1.1.0

Parameters

  • el : Mixed

    The element or DOM node, or its id

  • config : Object

    The config object

Returns

Ext.LoadMask
view source
( )
Disables the mask to prevent it from being displayed ...

Disables the mask to prevent it from being displayed

Available since: 1.1.0

Ext.LoadMask
view source
( )
Enables the mask so that it can be displayed ...

Enables the mask so that it can be displayed

Available since: 1.1.0

Ext.LoadMask
view source
( )
Hide this LoadMask. ...

Hide this LoadMask.

Available since: 2.3.0

Ext.LoadMask
view source
( )
Show this LoadMask over the configured Element. ...

Show this LoadMask over the configured Element.

Available since: 2.3.0