+++ /dev/null
- <div class="body-wrap">
- <div class="top-tools">
- <a class="inner-link" href="#Ext.dd.DragSource-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
- <a class="inner-link" href="#Ext.dd.DragSource-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
- <a class="inner-link" href="#Ext.dd.DragSource-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
- <a class="inner-link" href="#Ext.dd.DragSource-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
- <a class="bookmark" href="../docs/?class=Ext.dd.DragSource"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
- </div>
- <div class="inheritance res-block">
-<pre class="res-block-inner"><a ext:cls="Ext.dd.DragDrop" ext:member="" href="output/Ext.dd.DragDrop.html">DragDrop</a>
- <img src="resources/elbow-end.gif"/><a ext:cls="Ext.dd.DD" ext:member="" href="output/Ext.dd.DD.html">DD</a>
- <img src="resources/elbow-end.gif"/><a ext:cls="Ext.dd.DDProxy" ext:member="" href="output/Ext.dd.DDProxy.html">DDProxy</a>
- <img src="resources/elbow-end.gif"/>DragSource</pre></div>
- <h1>Class Ext.dd.DragSource</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="../src/DragSource.js" target="_blank">DragSource.js</a></td></tr>
- <tr><td class="label">Class:</td><td class="hd-info">DragSource</td></tr>
- <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.dd.DragZone" href="output/Ext.dd.DragZone.html">DragZone</a></td></tr>
- <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.dd.DDProxy" ext:member="" href="output/Ext.dd.DDProxy.html">DDProxy</a></td></tr>
- </table>
- <div class="description">
- *
-A simple class that provides the basic implementation needed to make any element draggable. </div>
-
- <div class="hr"></div>
- <a id="Ext.dd.DragSource-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 expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-ddGroup"></a>\r
- <b>ddGroup</b> : String <div class="mdesc">\r
- <div class="short">A named drag drop group to which this object belongs. If a group is specified, then this object will only interact wi...</div>\r
- <div class="long">\r
- A named drag drop group to which this object belongs. If a group is specified, then this object will only interact with other drag drop objects in the same group (defaults to undefined). </div>\r
- </div>\r
- </td>\r
- <td class="msource">DragSource</td>\r
- </tr>\r
- <tr class="config-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-dropAllowed"></a>\r
- <b>dropAllowed</b> : String <div class="mdesc">\r
- The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok"). </div>\r
- </td>\r
- <td class="msource">DragSource</td>\r
- </tr>\r
- <tr class="config-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-dropNotAllowed"></a>\r
- <b>dropNotAllowed</b> : String <div class="mdesc">\r
- The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop"). </div>\r
- </td>\r
- <td class="msource">DragSource</td>\r
- </tr>\r
- </table>
- <a id="Ext.dd.DragSource-props"></a>
- <h2>Public Properties</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Property</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="property-row inherited">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-available"></a>\r
- <b>available</b> : boolean <div class="mdesc">\r
- The availabe property is false until the linked dom element is accessible. </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#available" href="output/Ext.dd.DragDrop.html#available">DragDrop</a></td>\r
- </tr>\r
- <tr class="property-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-centerFrame"></a>\r
- <b>centerFrame</b> : boolean <div class="mdesc">\r
- <div class="short">By default the frame is positioned exactly where the drag element is, so
-we use the cursor offset provided by Ext.dd....</div>\r
- <div class="long">\r
- By default the frame is positioned exactly where the drag element is, so
-we use the cursor offset provided by Ext.dd.DD. Another option that works only if
-you do not have constraints on the obj is to have the drag frame centered
-around the cursor. Set centerFrame to true for this effect. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DDProxy" ext:member="#centerFrame" href="output/Ext.dd.DDProxy.html#centerFrame">DDProxy</a></td>\r
- </tr>\r
- <tr class="property-row inherited">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-config"></a>\r
- <b>config</b> : object <div class="mdesc">\r
- Configuration attributes passed into the constructor </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#config" href="output/Ext.dd.DragDrop.html#config">DragDrop</a></td>\r
- </tr>\r
- <tr class="property-row inherited alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-defaultPadding"></a>\r
- <b>defaultPadding</b> : Object <div class="mdesc">\r
- Provides default constraint padding to "constrainTo" elements (defaults to {left: 0, right:0, top:0, bottom:0}). </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#defaultPadding" href="output/Ext.dd.DragDrop.html#defaultPadding">DragDrop</a></td>\r
- </tr>\r
- <tr class="property-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-groups"></a>\r
- <b>groups</b> : object <div class="mdesc">\r
- <div class="short">The group defines a logical collection of DragDrop objects that are
-related. Instances only get events when interact...</div>\r
- <div class="long">\r
- The group defines a logical collection of DragDrop objects that are
-related. Instances only get events when interacting with other
-DragDrop object in the same group. This lets us define multiple
-groups using a single DragDrop subclass if we want. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#groups" href="output/Ext.dd.DragDrop.html#groups">DragDrop</a></td>\r
- </tr>\r
- <tr class="property-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-hasOuterHandles"></a>\r
- <b>hasOuterHandles</b> : boolean <div class="mdesc">\r
- <div class="short">By default, drags can only be initiated if the mousedown occurs in the
-region the linked element is. This is done in...</div>\r
- <div class="long">\r
- By default, drags can only be initiated if the mousedown occurs in the
-region the linked element is. This is done in part to work around a
-bug in some browsers that mis-report the mousedown if the previous
-mouseup happened outside of the window. This property is set to true
-if outer handles are defined. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#hasOuterHandles" href="output/Ext.dd.DragDrop.html#hasOuterHandles">DragDrop</a></td>\r
- </tr>\r
- <tr class="property-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-id"></a>\r
- <b>id</b> : String <div class="mdesc">\r
- <div class="short">The id of the element associated with this object. This is what we
-refer to as the "linked element" because the size...</div>\r
- <div class="long">\r
- The id of the element associated with this object. This is what we
-refer to as the "linked element" because the size and position of
-this element is used to determine when the drag and drop objects have
-interacted. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#id" href="output/Ext.dd.DragDrop.html#id">DragDrop</a></td>\r
- </tr>\r
- <tr class="property-row inherited alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-invalidHandleClasses"></a>\r
- <b>invalidHandleClasses</b> : Array <div class="mdesc">\r
- An Array of CSS class names for elements to be considered in valid as drag handles. </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#invalidHandleClasses" href="output/Ext.dd.DragDrop.html#invalidHandleClasses">DragDrop</a></td>\r
- </tr>\r
- <tr class="property-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-invalidHandleIds"></a>\r
- <b>invalidHandleIds</b> : Object <div class="mdesc">\r
- <div class="short">An object who's property names identify the IDs of elements to be considered invalid as drag handles.
-A non-null prop...</div>\r
- <div class="long">\r
- An object who's property names identify the IDs of elements to be considered invalid as drag handles.
-A non-null property value identifies the ID as invalid. For example, to prevent
-dragging from being initiated on element ID "foo", use:<pre><code>{
- foo: true
-}</code></pre> </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#invalidHandleIds" href="output/Ext.dd.DragDrop.html#invalidHandleIds">DragDrop</a></td>\r
- </tr>\r
- <tr class="property-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-invalidHandleTypes"></a>\r
- <b>invalidHandleTypes</b> : Object <div class="mdesc">\r
- <div class="short">An object who's property names identify HTML tags to be considered invalid as drag handles.
-A non-null property value...</div>\r
- <div class="long">\r
- An object who's property names identify HTML tags to be considered invalid as drag handles.
-A non-null property value identifies the tag as invalid. Defaults to the
-following value which prevents drag operations from being initiated by <a> elements:<pre><code>{
- A: <em>"A"</em>
-}</code></pre> </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#invalidHandleTypes" href="output/Ext.dd.DragDrop.html#invalidHandleTypes">DragDrop</a></td>\r
- </tr>\r
- <tr class="property-row inherited">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-isTarget"></a>\r
- <b>isTarget</b> : boolean <div class="mdesc">\r
- By default, all instances can be a drop target. This can be disabled by
-setting isTarget to false. </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#isTarget" href="output/Ext.dd.DragDrop.html#isTarget">DragDrop</a></td>\r
- </tr>\r
- <tr class="property-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-maintainOffset"></a>\r
- <b>maintainOffset</b> : boolean <div class="mdesc">\r
- <div class="short">Maintain offsets when we resetconstraints. Set to true when you want
-the position of the element relative to its par...</div>\r
- <div class="long">\r
- Maintain offsets when we resetconstraints. Set to true when you want
-the position of the element relative to its parent to stay the same
-when the page changes </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#maintainOffset" href="output/Ext.dd.DragDrop.html#maintainOffset">DragDrop</a></td>\r
- </tr>\r
- <tr class="property-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-moveOnly"></a>\r
- <b>moveOnly</b> : boolean <div class="mdesc">\r
- <div class="short">When set to true, other DD objects in cooperating DDGroups do not receive
-notification events when this DD object is ...</div>\r
- <div class="long">\r
- When set to true, other DD objects in cooperating DDGroups do not receive
-notification events when this DD object is dragged over them. Defaults to false. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#moveOnly" href="output/Ext.dd.DragDrop.html#moveOnly">DragDrop</a></td>\r
- </tr>\r
- <tr class="property-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-onStartDrag"></a>\r
- <b>onStartDrag</b> : Object <div class="mdesc">\r
- <div class="short">An empty function by default, but provided so that you can perform a custom action once the initial
-drag event has be...</div>\r
- <div class="long">\r
- An empty function by default, but provided so that you can perform a custom action once the initial
-drag event has begun. The drag cannot be canceled from this function. </div>\r
- </div>\r
- </td>\r
- <td class="msource">DragSource</td>\r
- </tr>\r
- <tr class="property-row inherited">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-padding"></a>\r
- <b>padding</b> : int[] <div class="mdesc">\r
- The padding configured for this drag and drop object for calculating
-the drop zone intersection with this object. </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#padding" href="output/Ext.dd.DragDrop.html#padding">DragDrop</a></td>\r
- </tr>\r
- <tr class="property-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-primaryButtonOnly"></a>\r
- <b>primaryButtonOnly</b> : boolean <div class="mdesc">\r
- <div class="short">By default the drag and drop instance will only respond to the primary
-button click (left button for a right-handed m...</div>\r
- <div class="long">\r
- By default the drag and drop instance will only respond to the primary
-button click (left button for a right-handed mouse). Set to true to
-allow drag and drop to start with any mouse click that is propogated
-by the browser </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#primaryButtonOnly" href="output/Ext.dd.DragDrop.html#primaryButtonOnly">DragDrop</a></td>\r
- </tr>\r
- <tr class="property-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-resizeFrame"></a>\r
- <b>resizeFrame</b> : boolean <div class="mdesc">\r
- <div class="short">By default we resize the drag frame to be the same size as the element
-we want to drag (this is to get the frame effe...</div>\r
- <div class="long">\r
- By default we resize the drag frame to be the same size as the element
-we want to drag (this is to get the frame effect). We can turn it off
-if we want a different behavior. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DDProxy" ext:member="#resizeFrame" href="output/Ext.dd.DDProxy.html#resizeFrame">DDProxy</a></td>\r
- </tr>\r
- <tr class="property-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-scroll"></a>\r
- <b>scroll</b> : boolean <div class="mdesc">\r
- <div class="short">When set to true, the utility automatically tries to scroll the browser
-window when a drag and drop element is dragge...</div>\r
- <div class="long">\r
- When set to true, the utility automatically tries to scroll the browser
-window when a drag and drop element is dragged near the viewport boundary.
-Defaults to true. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#scroll" href="output/Ext.dd.DD.html#scroll">DD</a></td>\r
- </tr>\r
- <tr class="property-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-xTicks"></a>\r
- <b>xTicks</b> : int[] <div class="mdesc">\r
- <div class="short">Array of pixel locations the element will snap to if we specified a
-horizontal graduation/interval. This array is ge...</div>\r
- <div class="long">\r
- Array of pixel locations the element will snap to if we specified a
-horizontal graduation/interval. This array is generated automatically
-when you define a tick interval. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#xTicks" href="output/Ext.dd.DragDrop.html#xTicks">DragDrop</a></td>\r
- </tr>\r
- <tr class="property-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-yTicks"></a>\r
- <b>yTicks</b> : int[] <div class="mdesc">\r
- <div class="short">Array of pixel locations the element will snap to if we specified a
-vertical graduation/interval. This array is gene...</div>\r
- <div class="long">\r
- Array of pixel locations the element will snap to if we specified a
-vertical graduation/interval. This array is generated automatically
-when you define a tick interval. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#yTicks" href="output/Ext.dd.DragDrop.html#yTicks">DragDrop</a></td>\r
- </tr>\r
- </table>
- <a id="Ext.dd.DragSource-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">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-DragSource"></a>\r
- <b>DragSource</b>( <code>Mixed el</code>, <code>Object config</code> ) <div class="mdesc">\r
- <div class="short"></div>\r
- <div class="long">\r
- <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>el</code> : Mixed<div class="sub-desc">The container element</div></li><li><code>config</code> : Object<div class="sub-desc"></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code></code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DragSource</td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-addInvalidHandleClass"></a>\r
- <b>addInvalidHandleClass</b>( <code>string cssClass</code> ) : void <div class="mdesc">\r
- <div class="short">Lets you specify a css class of elements that will not initiate a drag</div>\r
- <div class="long">\r
- Lets you specify a css class of elements that will not initiate a drag <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>cssClass</code> : string<div class="sub-desc">the class of the elements you wish to ignore</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addInvalidHandleClass" href="output/Ext.dd.DragDrop.html#addInvalidHandleClass">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-addInvalidHandleId"></a>\r
- <b>addInvalidHandleId</b>( <code>string id</code> ) : void <div class="mdesc">\r
- <div class="short">Lets you to specify an element id for a child of a drag handle
-that should not initiate a drag</div>\r
- <div class="long">\r
- Lets you to specify an element id for a child of a drag handle
-that should not initiate a drag <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>id</code> : string<div class="sub-desc">the element id of the element you wish to ignore</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addInvalidHandleId" href="output/Ext.dd.DragDrop.html#addInvalidHandleId">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-addInvalidHandleType"></a>\r
- <b>addInvalidHandleType</b>( <code>string tagName</code> ) : void <div class="mdesc">\r
- <div class="short">Allows you to specify a tag name that should not start a drag operation
-when clicked. This is designed to facilitate...</div>\r
- <div class="long">\r
- Allows you to specify a tag name that should not start a drag operation
-when clicked. This is designed to facilitate embedding links within a
-drag handle that do something other than start the drag. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>tagName</code> : string<div class="sub-desc">the type of element to exclude</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addInvalidHandleType" href="output/Ext.dd.DragDrop.html#addInvalidHandleType">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-addToGroup"></a>\r
- <b>addToGroup</b>( <code>sGroup {string}</code> ) : void <div class="mdesc">\r
- <div class="short">Add this instance to a group of related drag/drop objects. All
-instances belong to at least one group, and can belon...</div>\r
- <div class="long">\r
- Add this instance to a group of related drag/drop objects. All
-instances belong to at least one group, and can belong to as many
-groups as needed. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>{string}</code> : sGroup<div class="sub-desc">the name of the group</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addToGroup" href="output/Ext.dd.DragDrop.html#addToGroup">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-afterDragDrop"></a>\r
- <b>afterDragDrop</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc">\r
- <div class="short">An empty function by default, but provided so that you can perform a custom action
-after a valid drag drop has occurr...</div>\r
- <div class="long">\r
- An empty function by default, but provided so that you can perform a custom action
-after a valid drag drop has occurred by providing an implementation. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dropped element</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DragSource</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-afterDragEnter"></a>\r
- <b>afterDragEnter</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc">\r
- <div class="short">An empty function by default, but provided so that you can perform a custom action
-when the dragged item enters the d...</div>\r
- <div class="long">\r
- An empty function by default, but provided so that you can perform a custom action
-when the dragged item enters the drop target by providing an implementation. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dragged element</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DragSource</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-afterDragOut"></a>\r
- <b>afterDragOut</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc">\r
- <div class="short">An empty function by default, but provided so that you can perform a custom action
-after the dragged item is dragged ...</div>\r
- <div class="long">\r
- An empty function by default, but provided so that you can perform a custom action
-after the dragged item is dragged out of the target without dropping. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dragged element</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DragSource</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-afterDragOver"></a>\r
- <b>afterDragOver</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc">\r
- <div class="short">An empty function by default, but provided so that you can perform a custom action
-while the dragged item is over the...</div>\r
- <div class="long">\r
- An empty function by default, but provided so that you can perform a custom action
-while the dragged item is over the drop target by providing an implementation. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dragged element</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DragSource</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-afterInvalidDrop"></a>\r
- <b>afterInvalidDrop</b>( <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc">\r
- <div class="short">An empty function by default, but provided so that you can perform a custom action
-after an invalid drop has occurred...</div>\r
- <div class="long">\r
- An empty function by default, but provided so that you can perform a custom action
-after an invalid drop has occurred by providing an implementation. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dropped element</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DragSource</td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-alignElWithMouse"></a>\r
- <b>alignElWithMouse</b>( <code>HTMLElement el</code>, <code>int iPageX</code>, <code>int iPageY</code> ) : void <div class="mdesc">\r
- <div class="short">Sets the element to the location of the mousedown or click event,
-maintaining the cursor location relative to the loc...</div>\r
- <div class="long">\r
- Sets the element to the location of the mousedown or click event,
-maintaining the cursor location relative to the location on the element
-that was clicked. Override this if you want to place the element in a
-location other than where the cursor is. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>el</code> : HTMLElement<div class="sub-desc">the element to move</div></li><li><code>iPageX</code> : int<div class="sub-desc">the X coordinate of the mousedown or drag event</div></li><li><code>iPageY</code> : int<div class="sub-desc">the Y coordinate of the mousedown or drag event</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#alignElWithMouse" href="output/Ext.dd.DD.html#alignElWithMouse">DD</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-applyConfig"></a>\r
- <b>applyConfig</b>() : void <div class="mdesc">\r
- <div class="short">Applies the configuration parameters that were passed into the constructor.
-This is supposed to happen at each level ...</div>\r
- <div class="long">\r
- Applies the configuration parameters that were passed into the constructor.
-This is supposed to happen at each level through the inheritance chain. So
-a DDProxy implentation will execute apply config on DDProxy, DD, and
-DragDrop in order to get all of the parameters that are available in
-each object. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#applyConfig" href="output/Ext.dd.DragDrop.html#applyConfig">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-autoOffset"></a>\r
- <b>autoOffset</b>( <code>int iPageX</code>, <code>int iPageY</code> ) : void <div class="mdesc">\r
- <div class="short">Sets the pointer offset to the distance between the linked element's top
-left corner and the location the element was...</div>\r
- <div class="long">\r
- Sets the pointer offset to the distance between the linked element's top
-left corner and the location the element was clicked <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>iPageX</code> : int<div class="sub-desc">the X coordinate of the click</div></li><li><code>iPageY</code> : int<div class="sub-desc">the Y coordinate of the click</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#autoOffset" href="output/Ext.dd.DD.html#autoOffset">DD</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-b4Drag"></a>\r
- <b>b4Drag</b>() : void <div class="mdesc">\r
- <div class="short">Event that fires prior to the onDrag event. Overrides
-Ext.dd.DragDrop.</div>\r
- <div class="long">\r
- Event that fires prior to the onDrag event. Overrides
-Ext.dd.DragDrop. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#b4Drag" href="output/Ext.dd.DD.html#b4Drag">DD</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-b4MouseDown"></a>\r
- <b>b4MouseDown</b>() : void <div class="mdesc">\r
- <div class="short">Event that fires prior to the onMouseDown event. Overrides
-Ext.dd.DragDrop.</div>\r
- <div class="long">\r
- Event that fires prior to the onMouseDown event. Overrides
-Ext.dd.DragDrop. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#b4MouseDown" href="output/Ext.dd.DD.html#b4MouseDown">DD</a></td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-beforeDragDrop"></a>\r
- <b>beforeDragDrop</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc">\r
- <div class="short">An empty function by default, but provided so that you can perform a custom action before the dragged
-item is dropped...</div>\r
- <div class="long">\r
- An empty function by default, but provided so that you can perform a custom action before the dragged
-item is dropped onto the target and optionally cancel the onDragDrop. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dragged element</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">isValid True if the drag drop event is valid, else false to cancel</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DragSource</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-beforeDragEnter"></a>\r
- <b>beforeDragEnter</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc">\r
- <div class="short">An empty function by default, but provided so that you can perform a custom action
-before the dragged item enters the...</div>\r
- <div class="long">\r
- An empty function by default, but provided so that you can perform a custom action
-before the dragged item enters the drop target and optionally cancel the onDragEnter. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dragged element</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">isValid True if the drag event is valid, else false to cancel</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DragSource</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-beforeDragOut"></a>\r
- <b>beforeDragOut</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc">\r
- <div class="short">An empty function by default, but provided so that you can perform a custom action before the dragged
-item is dragged...</div>\r
- <div class="long">\r
- An empty function by default, but provided so that you can perform a custom action before the dragged
-item is dragged out of the target without dropping, and optionally cancel the onDragOut. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dragged element</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">isValid True if the drag event is valid, else false to cancel</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DragSource</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-beforeDragOver"></a>\r
- <b>beforeDragOver</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc">\r
- <div class="short">An empty function by default, but provided so that you can perform a custom action
-while the dragged item is over the...</div>\r
- <div class="long">\r
- An empty function by default, but provided so that you can perform a custom action
-while the dragged item is over the drop target and optionally cancel the onDragOver. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dragged element</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">isValid True if the drag event is valid, else false to cancel</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DragSource</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-beforeInvalidDrop"></a>\r
- <b>beforeInvalidDrop</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc">\r
- <div class="short">An empty function by default, but provided so that you can perform a custom action after an invalid
-drop has occurred.</div>\r
- <div class="long">\r
- An empty function by default, but provided so that you can perform a custom action after an invalid
-drop has occurred. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dragged element</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">isValid True if the invalid drop should proceed, else false to cancel</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DragSource</td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-cachePosition"></a>\r
- <b>cachePosition</b>( <code>iPageX the</code>, <code>iPageY the</code> ) : void <div class="mdesc">\r
- <div class="short">Saves the most recent position so that we can reset the constraints and
-tick marks on-demand. We need to know this s...</div>\r
- <div class="long">\r
- Saves the most recent position so that we can reset the constraints and
-tick marks on-demand. We need to know this so that we can calculate the
-number of pixels the element is offset from its original position. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>the</code> : iPageX<div class="sub-desc">current x position (optional, this just makes it so we
-don't have to look it up again)</div></li><li><code>the</code> : iPageY<div class="sub-desc">current y position (optional, this just makes it so we
-don't have to look it up again)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#cachePosition" href="output/Ext.dd.DD.html#cachePosition">DD</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-clearConstraints"></a>\r
- <b>clearConstraints</b>() : void <div class="mdesc">\r
- <div class="short">Clears any constraints applied to this instance. Also clears ticks
-since they can't exist independent of a constrain...</div>\r
- <div class="long">\r
- Clears any constraints applied to this instance. Also clears ticks
-since they can't exist independent of a constraint at this time. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#clearConstraints" href="output/Ext.dd.DragDrop.html#clearConstraints">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-clearTicks"></a>\r
- <b>clearTicks</b>() : void <div class="mdesc">\r
- <div class="short">Clears any tick interval defined for this instance</div>\r
- <div class="long">\r
- Clears any tick interval defined for this instance <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#clearTicks" href="output/Ext.dd.DragDrop.html#clearTicks">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-constrainTo"></a>\r
- <b>constrainTo</b>( <code>Mixed constrainTo</code>, <span class="optional" title="Optional">[<code>Object/Number pad</code>]</span>, <span class="optional" title="Optional">[<code>Boolean inContent</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Initializes the drag drop object's constraints to restrict movement to a certain element.
-Usage:\r
- var dd = new Ext.d...</div>\r
- <div class="long">\r
- Initializes the drag drop object's constraints to restrict movement to a certain element.
-Usage:\r
- <pre><code>var dd = <b>new</b> Ext.dd.DDProxy(<em>"dragDiv1"</em>, <em>"proxytest"</em>,
- { dragElId: <em>"existingProxyDiv"</em> });
- dd.startDrag = <b>function</b>(){
- <b>this</b>.constrainTo(<em>"parent-id"</em>);
- };</code></pre>
-Or you can initalize it using the <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a> object:\r
- <pre><code>Ext.get(<em>"dragDiv1"</em>).initDDProxy(<em>"proxytest"</em>, {dragElId: <em>"existingProxyDiv"</em>}, {
- startDrag : <b>function</b>(){
- <b>this</b>.constrainTo(<em>"parent-id"</em>);
- }
- });</code></pre> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>constrainTo</code> : Mixed<div class="sub-desc">The element to constrain to.</div></li><li><code>pad</code> : Object/Number<div class="sub-desc">(optional) Pad provides a way to specify "padding" of the constraints,
-and can be either a number for symmetrical padding (4 would be equal to {left:4, right:4, top:4, bottom:4}) or
-an object containing the sides to pad. For example: {right:10, bottom:10}</div></li><li><code>inContent</code> : Boolean<div class="sub-desc">(optional) Constrain the draggable in the content box of the element (inside padding and borders)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#constrainTo" href="output/Ext.dd.DragDrop.html#constrainTo">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-createFrame"></a>\r
- <b>createFrame</b>() : void <div class="mdesc">\r
- <div class="short">Creates the proxy element if it does not yet exist</div>\r
- <div class="long">\r
- Creates the proxy element if it does not yet exist <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DDProxy" ext:member="#createFrame" href="output/Ext.dd.DDProxy.html#createFrame">DDProxy</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-endDrag"></a>\r
- <b>endDrag</b>( <code>Event e</code> ) : void <div class="mdesc">\r
- <div class="short">Fired when we are done dragging the object</div>\r
- <div class="long">\r
- Fired when we are done dragging the object <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#endDrag" href="output/Ext.dd.DragDrop.html#endDrag">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-getDragData"></a>\r
- <b>getDragData</b>() : Object <div class="mdesc">\r
- <div class="short">Returns the data object associated with this drag source</div>\r
- <div class="long">\r
- Returns the data object associated with this drag source <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Object</code><div class="sub-desc">data An object containing arbitrary data</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DragSource</td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-getDragEl"></a>\r
- <b>getDragEl</b>() : HTMLElement <div class="mdesc">\r
- <div class="short">Returns a reference to the actual element to drag. By default this is
-the same as the html element, but it can be as...</div>\r
- <div class="long">\r
- Returns a reference to the actual element to drag. By default this is
-the same as the html element, but it can be assigned to another
-element. An example of this can be found in Ext.dd.DDProxy <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>HTMLElement</code><div class="sub-desc">the html element</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#getDragEl" href="output/Ext.dd.DragDrop.html#getDragEl">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-getEl"></a>\r
- <b>getEl</b>() : HTMLElement <div class="mdesc">\r
- <div class="short">Returns a reference to the linked element</div>\r
- <div class="long">\r
- Returns a reference to the linked element <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>HTMLElement</code><div class="sub-desc">the html element</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#getEl" href="output/Ext.dd.DragDrop.html#getEl">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-getProxy"></a>\r
- <b>getProxy</b>() : Ext.dd.StatusProxy <div class="mdesc">\r
- <div class="short">Returns the drag source's underlying <a ext:cls="Ext.dd.StatusProxy" href="output/Ext.dd.StatusProxy.html">Ext.dd.StatusProxy</a></div>\r
- <div class="long">\r
- Returns the drag source's underlying <a ext:cls="Ext.dd.StatusProxy" href="output/Ext.dd.StatusProxy.html">Ext.dd.StatusProxy</a> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.dd.StatusProxy</code><div class="sub-desc">proxy The StatusProxy</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DragSource</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-hideProxy"></a>\r
- <b>hideProxy</b>() : void <div class="mdesc">\r
- <div class="short">Hides the drag source's <a ext:cls="Ext.dd.StatusProxy" href="output/Ext.dd.StatusProxy.html">Ext.dd.StatusProxy</a></div>\r
- <div class="long">\r
- Hides the drag source's <a ext:cls="Ext.dd.StatusProxy" href="output/Ext.dd.StatusProxy.html">Ext.dd.StatusProxy</a> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DragSource</td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-init"></a>\r
- <b>init</b>( <code>id the</code>, <code>String sGroup</code>, <code>object config</code> ) : void <div class="mdesc">\r
- <div class="short">Sets up the DragDrop object. Must be called in the constructor of any
-Ext.dd.DragDrop subclass</div>\r
- <div class="long">\r
- Sets up the DragDrop object. Must be called in the constructor of any
-Ext.dd.DragDrop subclass <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>the</code> : id<div class="sub-desc">id of the linked element</div></li><li><code>sGroup</code> : String<div class="sub-desc">the group of related items</div></li><li><code>config</code> : object<div class="sub-desc">configuration attributes</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#init" href="output/Ext.dd.DragDrop.html#init">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-initFrame"></a>\r
- <b>initFrame</b>() : void <div class="mdesc">\r
- <div class="short">Initialization for the drag frame element. Must be called in the
-constructor of all subclasses</div>\r
- <div class="long">\r
- Initialization for the drag frame element. Must be called in the
-constructor of all subclasses <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DDProxy" ext:member="#initFrame" href="output/Ext.dd.DDProxy.html#initFrame">DDProxy</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-initTarget"></a>\r
- <b>initTarget</b>( <code>id the</code>, <code>String sGroup</code>, <code>object config</code> ) : void <div class="mdesc">\r
- <div class="short">Initializes Targeting functionality only... the object does not
-get a mousedown handler.</div>\r
- <div class="long">\r
- Initializes Targeting functionality only... the object does not
-get a mousedown handler. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>the</code> : id<div class="sub-desc">id of the linked element</div></li><li><code>sGroup</code> : String<div class="sub-desc">the group of related items</div></li><li><code>config</code> : object<div class="sub-desc">configuration attributes</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#initTarget" href="output/Ext.dd.DragDrop.html#initTarget">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-isLocked"></a>\r
- <b>isLocked</b>() : boolean <div class="mdesc">\r
- <div class="short">Returns true if this instance is locked, or the drag drop mgr is locked
-(meaning that all drag/drop is disabled on th...</div>\r
- <div class="long">\r
- Returns true if this instance is locked, or the drag drop mgr is locked
-(meaning that all drag/drop is disabled on the page.) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>boolean</code><div class="sub-desc">true if this obj or all drag/drop is locked, else false</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#isLocked" href="output/Ext.dd.DragDrop.html#isLocked">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-isValidHandleChild"></a>\r
- <b>isValidHandleChild</b>( <code>HTMLElement node</code> ) : boolean <div class="mdesc">\r
- <div class="short">Checks the tag exclusion list to see if this click should be ignored</div>\r
- <div class="long">\r
- Checks the tag exclusion list to see if this click should be ignored <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>node</code> : HTMLElement<div class="sub-desc">the HTMLElement to evaluate</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>boolean</code><div class="sub-desc">true if this is a valid tag type, false if not</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#isValidHandleChild" href="output/Ext.dd.DragDrop.html#isValidHandleChild">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-lock"></a>\r
- <b>lock</b>() : void <div class="mdesc">\r
- <div class="short">Lock this instance</div>\r
- <div class="long">\r
- Lock this instance <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#lock" href="output/Ext.dd.DragDrop.html#lock">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-onAvailable"></a>\r
- <b>onAvailable</b>() : void <div class="mdesc">\r
- <div class="short">Override the onAvailable method to do what is needed after the initial
-position was determined.</div>\r
- <div class="long">\r
- Override the onAvailable method to do what is needed after the initial
-position was determined. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onAvailable" href="output/Ext.dd.DragDrop.html#onAvailable">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-onBeforeDrag"></a>\r
- <b>onBeforeDrag</b>( <code>Object data</code>, <code>Event e</code> ) : Boolean <div class="mdesc">\r
- <div class="short">An empty function by default, but provided so that you can perform a custom action before the initial
-drag event begi...</div>\r
- <div class="long">\r
- An empty function by default, but provided so that you can perform a custom action before the initial
-drag event begins and optionally cancel it. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>data</code> : Object<div class="sub-desc">An object containing arbitrary data to be shared with drop targets</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">isValid True if the drag event is valid, else false to cancel</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DragSource</td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-onDrag"></a>\r
- <b>onDrag</b>( <code>Event e</code> ) : void <div class="mdesc">\r
- <div class="short">Abstract method called during the onMouseMove event while dragging an
-object.</div>\r
- <div class="long">\r
- Abstract method called during the onMouseMove event while dragging an
-object. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>e</code> : Event<div class="sub-desc">the mousemove event</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDrag" href="output/Ext.dd.DragDrop.html#onDrag">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-onDragDrop"></a>\r
- <b>onDragDrop</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc">\r
- <div class="short">Abstract method called when this item is dropped on another DragDrop
-obj</div>\r
- <div class="long">\r
- Abstract method called when this item is dropped on another DragDrop
-obj <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li><li><code>id</code> : String|DragDrop[]<div class="sub-desc">In POINT mode, the element
-id this was dropped on. In INTERSECT mode, an array of dd items this
-was dropped on.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragDrop" href="output/Ext.dd.DragDrop.html#onDragDrop">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-onDragEnter"></a>\r
- <b>onDragEnter</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc">\r
- <div class="short">Abstract method called when this element fist begins hovering over
-another DragDrop obj</div>\r
- <div class="long">\r
- Abstract method called when this element fist begins hovering over
-another DragDrop obj <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>e</code> : Event<div class="sub-desc">the mousemove event</div></li><li><code>id</code> : String|DragDrop[]<div class="sub-desc">In POINT mode, the element
-id this is hovering over. In INTERSECT mode, an array of one or more
-dragdrop items being hovered over.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragEnter" href="output/Ext.dd.DragDrop.html#onDragEnter">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-onDragOut"></a>\r
- <b>onDragOut</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc">\r
- <div class="short">Abstract method called when we are no longer hovering over an element</div>\r
- <div class="long">\r
- Abstract method called when we are no longer hovering over an element <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>e</code> : Event<div class="sub-desc">the mousemove event</div></li><li><code>id</code> : String|DragDrop[]<div class="sub-desc">In POINT mode, the element
-id this was hovering over. In INTERSECT mode, an array of dd items
-that the mouse is no longer over.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragOut" href="output/Ext.dd.DragDrop.html#onDragOut">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-onDragOver"></a>\r
- <b>onDragOver</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc">\r
- <div class="short">Abstract method called when this element is hovering over another
-DragDrop obj</div>\r
- <div class="long">\r
- Abstract method called when this element is hovering over another
-DragDrop obj <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>e</code> : Event<div class="sub-desc">the mousemove event</div></li><li><code>id</code> : String|DragDrop[]<div class="sub-desc">In POINT mode, the element
-id this is hovering over. In INTERSECT mode, an array of dd items
-being hovered over.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragOver" href="output/Ext.dd.DragDrop.html#onDragOver">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-onInvalidDrop"></a>\r
- <b>onInvalidDrop</b>( <code>Event e</code> ) : void <div class="mdesc">\r
- <div class="short">Abstract method called when this item is dropped on an area with no
-drop target</div>\r
- <div class="long">\r
- Abstract method called when this item is dropped on an area with no
-drop target <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onInvalidDrop" href="output/Ext.dd.DragDrop.html#onInvalidDrop">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-onMouseDown"></a>\r
- <b>onMouseDown</b>( <code>Event e</code> ) : void <div class="mdesc">\r
- <div class="short">Event handler that fires when a drag/drop obj gets a mousedown</div>\r
- <div class="long">\r
- Event handler that fires when a drag/drop obj gets a mousedown <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>e</code> : Event<div class="sub-desc">the mousedown event</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onMouseDown" href="output/Ext.dd.DragDrop.html#onMouseDown">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-onMouseUp"></a>\r
- <b>onMouseUp</b>( <code>Event e</code> ) : void <div class="mdesc">\r
- <div class="short">Event handler that fires when a drag/drop obj gets a mouseup</div>\r
- <div class="long">\r
- Event handler that fires when a drag/drop obj gets a mouseup <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onMouseUp" href="output/Ext.dd.DragDrop.html#onMouseUp">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-removeFromGroup"></a>\r
- <b>removeFromGroup</b>( <code>string sGroup</code> ) : void <div class="mdesc">\r
- <div class="short">Remove's this instance from the supplied interaction group</div>\r
- <div class="long">\r
- Remove's this instance from the supplied interaction group <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>sGroup</code> : string<div class="sub-desc">The group to drop</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeFromGroup" href="output/Ext.dd.DragDrop.html#removeFromGroup">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-removeInvalidHandleClass"></a>\r
- <b>removeInvalidHandleClass</b>( <code>string cssClass</code> ) : void <div class="mdesc">\r
- <div class="short">Unsets an invalid css class</div>\r
- <div class="long">\r
- Unsets an invalid css class <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>cssClass</code> : string<div class="sub-desc">the class of the element(s) you wish to
-re-enable</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeInvalidHandleClass" href="output/Ext.dd.DragDrop.html#removeInvalidHandleClass">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-removeInvalidHandleId"></a>\r
- <b>removeInvalidHandleId</b>( <code>string id</code> ) : void <div class="mdesc">\r
- <div class="short">Unsets an invalid handle id</div>\r
- <div class="long">\r
- Unsets an invalid handle id <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>id</code> : string<div class="sub-desc">the id of the element to re-enable</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeInvalidHandleId" href="output/Ext.dd.DragDrop.html#removeInvalidHandleId">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-removeInvalidHandleType"></a>\r
- <b>removeInvalidHandleType</b>( <code>string tagName</code> ) : void <div class="mdesc">\r
- <div class="short">Unsets an excluded tag name set by addInvalidHandleType</div>\r
- <div class="long">\r
- Unsets an excluded tag name set by addInvalidHandleType <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>tagName</code> : string<div class="sub-desc">the type of element to unexclude</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeInvalidHandleType" href="output/Ext.dd.DragDrop.html#removeInvalidHandleType">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-resetConstraints"></a>\r
- <b>resetConstraints</b>( <code>boolean maintainOffset</code> ) : void <div class="mdesc">\r
- <div class="short">resetConstraints must be called if you manually reposition a dd element.</div>\r
- <div class="long">\r
- resetConstraints must be called if you manually reposition a dd element. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>maintainOffset</code> : boolean<div class="sub-desc"></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#resetConstraints" href="output/Ext.dd.DragDrop.html#resetConstraints">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-setDelta"></a>\r
- <b>setDelta</b>( <code>int iDeltaX</code>, <code>int iDeltaY</code> ) : void <div class="mdesc">\r
- <div class="short">Sets the pointer offset. You can call this directly to force the
-offset to be in a particular location (e.g., pass i...</div>\r
- <div class="long">\r
- Sets the pointer offset. You can call this directly to force the
-offset to be in a particular location (e.g., pass in 0,0 to set it
-to the center of the object) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>iDeltaX</code> : int<div class="sub-desc">the distance from the left</div></li><li><code>iDeltaY</code> : int<div class="sub-desc">the distance from the top</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#setDelta" href="output/Ext.dd.DD.html#setDelta">DD</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-setDragElId"></a>\r
- <b>setDragElId</b>( <code>id {string}</code> ) : void <div class="mdesc">\r
- <div class="short">Allows you to specify that an element other than the linked element
-will be moved with the cursor during a drag</div>\r
- <div class="long">\r
- Allows you to specify that an element other than the linked element
-will be moved with the cursor during a drag <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>{string}</code> : id<div class="sub-desc">the id of the element that will be used to initiate the drag</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setDragElId" href="output/Ext.dd.DragDrop.html#setDragElId">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-setDragElPos"></a>\r
- <b>setDragElPos</b>( <code>int iPageX</code>, <code>int iPageY</code> ) : void <div class="mdesc">\r
- <div class="short">Sets the drag element to the location of the mousedown or click event,
-maintaining the cursor location relative to th...</div>\r
- <div class="long">\r
- Sets the drag element to the location of the mousedown or click event,
-maintaining the cursor location relative to the location on the element
-that was clicked. Override this if you want to place the element in a
-location other than where the cursor is. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>iPageX</code> : int<div class="sub-desc">the X coordinate of the mousedown or drag event</div></li><li><code>iPageY</code> : int<div class="sub-desc">the Y coordinate of the mousedown or drag event</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#setDragElPos" href="output/Ext.dd.DD.html#setDragElPos">DD</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-setHandleElId"></a>\r
- <b>setHandleElId</b>( <code>id {string}</code> ) : void <div class="mdesc">\r
- <div class="short">Allows you to specify a child of the linked element that should be
-used to initiate the drag operation. An example o...</div>\r
- <div class="long">\r
- Allows you to specify a child of the linked element that should be
-used to initiate the drag operation. An example of this would be if
-you have a content div with text and links. Clicking anywhere in the
-content area would normally start the drag operation. Use this method
-to specify that an element inside of the content div is the element
-that starts the drag operation. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>{string}</code> : id<div class="sub-desc">the id of the element that will be used to
-initiate the drag.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setHandleElId" href="output/Ext.dd.DragDrop.html#setHandleElId">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-setInitialPosition"></a>\r
- <b>setInitialPosition</b>( <code>int diffX</code>, <code>int diffY</code> ) : void <div class="mdesc">\r
- <div class="short">Stores the initial placement of the linked element.</div>\r
- <div class="long">\r
- Stores the initial placement of the linked element. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>diffX</code> : int<div class="sub-desc">the X offset, default 0</div></li><li><code>diffY</code> : int<div class="sub-desc">the Y offset, default 0</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setInitialPosition" href="output/Ext.dd.DragDrop.html#setInitialPosition">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-setOuterHandleElId"></a>\r
- <b>setOuterHandleElId</b>( <code>id the</code> ) : void <div class="mdesc">\r
- <div class="short">Allows you to set an element outside of the linked element as a drag
-handle</div>\r
- <div class="long">\r
- Allows you to set an element outside of the linked element as a drag
-handle <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>the</code> : id<div class="sub-desc">id of the element that will be used to initiate the drag</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setOuterHandleElId" href="output/Ext.dd.DragDrop.html#setOuterHandleElId">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-setPadding"></a>\r
- <b>setPadding</b>( <code>int iTop</code>, <code>int iRight</code>, <code>int iBot</code>, <code>int iLeft</code> ) : void <div class="mdesc">\r
- <div class="short">Configures the padding for the target zone in px. Effectively expands
-(or reduces) the virtual object size for targe...</div>\r
- <div class="long">\r
- Configures the padding for the target zone in px. Effectively expands
-(or reduces) the virtual object size for targeting calculations.
-Supports css-style shorthand; if only one parameter is passed, all sides
-will have that padding, and if only two are passed, the top and bottom
-will have the first param, the left and right the second. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>iTop</code> : int<div class="sub-desc">Top pad</div></li><li><code>iRight</code> : int<div class="sub-desc">Right pad</div></li><li><code>iBot</code> : int<div class="sub-desc">Bot pad</div></li><li><code>iLeft</code> : int<div class="sub-desc">Left pad</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setPadding" href="output/Ext.dd.DragDrop.html#setPadding">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-setXConstraint"></a>\r
- <b>setXConstraint</b>( <code>int iLeft</code>, <code>int iRight</code>, <code>int iTickSize</code> ) : void <div class="mdesc">\r
- <div class="short">By default, the element can be dragged any place on the screen. Use
-this method to limit the horizontal travel of th...</div>\r
- <div class="long">\r
- By default, the element can be dragged any place on the screen. Use
-this method to limit the horizontal travel of the element. Pass in
-0,0 for the parameters if you want to lock the drag to the y axis. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>iLeft</code> : int<div class="sub-desc">the number of pixels the element can move to the left</div></li><li><code>iRight</code> : int<div class="sub-desc">the number of pixels the element can move to the
-right</div></li><li><code>iTickSize</code> : int<div class="sub-desc">optional parameter for specifying that the
-element
-should move iTickSize pixels at a time.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setXConstraint" href="output/Ext.dd.DragDrop.html#setXConstraint">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-setYConstraint"></a>\r
- <b>setYConstraint</b>( <code>int iUp</code>, <code>int iDown</code>, <code>int iTickSize</code> ) : void <div class="mdesc">\r
- <div class="short">By default, the element can be dragged any place on the screen. Set
-this to limit the vertical travel of the element...</div>\r
- <div class="long">\r
- By default, the element can be dragged any place on the screen. Set
-this to limit the vertical travel of the element. Pass in 0,0 for the
-parameters if you want to lock the drag to the x axis. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>iUp</code> : int<div class="sub-desc">the number of pixels the element can move up</div></li><li><code>iDown</code> : int<div class="sub-desc">the number of pixels the element can move down</div></li><li><code>iTickSize</code> : int<div class="sub-desc">optional parameter for specifying that the
-element should move iTickSize pixels at a time.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setYConstraint" href="output/Ext.dd.DragDrop.html#setYConstraint">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-startDrag"></a>\r
- <b>startDrag</b>( <code>int X</code>, <code>int Y</code> ) : void <div class="mdesc">\r
- <div class="short">Abstract method called after a drag/drop object is clicked
-and the drag or mousedown time thresholds have beeen met.</div>\r
- <div class="long">\r
- Abstract method called after a drag/drop object is clicked
-and the drag or mousedown time thresholds have beeen met. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>X</code> : int<div class="sub-desc">click location</div></li><li><code>Y</code> : int<div class="sub-desc">click location</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#startDrag" href="output/Ext.dd.DragDrop.html#startDrag">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-toString"></a>\r
- <b>toString</b>() : string <div class="mdesc">\r
- <div class="short">toString method</div>\r
- <div class="long">\r
- toString method <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>string</code><div class="sub-desc">string representation of the dd obj</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#toString" href="output/Ext.dd.DragDrop.html#toString">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-unlock"></a>\r
- <b>unlock</b>() : void <div class="mdesc">\r
- <div class="short">Unlock this instace</div>\r
- <div class="long">\r
- Unlock this instace <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#unlock" href="output/Ext.dd.DragDrop.html#unlock">DragDrop</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.dd.DragSource-unreg"></a>\r
- <b>unreg</b>() : void <div class="mdesc">\r
- <div class="short">Remove all drag and drop hooks for this element</div>\r
- <div class="long">\r
- Remove all drag and drop hooks for this element <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#unreg" href="output/Ext.dd.DragDrop.html#unreg">DragDrop</a></td>\r
- </tr>\r
- </table>
- <a id="Ext.dd.DragSource-events"></a>
- <h2>Public Events</h2>
- <div class="no-members">This class has no public events.</div>
- </div>
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff