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.DragZone</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.DragZone-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.dd.DragZone-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.dd.DragZone-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.dd.DragZone-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.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.dd.DragZone
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
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_DragZone.js.html">Roo/dd/DragZone.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">DragZone</td></tr>
74 <tr><td class="label">Extends:</td><td class="hd-info">
75 <a href="./Roo.dd.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</a>
83 <!-- ============================== class summary ========================== -->
84 <div class="description">
85 This class provides a container DD instance that proxies for multiple child node sources.<br /><br/>By default, this class requires that draggable child nodes are registered with {<b>link</b> Roo.dd.Registry}.
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.dd.DragZone';">[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.DragZone.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.dd.DragZone-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.DragZone-cfg-containerScroll" name=".containerScroll"></a>
132 <div class="fixedFont">
133 <b class="itemname">containerScroll</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
139 <div class="short">True to register this container with the Scrollmanager<br/>for auto scrolling during drag operations.</div>
143 <div class="long">True to register this container with the Scrollmanager<br/>for auto scrolling during drag operations.</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.DragZone-cfg-hlColor" name=".hlColor"></a>
162 <div class="fixedFont">
163 <b class="itemname">hlColor</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
169 <div class="short">The color to use when visually highlighting the drag source in the afterRepair<br/>method after a failed drop (defaults to "c3daf9" - light blue)</div>
173 <div class="long">The color to use when visually highlighting the drag source in the afterRepair<br/>method after a failed drop (defaults to "c3daf9" - light blue)</div>
197 <!-- ============================== public properties ==================== -->
201 <a id="Roo.dd.DragZone-props"></a>
207 <table cellspacing="0" class="member-table">
208 <caption class="Empty">Public Properties - Has None</caption>
214 <!-- ============================== methods summary / details ======================== -->
217 <a id="Roo.dd.DragZone-methods"></a>
218 <!-- constructor?? -->
225 <!-- then dynamics first -->
232 <table cellspacing="0" class="member-table">
233 <caption>Public Methods</caption>
235 <th class="sig-header" colspan="2">Method</th>
236 <th class="msource-header">Defined By</th>
246 <tr class="method-row config-row-alt0 expandable notInherited">
247 <td class="micon"><a class="exi" href="#expand"> </a></td>
251 <a id="Roo.dd-method-DragZone" name=".DragZone"></a>
252 <div class="fixedFont">
253 <span class="attributes">new <B>Roo.dd.</B></span><b class="itemname">DragZone</b>
255 (<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>)
263 <div class="short">Create a new Roo.dd.DragZone</div>
270 Create a new Roo.dd.DragZone
273 <dl class="detailList">
274 <dt class="heading">Parameters:</dt>
277 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>el</b>
280 <dd>The container element</dd>
283 <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>
310 <tr class="method-row config-row-alt1 expandable notInherited">
311 <td class="micon"><a class="exi" href="#expand"> </a></td>
315 <a id="Roo.dd.DragZone-method-afterRepair" name=".afterRepair"></a>
316 <div class="fixedFont">
317 <span class="attributes"></span><b class="itemname">afterRepair</b>
326 <div class="short">Called after a repair of an invalid drop.</div>
332 Called after a repair of an invalid drop. By default, highlights this.dragData.ddel
361 <tr class="method-row config-row-alt0 expandable notInherited">
362 <td class="micon"><a class="exi" href="#expand"> </a></td>
366 <a id="Roo.dd.DragZone-method-getDragData" name=".getDragData"></a>
367 <div class="fixedFont">
368 <span class="attributes"></span><b class="itemname">getDragData</b>
370 (EventObject <B><i>e</i></B>)
376 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
385 <div class="short">Called when a mousedown occurs in this container.</div>
391 Called when a mousedown occurs in this container. Looks in {<b>link</b> Roo.dd.Registry}<br/>for a valid target to drag based on the mouse down. Override this method<br/>to provide your own lookup logic (e.g. finding a child by class name). Make sure your returned<br/>object has a "ddel" attribute (with an HTML Element) for other functions to work.
398 <dl class="detailList">
399 <dt class="heading">Parameters:</dt>
402 <span class="fixedFont">EventObject</span> <b>e</b>
405 <dd>The mouse down event</dd>
413 <dl class="detailList">
414 <dt class="heading">Returns:</dt>
416 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> The dragData</dd>
438 <tr class="method-row config-row-alt1 expandable notInherited">
439 <td class="micon"><a class="exi" href="#expand"> </a></td>
443 <a id="Roo.dd.DragZone-method-getRepairXY" name=".getRepairXY"></a>
444 <div class="fixedFont">
445 <span class="attributes"></span><b class="itemname">getRepairXY</b>
447 (EventObject <B><i>e</i></B>)
453 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
462 <div class="short">Called before a repair of an invalid drop to get the XY to animate to.</div>
468 Called before a repair of an invalid drop to get the XY to animate to. By default returns<br/>the XY of this.dragData.ddel
475 <dl class="detailList">
476 <dt class="heading">Parameters:</dt>
479 <span class="fixedFont">EventObject</span> <b>e</b>
482 <dd>The mouse up event</dd>
490 <dl class="detailList">
491 <dt class="heading">Returns:</dt>
493 <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> The xy location (e.g. [100, 200])</dd>
515 <tr class="method-row config-row-alt0 expandable notInherited">
516 <td class="micon"><a class="exi" href="#expand"> </a></td>
520 <a id="Roo.dd.DragZone-method-onInitDrag" name=".onInitDrag"></a>
521 <div class="fixedFont">
522 <span class="attributes"></span><b class="itemname">onInitDrag</b>
524 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>x</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>y</i></B>)
530 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
539 <div class="short">Called once drag threshold has been reached to initialize the proxy element.</div>
545 Called once drag threshold has been reached to initialize the proxy element. By default, it clones the<br/>this.dragData.ddel
552 <dl class="detailList">
553 <dt class="heading">Parameters:</dt>
556 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
559 <dd>The x position of the click on the dragged object</dd>
562 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
565 <dd>The y position of the click on the dragged object</dd>
573 <dl class="detailList">
574 <dt class="heading">Returns:</dt>
576 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> true to continue the drag, false to cancel</dd>
601 <!-- ============================== events summary / details ======================== -->
604 <a id="Roo.dd.DragZone-events"></a>
610 <table cellspacing="0" class="member-table">
611 <caption class="Empty">Events - Has None</caption>
622 <!-- ============================== footer ================================= -->
623 <div class="fineprint" style="clear:both">
625 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)
627 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>