1 | <div class="body-wrap"> |
---|
2 | <div class="top-tools"> |
---|
3 | <a class="inner-link" href="#Ext.dd.StatusProxy-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> |
---|
4 | <a class="inner-link" href="#Ext.dd.StatusProxy-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a> |
---|
5 | <a class="inner-link" href="#Ext.dd.StatusProxy-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a> |
---|
6 | <a class="inner-link" href="#Ext.dd.StatusProxy-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a> |
---|
7 | <a class="bookmark" href="../docs/?class=Ext.dd.StatusProxy"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> |
---|
8 | </div> |
---|
9 | <h1>Class Ext.dd.StatusProxy</h1> |
---|
10 | <table cellspacing="0"> |
---|
11 | <tr><td class="label">Package:</td><td class="hd-info">Ext.dd</td></tr> |
---|
12 | <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/StatusProxy.js" target="_blank">StatusProxy.js</a></td></tr> |
---|
13 | <tr><td class="label">Class:</td><td class="hd-info">StatusProxy</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 specialized drag proxy that supports a drop status icon, <a ext:cls="Ext.Layer" href="output/Ext.Layer.html">Ext.Layer</a> styles and auto-repair. This is the |
---|
19 | default drag proxy used by all Ext.dd components. </div> |
---|
20 | |
---|
21 | <div class="hr"></div> |
---|
22 | <a id="Ext.dd.StatusProxy-configs"></a> |
---|
23 | <h2>Config Options</h2> |
---|
24 | <table cellspacing="0" class="member-table"> |
---|
25 | <tr> |
---|
26 | <th class="sig-header" colspan="2">Config Options</th> |
---|
27 | <th class="msource-header">Defined By</th> |
---|
28 | </tr> |
---|
29 | <tr class="config-row"> |
---|
30 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
31 | <td class="sig"> |
---|
32 | <a id="Ext.dd.StatusProxy-dropAllowed"></a> |
---|
33 | <b>dropAllowed</b> : String <div class="mdesc"> |
---|
34 | The CSS class to apply to the status element when drop is allowed (defaults to "x-dd-drop-ok"). </div> |
---|
35 | </td> |
---|
36 | <td class="msource">StatusProxy</td> |
---|
37 | </tr> |
---|
38 | <tr class="config-row alt"> |
---|
39 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
40 | <td class="sig"> |
---|
41 | <a id="Ext.dd.StatusProxy-dropNotAllowed"></a> |
---|
42 | <b>dropNotAllowed</b> : String <div class="mdesc"> |
---|
43 | The CSS class to apply to the status element when drop is not allowed (defaults to "x-dd-drop-nodrop"). </div> |
---|
44 | </td> |
---|
45 | <td class="msource">StatusProxy</td> |
---|
46 | </tr> |
---|
47 | </table> |
---|
48 | <a id="Ext.dd.StatusProxy-props"></a> |
---|
49 | <h2>Public Properties</h2> |
---|
50 | <div class="no-members">This class has no public properties.</div> <a id="Ext.dd.StatusProxy-methods"></a> |
---|
51 | <h2>Public Methods</h2> |
---|
52 | <table cellspacing="0" class="member-table"> |
---|
53 | <tr> |
---|
54 | <th class="sig-header" colspan="2">Method</th> |
---|
55 | <th class="msource-header">Defined By</th> |
---|
56 | </tr> |
---|
57 | <tr class="method-row expandable"> |
---|
58 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
59 | <td class="sig"> |
---|
60 | <a id="Ext.dd.StatusProxy-StatusProxy"></a> |
---|
61 | <b>StatusProxy</b>( <code>Object config</code> ) <div class="mdesc"> |
---|
62 | <div class="short"></div> |
---|
63 | <div class="long"> |
---|
64 | <div class="mdetail-params"> |
---|
65 | <strong>Parameters:</strong> |
---|
66 | <ul><li><code>config</code> : Object<div class="sub-desc"></div></li> </ul> |
---|
67 | <strong>Returns:</strong> |
---|
68 | <ul> |
---|
69 | <li><code></code></li> |
---|
70 | </ul> |
---|
71 | </div> |
---|
72 | </div> |
---|
73 | </div> |
---|
74 | </td> |
---|
75 | <td class="msource">StatusProxy</td> |
---|
76 | </tr> |
---|
77 | <tr class="method-row alt expandable"> |
---|
78 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
79 | <td class="sig"> |
---|
80 | <a id="Ext.dd.StatusProxy-getEl"></a> |
---|
81 | <b>getEl</b>() : Ext.Layer <div class="mdesc"> |
---|
82 | <div class="short">Returns the underlying proxy <a ext:cls="Ext.Layer" href="output/Ext.Layer.html">Ext.Layer</a></div> |
---|
83 | <div class="long"> |
---|
84 | Returns the underlying proxy <a ext:cls="Ext.Layer" href="output/Ext.Layer.html">Ext.Layer</a> <div class="mdetail-params"> |
---|
85 | <strong>Parameters:</strong> |
---|
86 | <ul><li>None.</li> </ul> |
---|
87 | <strong>Returns:</strong> |
---|
88 | <ul> |
---|
89 | <li><code>Ext.Layer</code><div class="sub-desc">el</div></li> |
---|
90 | </ul> |
---|
91 | </div> |
---|
92 | </div> |
---|
93 | </div> |
---|
94 | </td> |
---|
95 | <td class="msource">StatusProxy</td> |
---|
96 | </tr> |
---|
97 | <tr class="method-row expandable"> |
---|
98 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
99 | <td class="sig"> |
---|
100 | <a id="Ext.dd.StatusProxy-getGhost"></a> |
---|
101 | <b>getGhost</b>() : Ext.Element <div class="mdesc"> |
---|
102 | <div class="short">Returns the ghost element</div> |
---|
103 | <div class="long"> |
---|
104 | Returns the ghost element <div class="mdetail-params"> |
---|
105 | <strong>Parameters:</strong> |
---|
106 | <ul><li>None.</li> </ul> |
---|
107 | <strong>Returns:</strong> |
---|
108 | <ul> |
---|
109 | <li><code>Ext.Element</code><div class="sub-desc">el</div></li> |
---|
110 | </ul> |
---|
111 | </div> |
---|
112 | </div> |
---|
113 | </div> |
---|
114 | </td> |
---|
115 | <td class="msource">StatusProxy</td> |
---|
116 | </tr> |
---|
117 | <tr class="method-row alt expandable"> |
---|
118 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
119 | <td class="sig"> |
---|
120 | <a id="Ext.dd.StatusProxy-hide"></a> |
---|
121 | <b>hide</b>( <code>Boolean clear</code> ) : void <div class="mdesc"> |
---|
122 | <div class="short">Hides the proxy</div> |
---|
123 | <div class="long"> |
---|
124 | Hides the proxy <div class="mdetail-params"> |
---|
125 | <strong>Parameters:</strong> |
---|
126 | <ul><li><code>clear</code> : Boolean<div class="sub-desc">True to reset the status and clear the ghost contents, false to preserve them</div></li> </ul> |
---|
127 | <strong>Returns:</strong> |
---|
128 | <ul> |
---|
129 | <li><code>void</code></li> |
---|
130 | </ul> |
---|
131 | </div> |
---|
132 | </div> |
---|
133 | </div> |
---|
134 | </td> |
---|
135 | <td class="msource">StatusProxy</td> |
---|
136 | </tr> |
---|
137 | <tr class="method-row expandable"> |
---|
138 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
139 | <td class="sig"> |
---|
140 | <a id="Ext.dd.StatusProxy-repair"></a> |
---|
141 | <b>repair</b>( <code>Array xy</code>, <code>Function callback</code>, <code>Object scope</code> ) : void <div class="mdesc"> |
---|
142 | <div class="short">Causes the proxy to return to its position of origin via an animation. Should be called after an |
---|
143 | invalid drop operat...</div> |
---|
144 | <div class="long"> |
---|
145 | Causes the proxy to return to its position of origin via an animation. Should be called after an |
---|
146 | invalid drop operation by the item being dragged. <div class="mdetail-params"> |
---|
147 | <strong>Parameters:</strong> |
---|
148 | <ul><li><code>xy</code> : Array<div class="sub-desc">The XY position of the element ([x, y])</div></li><li><code>callback</code> : Function<div class="sub-desc">The function to call after the repair is complete</div></li><li><code>scope</code> : Object<div class="sub-desc">The scope in which to execute the callback</div></li> </ul> |
---|
149 | <strong>Returns:</strong> |
---|
150 | <ul> |
---|
151 | <li><code>void</code></li> |
---|
152 | </ul> |
---|
153 | </div> |
---|
154 | </div> |
---|
155 | </div> |
---|
156 | </td> |
---|
157 | <td class="msource">StatusProxy</td> |
---|
158 | </tr> |
---|
159 | <tr class="method-row alt expandable"> |
---|
160 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
161 | <td class="sig"> |
---|
162 | <a id="Ext.dd.StatusProxy-reset"></a> |
---|
163 | <b>reset</b>( <code>Boolean clearGhost</code> ) : void <div class="mdesc"> |
---|
164 | <div class="short">Resets the status indicator to the default dropNotAllowed value</div> |
---|
165 | <div class="long"> |
---|
166 | Resets the status indicator to the default dropNotAllowed value <div class="mdetail-params"> |
---|
167 | <strong>Parameters:</strong> |
---|
168 | <ul><li><code>clearGhost</code> : Boolean<div class="sub-desc">True to also remove all content from the ghost, false to preserve it</div></li> </ul> |
---|
169 | <strong>Returns:</strong> |
---|
170 | <ul> |
---|
171 | <li><code>void</code></li> |
---|
172 | </ul> |
---|
173 | </div> |
---|
174 | </div> |
---|
175 | </div> |
---|
176 | </td> |
---|
177 | <td class="msource">StatusProxy</td> |
---|
178 | </tr> |
---|
179 | <tr class="method-row expandable"> |
---|
180 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
181 | <td class="sig"> |
---|
182 | <a id="Ext.dd.StatusProxy-setStatus"></a> |
---|
183 | <b>setStatus</b>( <code>String cssClass</code> ) : void <div class="mdesc"> |
---|
184 | <div class="short">Updates the proxy's visual element to indicate the status of whether or not drop is allowed |
---|
185 | over the current target e...</div> |
---|
186 | <div class="long"> |
---|
187 | Updates the proxy's visual element to indicate the status of whether or not drop is allowed |
---|
188 | over the current target element. <div class="mdetail-params"> |
---|
189 | <strong>Parameters:</strong> |
---|
190 | <ul><li><code>cssClass</code> : String<div class="sub-desc">The css class for the new drop status indicator image</div></li> </ul> |
---|
191 | <strong>Returns:</strong> |
---|
192 | <ul> |
---|
193 | <li><code>void</code></li> |
---|
194 | </ul> |
---|
195 | </div> |
---|
196 | </div> |
---|
197 | </div> |
---|
198 | </td> |
---|
199 | <td class="msource">StatusProxy</td> |
---|
200 | </tr> |
---|
201 | <tr class="method-row alt expandable"> |
---|
202 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
203 | <td class="sig"> |
---|
204 | <a id="Ext.dd.StatusProxy-show"></a> |
---|
205 | <b>show</b>() : void <div class="mdesc"> |
---|
206 | <div class="short">Displays this proxy</div> |
---|
207 | <div class="long"> |
---|
208 | Displays this proxy <div class="mdetail-params"> |
---|
209 | <strong>Parameters:</strong> |
---|
210 | <ul><li>None.</li> </ul> |
---|
211 | <strong>Returns:</strong> |
---|
212 | <ul> |
---|
213 | <li><code>void</code></li> |
---|
214 | </ul> |
---|
215 | </div> |
---|
216 | </div> |
---|
217 | </div> |
---|
218 | </td> |
---|
219 | <td class="msource">StatusProxy</td> |
---|
220 | </tr> |
---|
221 | <tr class="method-row expandable"> |
---|
222 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
223 | <td class="sig"> |
---|
224 | <a id="Ext.dd.StatusProxy-stop"></a> |
---|
225 | <b>stop</b>() : void <div class="mdesc"> |
---|
226 | <div class="short">Stops the repair animation if it's currently running</div> |
---|
227 | <div class="long"> |
---|
228 | Stops the repair animation if it's currently running <div class="mdetail-params"> |
---|
229 | <strong>Parameters:</strong> |
---|
230 | <ul><li>None.</li> </ul> |
---|
231 | <strong>Returns:</strong> |
---|
232 | <ul> |
---|
233 | <li><code>void</code></li> |
---|
234 | </ul> |
---|
235 | </div> |
---|
236 | </div> |
---|
237 | </div> |
---|
238 | </td> |
---|
239 | <td class="msource">StatusProxy</td> |
---|
240 | </tr> |
---|
241 | <tr class="method-row alt expandable"> |
---|
242 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
243 | <td class="sig"> |
---|
244 | <a id="Ext.dd.StatusProxy-sync"></a> |
---|
245 | <b>sync</b>() : void <div class="mdesc"> |
---|
246 | <div class="short">Force the Layer to sync its shadow and shim positions to the element</div> |
---|
247 | <div class="long"> |
---|
248 | Force the Layer to sync its shadow and shim positions to the element <div class="mdetail-params"> |
---|
249 | <strong>Parameters:</strong> |
---|
250 | <ul><li>None.</li> </ul> |
---|
251 | <strong>Returns:</strong> |
---|
252 | <ul> |
---|
253 | <li><code>void</code></li> |
---|
254 | </ul> |
---|
255 | </div> |
---|
256 | </div> |
---|
257 | </div> |
---|
258 | </td> |
---|
259 | <td class="msource">StatusProxy</td> |
---|
260 | </tr> |
---|
261 | <tr class="method-row expandable"> |
---|
262 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
263 | <td class="sig"> |
---|
264 | <a id="Ext.dd.StatusProxy-update"></a> |
---|
265 | <b>update</b>( <code>String/HTMLElement html</code> ) : void <div class="mdesc"> |
---|
266 | <div class="short">Updates the contents of the ghost element</div> |
---|
267 | <div class="long"> |
---|
268 | Updates the contents of the ghost element <div class="mdetail-params"> |
---|
269 | <strong>Parameters:</strong> |
---|
270 | <ul><li><code>html</code> : String/HTMLElement<div class="sub-desc">The html that will replace the current innerHTML of the ghost element, or a |
---|
271 | DOM node to append as the child of the ghost element (in which case the innerHTML will be cleared first).</div></li> </ul> |
---|
272 | <strong>Returns:</strong> |
---|
273 | <ul> |
---|
274 | <li><code>void</code></li> |
---|
275 | </ul> |
---|
276 | </div> |
---|
277 | </div> |
---|
278 | </div> |
---|
279 | </td> |
---|
280 | <td class="msource">StatusProxy</td> |
---|
281 | </tr> |
---|
282 | </table> |
---|
283 | <a id="Ext.dd.StatusProxy-events"></a> |
---|
284 | <h2>Public Events</h2> |
---|
285 | <div class="no-members">This class has no public events.</div> |
---|
286 | </div> |
---|