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.DropTarget</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.DropTarget-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.dd.DropTarget-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.dd.DropTarget-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.dd.DropTarget-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 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.dd.DDTarget.html#constructor" roo:cls="Roo.dd.DDTarget.html#constructor">Roo.dd.DDTarget</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.dd.DropTarget
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
57 Class Roo.dd.DropTarget
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo.dd</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_dd_DropTarget.js.html">Roo/dd/DropTarget.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">DropTarget</td></tr>
74 <tr><td class="label">Extends:</td><td class="hd-info">
75 <a href="./Roo.dd.DDTarget.html#constructor" roo:cls="Roo.dd.DDTarget.html#constructor">Roo.dd.DDTarget</a>
83 <!-- ============================== class summary ========================== -->
84 <div class="description">
85 A simple class that provides the basic implementation needed to make any element a drop target that can have<br/>draggable items dropped onto it. The drop has no effect until an implementation of notifyDrop is provided.
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.dd.DropTarget';">[Add Your comment/notes about this class]</u>
95 <iframe frameborder="0" id="comments-Roo.dd" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.dd.DropTarget.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.dd.DropTarget-configs"></a>
113 <table cellspacing="0" class="member-table">
114 <caption>Config Options (Usually are also Properties)</caption>
118 <th class="sig-header" colspan="2">Options</th>
120 <th class="msource-header">Defined By</th>
127 <tr class="config-row expandable config-row-alt0 notInherited">
128 <td class="micon"><a class="exi" href="#expand"> </a></td>
131 <a id="Roo.dd.DropTarget-cfg-dropAllowed" name=".dropAllowed"></a>
132 <div class="fixedFont">
133 <b class="itemname">dropAllowed</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
139 <div class="short">The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").</div>
143 <div class="long">The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").</div>
157 <tr class="config-row expandable config-row-alt1 notInherited">
158 <td class="micon"><a class="exi" href="#expand"> </a></td>
161 <a id="Roo.dd.DropTarget-cfg-dropNotAllowed" name=".dropNotAllowed"></a>
162 <div class="fixedFont">
163 <b class="itemname">dropNotAllowed</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
169 <div class="short">The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").</div>
173 <div class="long">The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").</div>
187 <tr class="config-row expandable config-row-alt0 notInherited">
188 <td class="micon"><a class="exi" href="#expand"> </a></td>
191 <a id="Roo.dd.DropTarget-cfg-overClass" name=".overClass"></a>
192 <div class="fixedFont">
193 <b class="itemname">overClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
199 <div class="short">The CSS class applied to the drop target element while the drag source is over it (defaults to "").</div>
203 <div class="long">The CSS class applied to the drop target element while the drag source is over it (defaults to "").</div>
227 <!-- ============================== public properties ==================== -->
231 <a id="Roo.dd.DropTarget-props"></a>
237 <table cellspacing="0" class="member-table">
238 <caption class="Empty">Public Properties - Has None</caption>
244 <!-- ============================== methods summary / details ======================== -->
247 <a id="Roo.dd.DropTarget-methods"></a>
248 <!-- constructor?? -->
255 <!-- then dynamics first -->
262 <table cellspacing="0" class="member-table">
263 <caption>Public Methods</caption>
265 <th class="sig-header" colspan="2">Method</th>
266 <th class="msource-header">Defined By</th>
276 <tr class="method-row config-row-alt0 expandable notInherited">
277 <td class="micon"><a class="exi" href="#expand"> </a></td>
281 <a id="Roo.dd-method-DropTarget" name=".DropTarget"></a>
282 <div class="fixedFont">
283 <span class="attributes">new <B>Roo.dd.</B></span><b class="itemname">DropTarget</b>
285 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
293 <div class="short">Create a new Roo.dd.DropTarget</div>
300 Create a new Roo.dd.DropTarget
303 <dl class="detailList">
304 <dt class="heading">Parameters:</dt>
307 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>el</b>
310 <dd>The container element</dd>
313 <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>
340 <tr class="method-row config-row-alt1 expandable notInherited">
341 <td class="micon"><a class="exi" href="#expand"> </a></td>
345 <a id="Roo.dd.DropTarget-method-notifyDrop" name=".notifyDrop"></a>
346 <div class="fixedFont">
347 <span class="attributes"></span><b class="itemname">notifyDrop</b>
349 (<a href="./Roo.dd.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</a> <B><i>source</i></B>, Event <B><i>e</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>data</i></B>)
355 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
364 <div class="short">The function a {<b>link</b> Roo.dd.DragSource} calls once to notify this drop target that the dragged item has<br/>been dropped on it.</div>
370 The function a {<b>link</b> Roo.dd.DragSource} calls once to notify this drop target that the dragged item has<br/>been dropped on it. This method has no default implementation and returns false, so you must provide an<br/>implementation that does something to process the drop event and returns true so that the drag source's<br/>repair action does not run.
377 <dl class="detailList">
378 <dt class="heading">Parameters:</dt>
381 <span class="fixedFont"><a href="./Roo.dd.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</a></span> <b>source</b>
384 <dd>The drag source that was dragged over this drop target</dd>
387 <span class="fixedFont">Event</span> <b>e</b>
393 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>data</b>
396 <dd>An object containing arbitrary data supplied by the drag source</dd>
404 <dl class="detailList">
405 <dt class="heading">Returns:</dt>
407 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> True if the drop was valid, else false</dd>
429 <tr class="method-row config-row-alt0 expandable notInherited">
430 <td class="micon"><a class="exi" href="#expand"> </a></td>
434 <a id="Roo.dd.DropTarget-method-notifyEnter" name=".notifyEnter"></a>
435 <div class="fixedFont">
436 <span class="attributes"></span><b class="itemname">notifyEnter</b>
438 (<a href="./Roo.dd.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</a> <B><i>source</i></B>, Event <B><i>e</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>data</i></B>)
444 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
453 <div class="short">The function a {<b>link</b> Roo.dd.DragSource} calls once to notify this drop target that the source is now over the<br/>target.</div>
459 The function a {<b>link</b> Roo.dd.DragSource} calls once to notify this drop target that the source is now over the<br/>target. This default implementation adds the CSS class specified by overClass (if any) to the drop element<br/>and returns the dropAllowed config value. This method should be overridden if drop validation is required.
466 <dl class="detailList">
467 <dt class="heading">Parameters:</dt>
470 <span class="fixedFont"><a href="./Roo.dd.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</a></span> <b>source</b>
473 <dd>The drag source that was dragged over this drop target</dd>
476 <span class="fixedFont">Event</span> <b>e</b>
482 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>data</b>
485 <dd>An object containing arbitrary data supplied by the drag source</dd>
493 <dl class="detailList">
494 <dt class="heading">Returns:</dt>
496 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> status The CSS class that communicates the drop status back to the source so that the<br/>underlying {<b>link</b> Roo.dd.StatusProxy} can be updated</dd>
518 <tr class="method-row config-row-alt1 expandable notInherited">
519 <td class="micon"><a class="exi" href="#expand"> </a></td>
523 <a id="Roo.dd.DropTarget-method-notifyOut" name=".notifyOut"></a>
524 <div class="fixedFont">
525 <span class="attributes"></span><b class="itemname">notifyOut</b>
527 (<a href="./Roo.dd.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</a> <B><i>source</i></B>, Event <B><i>e</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>data</i></B>)
534 <div class="short">The function a {<b>link</b> Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged<br/>out of the target without dropping.</div>
540 The function a {<b>link</b> Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged<br/>out of the target without dropping. This default implementation simply removes the CSS class specified by<br/>overClass (if any) from the drop element.
547 <dl class="detailList">
548 <dt class="heading">Parameters:</dt>
551 <span class="fixedFont"><a href="./Roo.dd.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</a></span> <b>source</b>
554 <dd>The drag source that was dragged over this drop target</dd>
557 <span class="fixedFont">Event</span> <b>e</b>
563 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>data</b>
566 <dd>An object containing arbitrary data supplied by the drag source</dd>
592 <tr class="method-row config-row-alt0 expandable notInherited">
593 <td class="micon"><a class="exi" href="#expand"> </a></td>
597 <a id="Roo.dd.DropTarget-method-notifyOver" name=".notifyOver"></a>
598 <div class="fixedFont">
599 <span class="attributes"></span><b class="itemname">notifyOver</b>
601 (<a href="./Roo.dd.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</a> <B><i>source</i></B>, Event <B><i>e</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>data</i></B>)
607 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
616 <div class="short">The function a {<b>link</b> Roo.dd.DragSource} calls continuously while it is being dragged over the target.</div>
622 The function a {<b>link</b> Roo.dd.DragSource} calls continuously while it is being dragged over the target.<br/>This method will be called on every mouse movement while the drag source is over the drop target.<br/>This default implementation simply returns the dropAllowed config value.
629 <dl class="detailList">
630 <dt class="heading">Parameters:</dt>
633 <span class="fixedFont"><a href="./Roo.dd.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</a></span> <b>source</b>
636 <dd>The drag source that was dragged over this drop target</dd>
639 <span class="fixedFont">Event</span> <b>e</b>
645 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>data</b>
648 <dd>An object containing arbitrary data supplied by the drag source</dd>
656 <dl class="detailList">
657 <dt class="heading">Returns:</dt>
659 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> status The CSS class that communicates the drop status back to the source so that the<br/>underlying {<b>link</b> Roo.dd.StatusProxy} can be updated</dd>
684 <!-- ============================== events summary / details ======================== -->
687 <a id="Roo.dd.DropTarget-events"></a>
693 <table cellspacing="0" class="member-table">
694 <caption class="Empty">Events - Has None</caption>
705 <!-- ============================== footer ================================= -->
706 <div class="fineprint" style="clear:both">
708 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 16 2010 15:55:26 GMT+0800 (HKT)
710 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>