1 | <div class="body-wrap"> |
---|
2 | <div class="top-tools"> |
---|
3 | <a class="inner-link" href="#Ext.LoadMask-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> |
---|
4 | <a class="inner-link" href="#Ext.LoadMask-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a> |
---|
5 | <a class="inner-link" href="#Ext.LoadMask-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a> |
---|
6 | <a class="inner-link" href="#Ext.LoadMask-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a> |
---|
7 | <a class="bookmark" href="../docs/?class=Ext.LoadMask"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> |
---|
8 | </div> |
---|
9 | <h1>Class Ext.LoadMask</h1> |
---|
10 | <table cellspacing="0"> |
---|
11 | <tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr> |
---|
12 | <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/LoadMask.js" target="_blank">LoadMask.js</a></td></tr> |
---|
13 | <tr><td class="label">Class:</td><td class="hd-info">LoadMask</td></tr> |
---|
14 | <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr> |
---|
15 | </table> |
---|
16 | <div class="description"> |
---|
17 | * |
---|
18 | 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> |
---|
19 | config option is specified, the masking will be automatically synchronized with the store's loading |
---|
20 | process and the mask element will be cached for reuse. For all other elements, this mask will replace the |
---|
21 | element's Updater load indicator and will be destroyed after the initial load. |
---|
22 | <p>Example usage:</p> |
---|
23 | <pre><code><i>// Basic mask:</i> |
---|
24 | <b>var</b> myMask = <b>new</b> Ext.LoadMask(Ext.getBody(), {msg:<em>"Please wait..."</em>}); |
---|
25 | myMask.show();</code></pre> </div> |
---|
26 | |
---|
27 | <div class="hr"></div> |
---|
28 | <a id="Ext.LoadMask-configs"></a> |
---|
29 | <h2>Config Options</h2> |
---|
30 | <table cellspacing="0" class="member-table"> |
---|
31 | <tr> |
---|
32 | <th class="sig-header" colspan="2">Config Options</th> |
---|
33 | <th class="msource-header">Defined By</th> |
---|
34 | </tr> |
---|
35 | <tr class="config-row"> |
---|
36 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
37 | <td class="sig"> |
---|
38 | <a id="Ext.LoadMask-msg"></a> |
---|
39 | <b>msg</b> : String <div class="mdesc"> |
---|
40 | The text to display in a centered loading message box (defaults to 'Loading...') </div> |
---|
41 | </td> |
---|
42 | <td class="msource">LoadMask</td> |
---|
43 | </tr> |
---|
44 | <tr class="config-row alt"> |
---|
45 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
46 | <td class="sig"> |
---|
47 | <a id="Ext.LoadMask-msgCls"></a> |
---|
48 | <b>msgCls</b> : String <div class="mdesc"> |
---|
49 | The CSS class to apply to the loading message element (defaults to "x-mask-loading") </div> |
---|
50 | </td> |
---|
51 | <td class="msource">LoadMask</td> |
---|
52 | </tr> |
---|
53 | <tr class="config-row expandable"> |
---|
54 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
55 | <td class="sig"> |
---|
56 | <a id="Ext.LoadMask-removeMask"></a> |
---|
57 | <b>removeMask</b> : Boolean <div class="mdesc"> |
---|
58 | <div class="short">True to create a single-use mask that is automatically destroyed after loading (useful for page loads), False to pers...</div> |
---|
59 | <div class="long"> |
---|
60 | 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> |
---|
61 | </div> |
---|
62 | </td> |
---|
63 | <td class="msource">LoadMask</td> |
---|
64 | </tr> |
---|
65 | <tr class="config-row alt expandable"> |
---|
66 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
67 | <td class="sig"> |
---|
68 | <a id="Ext.LoadMask-store"></a> |
---|
69 | <b>store</b> : Ext.data.Store <div class="mdesc"> |
---|
70 | <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> |
---|
71 | <div class="long"> |
---|
72 | 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> |
---|
73 | </div> |
---|
74 | </td> |
---|
75 | <td class="msource">LoadMask</td> |
---|
76 | </tr> |
---|
77 | </table> |
---|
78 | <a id="Ext.LoadMask-props"></a> |
---|
79 | <h2>Public Properties</h2> |
---|
80 | <table cellspacing="0" class="member-table"> |
---|
81 | <tr> |
---|
82 | <th class="sig-header" colspan="2">Property</th> |
---|
83 | <th class="msource-header">Defined By</th> |
---|
84 | </tr> |
---|
85 | <tr class="property-row"> |
---|
86 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
87 | <td class="sig"> |
---|
88 | <a id="Ext.LoadMask-disabled"></a> |
---|
89 | <b>disabled</b> : Boolean <div class="mdesc"> |
---|
90 | Read-only. True if the mask is currently disabled so that it will not be displayed (defaults to false) </div> |
---|
91 | </td> |
---|
92 | <td class="msource">LoadMask</td> |
---|
93 | </tr> |
---|
94 | </table> |
---|
95 | <a id="Ext.LoadMask-methods"></a> |
---|
96 | <h2>Public Methods</h2> |
---|
97 | <table cellspacing="0" class="member-table"> |
---|
98 | <tr> |
---|
99 | <th class="sig-header" colspan="2">Method</th> |
---|
100 | <th class="msource-header">Defined By</th> |
---|
101 | </tr> |
---|
102 | <tr class="method-row expandable"> |
---|
103 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
104 | <td class="sig"> |
---|
105 | <a id="Ext.LoadMask-LoadMask"></a> |
---|
106 | <b>LoadMask</b>( <code>Mixed el</code>, <code>Object config</code> ) <div class="mdesc"> |
---|
107 | <div class="short">Create a new LoadMask</div> |
---|
108 | <div class="long"> |
---|
109 | Create a new LoadMask <div class="mdetail-params"> |
---|
110 | <strong>Parameters:</strong> |
---|
111 | <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> |
---|
112 | <strong>Returns:</strong> |
---|
113 | <ul> |
---|
114 | <li><code></code></li> |
---|
115 | </ul> |
---|
116 | </div> |
---|
117 | </div> |
---|
118 | </div> |
---|
119 | </td> |
---|
120 | <td class="msource">LoadMask</td> |
---|
121 | </tr> |
---|
122 | <tr class="method-row alt expandable"> |
---|
123 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
124 | <td class="sig"> |
---|
125 | <a id="Ext.LoadMask-disable"></a> |
---|
126 | <b>disable</b>() : void <div class="mdesc"> |
---|
127 | <div class="short">Disables the mask to prevent it from being displayed</div> |
---|
128 | <div class="long"> |
---|
129 | Disables the mask to prevent it from being displayed <div class="mdetail-params"> |
---|
130 | <strong>Parameters:</strong> |
---|
131 | <ul><li>None.</li> </ul> |
---|
132 | <strong>Returns:</strong> |
---|
133 | <ul> |
---|
134 | <li><code>void</code></li> |
---|
135 | </ul> |
---|
136 | </div> |
---|
137 | </div> |
---|
138 | </div> |
---|
139 | </td> |
---|
140 | <td class="msource">LoadMask</td> |
---|
141 | </tr> |
---|
142 | <tr class="method-row expandable"> |
---|
143 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
144 | <td class="sig"> |
---|
145 | <a id="Ext.LoadMask-enable"></a> |
---|
146 | <b>enable</b>() : void <div class="mdesc"> |
---|
147 | <div class="short">Enables the mask so that it can be displayed</div> |
---|
148 | <div class="long"> |
---|
149 | Enables the mask so that it can be displayed <div class="mdetail-params"> |
---|
150 | <strong>Parameters:</strong> |
---|
151 | <ul><li>None.</li> </ul> |
---|
152 | <strong>Returns:</strong> |
---|
153 | <ul> |
---|
154 | <li><code>void</code></li> |
---|
155 | </ul> |
---|
156 | </div> |
---|
157 | </div> |
---|
158 | </div> |
---|
159 | </td> |
---|
160 | <td class="msource">LoadMask</td> |
---|
161 | </tr> |
---|
162 | <tr class="method-row alt expandable"> |
---|
163 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
164 | <td class="sig"> |
---|
165 | <a id="Ext.LoadMask-hide"></a> |
---|
166 | <b>hide</b>() : void <div class="mdesc"> |
---|
167 | <div class="short">Hide this LoadMask.</div> |
---|
168 | <div class="long"> |
---|
169 | Hide this LoadMask. <div class="mdetail-params"> |
---|
170 | <strong>Parameters:</strong> |
---|
171 | <ul><li>None.</li> </ul> |
---|
172 | <strong>Returns:</strong> |
---|
173 | <ul> |
---|
174 | <li><code>void</code></li> |
---|
175 | </ul> |
---|
176 | </div> |
---|
177 | </div> |
---|
178 | </div> |
---|
179 | </td> |
---|
180 | <td class="msource">LoadMask</td> |
---|
181 | </tr> |
---|
182 | <tr class="method-row expandable"> |
---|
183 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
184 | <td class="sig"> |
---|
185 | <a id="Ext.LoadMask-show"></a> |
---|
186 | <b>show</b>() : void <div class="mdesc"> |
---|
187 | <div class="short">Show this LoadMask over the configured Element.</div> |
---|
188 | <div class="long"> |
---|
189 | Show this LoadMask over the configured Element. <div class="mdetail-params"> |
---|
190 | <strong>Parameters:</strong> |
---|
191 | <ul><li>None.</li> </ul> |
---|
192 | <strong>Returns:</strong> |
---|
193 | <ul> |
---|
194 | <li><code>void</code></li> |
---|
195 | </ul> |
---|
196 | </div> |
---|
197 | </div> |
---|
198 | </div> |
---|
199 | </td> |
---|
200 | <td class="msource">LoadMask</td> |
---|
201 | </tr> |
---|
202 | </table> |
---|
203 | <a id="Ext.LoadMask-events"></a> |
---|
204 | <h2>Public Events</h2> |
---|
205 | <div class="no-members">This class has no public events.</div> |
---|
206 | </div> |
---|