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.dd.StatusProxy</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.dd.StatusProxy-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.dd.StatusProxy-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.dd.StatusProxy-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.dd.StatusProxy-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">
50 Class Roo.dd.StatusProxy
53 <table cellspacing="0" class="class-summary-table">
55 <tr><td class="label">Package:</td><td class="hd-info">Roo.dd</td></tr>
57 <tr><td class="label">Defined In:</td><td class="hd-info">
59 <a href="./src/Roo_dd_StatusProxy.js.html">Roo/dd/StatusProxy.js</a>.
62 <tr><td class="label">Class:</td><td class="hd-info">StatusProxy</td></tr>
70 <!-- ============================== class summary ========================== -->
71 <div class="description">
72 A specialized drag proxy that supports a drop status icon, {<b>link</b> Roo.Layer} styles and auto-repair. This is the<br/>default drag proxy used by all Roo.dd components.
76 <!-- ============================== Class comment block... ========================== -->
78 <div class="comments">
79 <b>Class Comments / Notes</B> =>
80 <u onclick="parent.CommentDialog.showCommentId = 'Roo.dd.StatusProxy';">[Add Your comment/notes about this class]</u>
82 <iframe frameborder="0" id="comments-Roo.dd" style="border: none;width:100%;"
83 src="/blog.php/GtkDjsComments/Roo.dd.StatusProxy.html"></iframe>
88 <!-- ============================== config options ========================== -->
93 <div class="hr"></div>
94 <a id="Roo.dd.StatusProxy-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.dd.StatusProxy-cfg-dropAllowed" name=".dropAllowed"></a>
119 <div class="fixedFont">
120 <b class="itemname">dropAllowed</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
126 <div class="short">The CSS class to apply to the status element when drop is allowed (defaults to "x-dd-drop-ok").</div>
130 <div class="long">The CSS class to apply to the status element when drop is allowed (defaults to "x-dd-drop-ok").</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.dd.StatusProxy-cfg-dropNotAllowed" name=".dropNotAllowed"></a>
149 <div class="fixedFont">
150 <b class="itemname">dropNotAllowed</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
156 <div class="short">The CSS class to apply to the status element when drop is not allowed (defaults to "x-dd-drop-nodrop").</div>
160 <div class="long">The CSS class to apply to the status element when drop is not allowed (defaults to "x-dd-drop-nodrop").</div>
184 <!-- ============================== public properties ==================== -->
188 <a id="Roo.dd.StatusProxy-props"></a>
194 <table cellspacing="0" class="member-table">
195 <caption class="Empty">Public Properties - Has None</caption>
201 <!-- ============================== methods summary / details ======================== -->
204 <a id="Roo.dd.StatusProxy-methods"></a>
205 <!-- constructor?? -->
212 <!-- then dynamics first -->
219 <table cellspacing="0" class="member-table">
220 <caption>Public Methods</caption>
222 <th class="sig-header" colspan="2">Method</th>
223 <th class="msource-header">Defined By</th>
233 <tr class="method-row config-row-alt0 expandable notInherited">
234 <td class="micon"><a class="exi" href="#expand"> </a></td>
238 <a id="Roo.dd-method-StatusProxy" name=".StatusProxy"></a>
239 <div class="fixedFont">
240 <span class="attributes">new <B>Roo.dd.</B></span><b class="itemname">StatusProxy</b>
242 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
250 <div class="short">Create a new Roo.dd.StatusProxy</div>
257 Create a new Roo.dd.StatusProxy
260 <dl class="detailList">
261 <dt class="heading">Parameters:</dt>
264 <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>
291 <tr class="method-row config-row-alt1 expandable notInherited">
292 <td class="micon"><a class="exi" href="#expand"> </a></td>
296 <a id="Roo.dd.StatusProxy-method-getEl" name=".getEl"></a>
297 <div class="fixedFont">
298 <span class="attributes"></span><b class="itemname">getEl</b>
306 <a href="./Roo.Layer.html#constructor" roo:cls="Roo.Layer.html#constructor">Roo.Layer</a>
315 <div class="short">Returns the underlying proxy {<b>link</b> Roo.Layer}</div>
321 Returns the underlying proxy {<b>link</b> Roo.Layer}
332 <dl class="detailList">
333 <dt class="heading">Returns:</dt>
335 <dd><span class="fixedFont"><a href="./Roo.Layer.html#constructor" roo:cls="Roo.Layer.html#constructor">Roo.Layer</a></span> el</dd>
357 <tr class="method-row config-row-alt0 expandable notInherited">
358 <td class="micon"><a class="exi" href="#expand"> </a></td>
362 <a id="Roo.dd.StatusProxy-method-getGhost" name=".getGhost"></a>
363 <div class="fixedFont">
364 <span class="attributes"></span><b class="itemname">getGhost</b>
372 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
381 <div class="short">Returns the ghost element</div>
387 Returns the ghost element
398 <dl class="detailList">
399 <dt class="heading">Returns:</dt>
401 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> el</dd>
423 <tr class="method-row config-row-alt1 expandable notInherited">
424 <td class="micon"><a class="exi" href="#expand"> </a></td>
428 <a id="Roo.dd.StatusProxy-method-hide" name=".hide"></a>
429 <div class="fixedFont">
430 <span class="attributes"></span><b class="itemname">hide</b>
432 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>clear</i></B>)
439 <div class="short">Hides the proxy</div>
452 <dl class="detailList">
453 <dt class="heading">Parameters:</dt>
456 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>clear</b>
459 <dd>True to reset the status and clear the ghost contents, false to preserve them</dd>
485 <tr class="method-row config-row-alt0 expandable notInherited">
486 <td class="micon"><a class="exi" href="#expand"> </a></td>
490 <a id="Roo.dd.StatusProxy-method-repair" name=".repair"></a>
491 <div class="fixedFont">
492 <span class="attributes"></span><b class="itemname">repair</b>
494 (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a> <B><i>xy</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>callback</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
501 <div class="short">Causes the proxy to return to its position of origin via an animation.</div>
507 Causes the proxy to return to its position of origin via an animation. Should be called after an<br/>invalid drop operation by the item being dragged.
514 <dl class="detailList">
515 <dt class="heading">Parameters:</dt>
518 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> <b>xy</b>
521 <dd>The XY position of the element ([x, y])</dd>
524 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>callback</b>
527 <dd>The function to call after the repair is complete</dd>
530 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
533 <dd>The scope in which to execute the callback</dd>
559 <tr class="method-row config-row-alt1 expandable notInherited">
560 <td class="micon"><a class="exi" href="#expand"> </a></td>
564 <a id="Roo.dd.StatusProxy-method-reset" name=".reset"></a>
565 <div class="fixedFont">
566 <span class="attributes"></span><b class="itemname">reset</b>
568 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>clearGhost</i></B>)
575 <div class="short">Resets the status indicator to the default dropNotAllowed value</div>
581 Resets the status indicator to the default dropNotAllowed value
588 <dl class="detailList">
589 <dt class="heading">Parameters:</dt>
592 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>clearGhost</b>
595 <dd>True to also remove all content from the ghost, false to preserve it</dd>
621 <tr class="method-row config-row-alt0 expandable notInherited">
622 <td class="micon"><a class="exi" href="#expand"> </a></td>
626 <a id="Roo.dd.StatusProxy-method-setStatus" name=".setStatus"></a>
627 <div class="fixedFont">
628 <span class="attributes"></span><b class="itemname">setStatus</b>
630 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>cssClass</i></B>)
637 <div class="short">Updates the proxy's visual element to indicate the status of whether or not drop is allowed<br/>over the current target element.</div>
643 Updates the proxy's visual element to indicate the status of whether or not drop is allowed<br/>over the current target element.
650 <dl class="detailList">
651 <dt class="heading">Parameters:</dt>
654 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>cssClass</b>
657 <dd>The css class for the new drop status indicator image</dd>
683 <tr class="method-row config-row-alt1 expandable notInherited">
684 <td class="micon"><a class="exi" href="#expand"> </a></td>
688 <a id="Roo.dd.StatusProxy-method-show" name=".show"></a>
689 <div class="fixedFont">
690 <span class="attributes"></span><b class="itemname">show</b>
699 <div class="short">Displays this proxy</div>
734 <tr class="method-row config-row-alt0 expandable notInherited">
735 <td class="micon"><a class="exi" href="#expand"> </a></td>
739 <a id="Roo.dd.StatusProxy-method-stop" name=".stop"></a>
740 <div class="fixedFont">
741 <span class="attributes"></span><b class="itemname">stop</b>
750 <div class="short">Stops the repair animation if it's currently running</div>
756 Stops the repair animation if it's currently running
785 <tr class="method-row config-row-alt1 expandable notInherited">
786 <td class="micon"><a class="exi" href="#expand"> </a></td>
790 <a id="Roo.dd.StatusProxy-method-sync" name=".sync"></a>
791 <div class="fixedFont">
792 <span class="attributes"></span><b class="itemname">sync</b>
801 <div class="short">Force the Layer to sync its shadow and shim positions to the element</div>
807 Force the Layer to sync its shadow and shim positions to the element
836 <tr class="method-row config-row-alt0 expandable notInherited">
837 <td class="micon"><a class="exi" href="#expand"> </a></td>
841 <a id="Roo.dd.StatusProxy-method-update" name=".update"></a>
842 <div class="fixedFont">
843 <span class="attributes"></span><b class="itemname">update</b>
845 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>html</i></B>)
852 <div class="short">Updates the contents of the ghost element</div>
858 Updates the contents of the ghost element
865 <dl class="detailList">
866 <dt class="heading">Parameters:</dt>
869 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>html</b>
872 <dd>The html that will replace the current innerHTML of the ghost element</dd>
901 <!-- ============================== events summary / details ======================== -->
904 <a id="Roo.dd.StatusProxy-events"></a>
910 <table cellspacing="0" class="member-table">
911 <caption class="Empty">Events - Has None</caption>
922 <!-- ============================== footer ================================= -->
923 <div class="fineprint" style="clear:both">
925 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Apr 01 2011 15:12:59 GMT+0800 (HKT)
927 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>