+++ /dev/null
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-
- <head>
- <meta http-equiv="content-type" content="text/html; charset=undefined" />
- <meta name="generator" content="JsDoc Toolkit" />
-
-
- <title>JsDoc Reference - Roo.LoadMask</title>
-
-
- <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
- <link rel="stylesheet" type="text/css" href="../default.css" />
-
-
- <script type="text/javascript" src="../page.js">
-
- </script>
-
-
- </head>
-
- <body onload="RooDocsPage.onload();">
-
-
-<div class="body-wrap">
-
- <!-- ============================== links to methods. ================================= -->
-
- <div class="top-tools">
- <!--
- <a class="inner-link" href="#Roo.LoadMask-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
- <a class="inner-link" href="#Roo.LoadMask-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
- <a class="inner-link" href="#Roo.LoadMask-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
- <a class="inner-link" href="#Roo.LoadMask-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
- <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
- -->
- </div>
-
-
-<!-- ============================== inheritance Block. ================================= -->
-
-<!-- ============================== class title / details ============================ -->
-
-
- <h1 class="classTitle">
-
- Class Roo.LoadMask
- </h1>
-
- <table cellspacing="0" class="class-summary-table">
-
- <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
-
- <tr><td class="label">Defined In:</td><td class="hd-info">
-
- <a href="./src/Roo_LoadMask.js.html">Roo/LoadMask.js</a>.
-
- </td></tr>
- <tr><td class="label">Class:</td><td class="hd-info">LoadMask</td></tr>
-
-
-
-
- </table>
-
-
-<!-- ============================== class summary ========================== -->
- <div class="description">
- A simple utility class for generically masking elements while loading data. If the element being masked has<br/>an underlying {<b>link</b> Roo.data.Store}, the masking will be automatically synchronized with the store's loading<br/>process and the mask element will be cached for reuse. For all other elements, this mask will replace the<br/>element's UpdateManager load indicator and will be destroyed after the initial load.
- </div>
-
-
-<!-- ============================== Class comment block... ========================== -->
-
-<div class="comments">
- <b>Class Comments / Notes</B> =>
- <u onclick="parent.CommentDialog.showCommentId = 'Roo.LoadMask';">[Add Your comment/notes about this class]</u>
- <br/>
- <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
- src="/blog.php/GtkDjsComments/Roo.LoadMask.html"></iframe>
-</div>
-
-
-
-<!-- ============================== config options ========================== -->
-
-
-
-
- <div class="hr"></div>
- <a id="Roo.LoadMask-configs"></a>
-
-
-
-
-
- <table cellspacing="0" class="member-table">
- <caption>Config Options (Usually are also Properties)</caption>
-
-
- <tr>
- <th class="sig-header" colspan="2">Options</th>
-
- <th class="msource-header">Defined By</th>
- </tr>
-
-
-
-
-
- <tr class="config-row expandable config-row-alt0 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.LoadMask-cfg-msg" name=".msg"></a>
- <div class="fixedFont">
- <b class="itemname">msg</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
-
-
- </div>
-
- <div class="mdesc">
- <div class="short">The text to display in a centered loading message box (defaults to 'Loading.</div>
- </div>
-
- <div class="mdesc">
- <div class="long">
- The text to display in a centered loading message box (defaults to 'Loading...')
-
- </div>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- Roo.LoadMask
-
- </td>
- </tr>
-
-
- <tr class="config-row expandable config-row-alt1 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.LoadMask-cfg-msgCls" name=".msgCls"></a>
- <div class="fixedFont">
- <b class="itemname">msgCls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
-
-
- </div>
-
- <div class="mdesc">
- <div class="short">The CSS class to apply to the loading message element (defaults to "x-mask-loading")</div>
- </div>
-
- <div class="mdesc">
- <div class="long">
- The CSS class to apply to the loading message element (defaults to "x-mask-loading")
-
- </div>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- Roo.LoadMask
-
- </td>
- </tr>
-
-
- <tr class="config-row expandable config-row-alt0">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo-cfg-removeMask" name=".removeMask"></a>
- <div class="fixedFont">
- <b class="itemname">removeMask</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
-
-
- </div>
-
- <div class="mdesc">
- <div class="short">True to create a single-use mask that is automatically destroyed after loading (useful for page loads),<br/>False to persist the mask element reference for multiple uses (e.g.</div>
- </div>
-
- <div class="mdesc">
- <div class="long">
- True to create a single-use mask that is automatically destroyed after loading (useful for page loads),<br/>False to persist the mask element reference for multiple uses (e.g., for paged data widgets). Defaults to false.
-
- </div>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- <a href="./Roo.html#constructor" roo:cls="Roo.html#constructor">Roo</a>
-
- </td>
- </tr>
-
-
- </table>
-
-
-
-
-
-
-
-
-
- <!-- ============================== public properties ==================== -->
-
-
-
- <a id="Roo.LoadMask-props"></a>
-
-
-
-
-
- <table cellspacing="0" class="member-table">
- <caption class="Empty">Public Properties - Has None</caption>
- </table>
-
-
-
-
- <!-- ============================== methods summary / details ======================== -->
-
-
- <a id="Roo.LoadMask-methods"></a>
- <!-- constructor?? -->
-
- <!-- static's first
-
-
- -->
-
- <!-- then dynamics first -->
-
-
-
-
-
-
- <table cellspacing="0" class="member-table">
- <caption>Public Methods</caption>
- <tr>
- <th class="sig-header" colspan="2">Method</th>
- <th class="msource-header">Defined By</th>
-
- </tr>
-
-
-
-
-
-
-
- <tr class="method-row config-row-alt0 expandable notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo-method-LoadMask" name=".LoadMask"></a>
- <div class="fixedFont">
- <span class="attributes">new <B>Roo.</B></span><b class="itemname">LoadMask</b>
-
- (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>el</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
-
-
-
- </div>
- <div class="mdesc">
-
-
- <div class="short">Create a new Roo.LoadMask</div>
-
-
- <div class="long">
-
-
-
- Create a new Roo.LoadMask
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span> <b>el</b>
-
- </dt>
- <dd>The element or DOM node, or its id</dd>
-
- <dt>
- <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>config</b>
-
- </dt>
- <dd>The config object</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.LoadMask-method-disable" name=".disable"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">disable</b>
-
- ()
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Disables the mask to prevent it from being displayed</div>
-
-
-
- <div class="long">
-
- Disables the mask to prevent it from being displayed
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- Roo.LoadMask
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.LoadMask-method-enable" name=".enable"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">enable</b>
-
- ()
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Enables the mask so that it can be displayed</div>
-
-
-
- <div class="long">
-
- Enables the mask so that it can be displayed
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- Roo.LoadMask
-
- </td>
- </tr>
-
-
- </table>
-
-
- <!-- ============================== events summary / details ======================== -->
-
-
- <a id="Roo.LoadMask-events"></a>
-
-
-
-
-
- <table cellspacing="0" class="member-table">
- <caption class="Empty">Events - Has None</caption>
- </table>
-
-
-
-
-
-
-
-
-
-<!-- ============================== footer ================================= -->
- <div class="fineprint" style="clear:both">
-
- Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 13 2018 14:10:53 GMT+0800 (HKT)
- Based on
- <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
- </div>
- </body>
-</html>
projects / roojs1 / blobdiff