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