Clear Up
SharpKit Reference

LoadMask Class

A modal, floating Component which may be shown above a specified Component while loading data. When shown, the configured owning Component will be covered with a modality mask, and the LoadMask's msg will be displayed centered, accompanied by a spinner image.

If the store config option is specified, the masking will be automatically shown and then hidden synchronized with the Store's loading process.

Because this is a floating Component, its z-index will be managed by the global ZIndexManager object, and upon show, it will place itsef at the top of the hierarchy.

Example usage:

  
// Basic mask:
            var myMask = new Ext.LoadMask(myPanel, {msg:"Please wait..."});
            myMask.show();
            

Namespace: Ext

Methods

Name Description
bindStore(Store) Changes the data store bound to this LoadMask.
bindStore(object, object) Binds a store to this instance.
bindStoreListeners(AbstractStore) Binds listeners for this component to the store. By default it will add anything bound by the getStoreListeners method, however it can be overridden in a subclass to provide any more complicated handling.
getStore() Gets the current store instance.
getStoreListeners() Gets the listeners to bind to a new store.
onBindStore(AbstractStore, bool) Template method, it is called when a new store is bound to the current instance.
onUnbindStore(AbstractStore, bool) Template method, it is called when an existing store is unbound from the current instance.
unbindStoreListeners(AbstractStore) Unbinds listeners from this component to the store. By default it will remove anything bound by the bindStoreListeners method, however it can be overridden in a subclass to provide any more complicated handling.

Fields

Name Description
maskCls The CSS class to apply to the mask element Defaults to: "x-mask"
msg The text to display in a centered loading message box. Defaults to: "Loading..."
msgCls The CSS class to apply to the loading message element. Defaults to: "x-mask-loading"
store Optional Store to which the mask is bound. The mask is displayed when a load request is issued, and hidden on either load success, or load fail.
useMsg Whether or not to use a loading message class or simply mask the bound element. Defaults to: true
useTargetEl True to mask the targetEl of the bound Component. By default, the el will be masked. Defaults to: false
© Copyright 2005-2011 SharpKit. All rights reserved.