1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.LoadMask</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.LoadMask-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.LoadMask-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.LoadMask-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.LoadMask-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <!-- ============================== class title / details ============================ -->
48 <h1 class="classTitle">
53 <table cellspacing="0" class="class-summary-table">
55 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
57 <tr><td class="label">Defined In:</td><td class="hd-info">
59 <a href="./src/Roo_LoadMask.js.html">Roo/LoadMask.js</a>.
62 <tr><td class="label">Class:</td><td class="hd-info">LoadMask</td></tr>
70 <!-- ============================== class summary ========================== -->
71 <div class="description">
72 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.
76 <!-- ============================== Class comment block... ========================== -->
78 <div class="comments">
79 <b>Class Comments / Notes</B> =>
80 <u onclick="parent.CommentDialog.showCommentId = 'Roo.LoadMask';">[Add Your comment/notes about this class]</u>
82 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
83 src="/blog.php/GtkDjsComments/Roo.LoadMask.html"></iframe>
88 <!-- ============================== config options ========================== -->
93 <div class="hr"></div>
94 <a id="Roo.LoadMask-configs"></a>
100 <table cellspacing="0" class="member-table">
101 <caption>Config Options (Usually are also Properties)</caption>
105 <th class="sig-header" colspan="2">Options</th>
107 <th class="msource-header">Defined By</th>
114 <tr class="config-row expandable config-row-alt0 notInherited">
115 <td class="micon"><a class="exi" href="#expand"> </a></td>
118 <a id="Roo.LoadMask-cfg-msg" name=".msg"></a>
119 <div class="fixedFont">
120 <b class="itemname">msg</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
126 <div class="short">The text to display in a centered loading message box (defaults to 'Loading.</div>
130 <div class="long">The text to display in a centered loading message box (defaults to 'Loading...')</div>
144 <tr class="config-row expandable config-row-alt1 notInherited">
145 <td class="micon"><a class="exi" href="#expand"> </a></td>
148 <a id="Roo.LoadMask-cfg-msgCls" name=".msgCls"></a>
149 <div class="fixedFont">
150 <b class="itemname">msgCls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
156 <div class="short">The CSS class to apply to the loading message element (defaults to "x-mask-loading")</div>
160 <div class="long">The CSS class to apply to the loading message element (defaults to "x-mask-loading")</div>
174 <tr class="config-row expandable config-row-alt0">
175 <td class="micon"><a class="exi" href="#expand"> </a></td>
178 <a id="Roo-cfg-removeMask" name=".removeMask"></a>
179 <div class="fixedFont">
180 <b class="itemname">removeMask</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
186 <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>
190 <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>
198 <a href="./_global_.html#Roo" roo:cls="_global_.html#Roo">Roo</a>
214 <!-- ============================== public properties ==================== -->
218 <a id="Roo.LoadMask-props"></a>
224 <table cellspacing="0" class="member-table">
225 <caption class="Empty">Public Properties - Has None</caption>
231 <!-- ============================== methods summary / details ======================== -->
234 <a id="Roo.LoadMask-methods"></a>
235 <!-- constructor?? -->
242 <!-- then dynamics first -->
249 <table cellspacing="0" class="member-table">
250 <caption>Public Methods</caption>
252 <th class="sig-header" colspan="2">Method</th>
253 <th class="msource-header">Defined By</th>
263 <tr class="method-row config-row-alt0 expandable notInherited">
264 <td class="micon"><a class="exi" href="#expand"> </a></td>
268 <a id="Roo-method-LoadMask" name=".LoadMask"></a>
269 <div class="fixedFont">
270 <span class="attributes">new <B>Roo.</B></span><b class="itemname">LoadMask</b>
272 (<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>)
280 <div class="short">Create a new Roo.LoadMask</div>
287 Create a new Roo.LoadMask
290 <dl class="detailList">
291 <dt class="heading">Parameters:</dt>
294 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span> <b>el</b>
297 <dd>The element or DOM node, or its id</dd>
300 <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>
303 <dd>The config object</dd>
327 <tr class="method-row config-row-alt1 expandable notInherited">
328 <td class="micon"><a class="exi" href="#expand"> </a></td>
332 <a id="Roo.LoadMask-method-disable" name=".disable"></a>
333 <div class="fixedFont">
334 <span class="attributes"></span><b class="itemname">disable</b>
343 <div class="short">Disables the mask to prevent it from being displayed</div>
349 Disables the mask to prevent it from being displayed
378 <tr class="method-row config-row-alt0 expandable notInherited">
379 <td class="micon"><a class="exi" href="#expand"> </a></td>
383 <a id="Roo.LoadMask-method-enable" name=".enable"></a>
384 <div class="fixedFont">
385 <span class="attributes"></span><b class="itemname">enable</b>
394 <div class="short">Enables the mask so that it can be displayed</div>
400 Enables the mask so that it can be displayed
432 <!-- ============================== events summary / details ======================== -->
435 <a id="Roo.LoadMask-events"></a>
441 <table cellspacing="0" class="member-table">
442 <caption class="Empty">Events - Has None</caption>
453 <!-- ============================== footer ================================= -->
454 <div class="fineprint" style="clear:both">
456 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Tue Dec 06 2011 15:43:32 GMT+0800 (HKT)
458 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>