+++ /dev/null
- <div class="body-wrap">
- <div class="top-tools">
- <a class="inner-link" href="#Ext.LoadMask-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
- <a class="inner-link" href="#Ext.LoadMask-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
- <a class="inner-link" href="#Ext.LoadMask-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
- <a class="inner-link" href="#Ext.LoadMask-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
- <a class="bookmark" href="../docs/?class=Ext.LoadMask"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
- </div>
- <h1>Class Ext.LoadMask</h1>
- <table cellspacing="0">
- <tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr>
- <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/LoadMask.js" target="_blank">LoadMask.js</a></td></tr>
- <tr><td class="label">Class:</td><td class="hd-info">LoadMask</td></tr>
- <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
- </table>
- <div class="description">
- *
-A simple utility class for generically masking elements while loading data. If the <a ext:cls="Ext.LoadMask" ext:member="store" href="output/Ext.LoadMask.html#store">store</a>
-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.
-<p>Example usage:</p>
-<pre><code><i>// Basic mask:</i>
-<b>var</b> myMask = <b>new</b> Ext.LoadMask(Ext.getBody(), {msg:<em>"Please wait..."</em>});
-myMask.show();</code></pre> </div>
-
- <div class="hr"></div>
- <a id="Ext.LoadMask-configs"></a>
- <h2>Config Options</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Config Options</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="config-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.LoadMask-msg"></a>\r
- <b>msg</b> : String <div class="mdesc">\r
- The text to display in a centered loading message box (defaults to 'Loading...') </div>\r
- </td>\r
- <td class="msource">LoadMask</td>\r
- </tr>\r
- <tr class="config-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.LoadMask-msgCls"></a>\r
- <b>msgCls</b> : String <div class="mdesc">\r
- The CSS class to apply to the loading message element (defaults to "x-mask-loading") </div>\r
- </td>\r
- <td class="msource">LoadMask</td>\r
- </tr>\r
- <tr class="config-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.LoadMask-removeMask"></a>\r
- <b>removeMask</b> : Boolean <div class="mdesc">\r
- <div class="short">True to create a single-use mask that is automatically destroyed after loading (useful for page loads), False to pers...</div>\r
- <div class="long">\r
- 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. </div>\r
- </div>\r
- </td>\r
- <td class="msource">LoadMask</td>\r
- </tr>\r
- <tr class="config-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.LoadMask-store"></a>\r
- <b>store</b> : Ext.data.Store <div class="mdesc">\r
- <div class="short">Optional Store to which the mask is bound. The mask is displayed when a load request is issued, and hidden on either ...</div>\r
- <div class="long">\r
- 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. </div>\r
- </div>\r
- </td>\r
- <td class="msource">LoadMask</td>\r
- </tr>\r
- </table>
- <a id="Ext.LoadMask-props"></a>
- <h2>Public Properties</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Property</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.LoadMask-disabled"></a>\r
- <b>disabled</b> : Boolean <div class="mdesc">\r
- Read-only. True if the mask is currently disabled so that it will not be displayed (defaults to false) </div>\r
- </td>\r
- <td class="msource">LoadMask</td>\r
- </tr>\r
- </table>
- <a id="Ext.LoadMask-methods"></a>
- <h2>Public Methods</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Method</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.LoadMask-LoadMask"></a>\r
- <b>LoadMask</b>( <code>Mixed el</code>, <code>Object config</code> ) <div class="mdesc">\r
- <div class="short">Create a new LoadMask</div>\r
- <div class="long">\r
- Create a new LoadMask <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>el</code> : Mixed<div class="sub-desc">The element or DOM node, or its id</div></li><li><code>config</code> : Object<div class="sub-desc">The config object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code></code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">LoadMask</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.LoadMask-disable"></a>\r
- <b>disable</b>() : void <div class="mdesc">\r
- <div class="short">Disables the mask to prevent it from being displayed</div>\r
- <div class="long">\r
- Disables the mask to prevent it from being displayed <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">LoadMask</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.LoadMask-enable"></a>\r
- <b>enable</b>() : void <div class="mdesc">\r
- <div class="short">Enables the mask so that it can be displayed</div>\r
- <div class="long">\r
- Enables the mask so that it can be displayed <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">LoadMask</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.LoadMask-hide"></a>\r
- <b>hide</b>() : void <div class="mdesc">\r
- <div class="short">Hide this LoadMask.</div>\r
- <div class="long">\r
- Hide this LoadMask. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">LoadMask</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.LoadMask-show"></a>\r
- <b>show</b>() : void <div class="mdesc">\r
- <div class="short">Show this LoadMask over the configured Element.</div>\r
- <div class="long">\r
- Show this LoadMask over the configured Element. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">LoadMask</td>\r
- </tr>\r
- </table>
- <a id="Ext.LoadMask-events"></a>
- <h2>Public Events</h2>
- <div class="no-members">This class has no public events.</div>
- </div>
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff