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