webgui/www/extras/yui/docs/YAHOO.util.DragDrop.html
2008-03-25 16:13:25 +00:00

4188 lines
203 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>API: dragdrop YAHOO.util.DragDrop (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/api.css">
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
<h3>Drag and Drop&nbsp; <span class="subtitle">2.5.1</span></h3>
<p>
<a href="./index.html">Yahoo! UI Library</a>
&gt; <a href="./module_dragdrop.html">dragdrop</a>
&gt; YAHOO.util.DragDrop
</p>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form name="yui-classopts-form">
<span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> Show Private</span>
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> Show Protected</span>
</form>
<h2>
Class <b>YAHOO.util.DragDrop</b>
<span class="extends">
</span>
<span class="extends">
</span>
</code>
</h2>
<!-- class tree goes here -->
<dl class="subclasses">
<dt>Known Subclasses:</dd>
<dd>
<a href="YAHOO.widget.Slider.html">YAHOO.widget.Slider</a>
<a href="YAHOO.util.DDTarget.html">YAHOO.util.DDTarget</a>
<a href="YAHOO.util.DD.html">YAHOO.util.DD</a>
</dd>
</dl>
<div class="summary description">
Defines the interface and base operation of items that that can be
dragged or can be drop targets. It was designed to be extended, overriding
the event handlers for startDrag, onDrag, onDragOver, onDragOut.
Up to three html elements can be associated with a DragDrop instance:
<ul>
<li>linked element: the element that is passed into the constructor.
This is the element which defines the boundaries for interaction with
other DragDrop objects.</li>
<li>handle element(s): The drag operation only occurs if the element that
was clicked matches a handle element. By default this is the linked
element, but there are times that you will want only a portion of the
linked element to initiate the drag operation, and the setHandleElId()
method provides a way to define this.</li>
<li>drag element: this represents an the element that would be moved along
with the cursor during a drag operation. By default, this is the linked
element itself as in {@link YAHOO.util.DD}. setDragElId() lets you define
a separate element that would be moved, as in {@link YAHOO.util.DDProxy}
</li>
</ul>
This class should not be instantiated until the onload event to ensure that
the associated elements are available.
The following would define a DragDrop obj that would interact with any
other DragDrop obj in the "group1" group:
<pre>
dd = new YAHOO.util.DragDrop("div1", "group1");
</pre>
Since none of the event handlers have been implemented, nothing would
actually happen if you were to run the code above. Normally you would
override this class or one of the default implementations, but you can
also override the methods you want on an instance of the class...
<pre>
dd.onDragDrop = function(e, id) {
&nbsp;&nbsp;alert("dd was dropped on " + id);
}
</pre>
</div>
<div class="section constructor details">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong>YAHOO.util.DragDrop</strong>
<code>
(
id
,
sGroup
,
config
)
</code>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>id
&lt;String&gt;
</code>
of the element that is linked to this instance
</dd>
<dd>
<code>sGroup
&lt;String&gt;
</code>
the group of related DragDrop objects
</dd>
<dd>
<code>config
&lt;object&gt;
</code>
an object containing configurable attributes
Valid properties for DragDrop:
padding, isTarget, maintainOffset, primaryButtonOnly,
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="private">
<h4><a name="property___ygDragDrop">__ygDragDrop</a>
<code>- private object</code>
</h4>
<div class="detail">
<div class="description">
Internal typeof flag
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__domRef">_domRef</a>
<code>- private object</code>
</h4>
<div class="detail">
<div class="description">
Cached reference to the linked element
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_available">available</a>
<code>- boolean</code>
</h4>
<div class="detail">
<div class="description">
The availabe property is false until the linked dom element is accessible.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_config">config</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
Configuration attributes passed into the constructor
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_constrainX">constrainX</a>
<code>- private boolean</code>
</h4>
<div class="detail">
<div class="description">
Set to true when horizontal contraints are applied
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_constrainY">constrainY</a>
<code>- private boolean</code>
</h4>
<div class="detail">
<div class="description">
Set to true when vertical contraints are applied
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_cursorIsOver">cursorIsOver</a>
<code>- boolean</code>
</h4>
<div class="detail">
<div class="description">
Property that is assigned to a drag and drop object when testing to
see if it is being targeted by another dd object. This property
can be used in intersect mode to help determine the focus of
the mouse interaction. DDM.getBestMatch uses this property first to
determine the closest match in INTERSECT mode when multiple targets
are part of the same interaction.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_deltaX">deltaX</a>
<code>- private int</code>
</h4>
<div class="detail">
<div class="description">
The difference between the click position and the source element's location
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_deltaY">deltaY</a>
<code>- private int</code>
</h4>
<div class="detail">
<div class="description">
The difference between the click position and the source element's location
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_dragElId">dragElId</a>
<code>- private String</code>
</h4>
<div class="detail">
<div class="description">
The id of the element that will be dragged. By default this is same
as the linked element , but could be changed to another element. Ex:
YAHOO.util.DDProxy
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_dragOnly">dragOnly</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
If this flag is true, do not fire drop events. The element is a drag only element (for movement not dropping)
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_events">events</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
An Object Literal containing the events that we will be using: mouseDown, b4MouseDown, mouseUp, b4StartDrag, startDrag, b4EndDrag, endDrag, mouseUp, drag, b4Drag, invalidDrop, b4DragOut, dragOut, dragEnter, b4DragOver, dragOver, b4DragDrop, dragDrop
By setting any of these to false, then event will not be fired.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_groups">groups</a>
<code>- {string: string}</code>
</h4>
<div class="detail">
<div class="description">
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>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_handleElId">handleElId</a>
<code>- private String</code>
</h4>
<div class="detail">
<div class="description">
the id of the element that initiates the drag operation. By default
this is the linked element, but could be changed to be a child of this
element. This lets us do things like only starting the drag when the
header element within the linked html element is clicked.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_hasOuterHandles">hasOuterHandles</a>
<code>- boolean</code>
</h4>
<div class="detail">
<div class="description">
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>
</div>
<div class="default">
Default Value: false
</div>
<hr />
</div>
<div class="">
<h4><a name="property_id">id</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
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>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_invalidHandleClasses">invalidHandleClasses</a>
<code>- string[]</code>
</h4>
<div class="detail">
<div class="description">
An indexted array of css class names for elements that will be ignored
if clicked.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_invalidHandleIds">invalidHandleIds</a>
<code>- {string: string}</code>
</h4>
<div class="detail">
<div class="description">
An associative array of ids for elements that will be ignored if clicked
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_invalidHandleTypes">invalidHandleTypes</a>
<code>- {string: string}</code>
</h4>
<div class="detail">
<div class="description">
An associative array of HTML tags that will be ignored if clicked.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_isTarget">isTarget</a>
<code>- boolean</code>
</h4>
<div class="detail">
<div class="description">
By default, all instances can be a drop target. This can be disabled by
setting isTarget to false.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_locked">locked</a>
<code>- private boolean</code>
</h4>
<div class="detail">
<div class="description">
Individual drag/drop instances can be locked. This will prevent
onmousedown start drag.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_maintainOffset">maintainOffset</a>
<code>- boolean</code>
</h4>
<div class="detail">
<div class="description">
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>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_maxX">maxX</a>
<code>- private int</code>
</h4>
<div class="detail">
<div class="description">
The right constraint
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_maxY">maxY</a>
<code>- private int</code>
</h4>
<div class="detail">
<div class="description">
The down constraint
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_minX">minX</a>
<code>- private int</code>
</h4>
<div class="detail">
<div class="description">
The left constraint
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_minY">minY</a>
<code>- private int</code>
</h4>
<div class="detail">
<div class="description">
The up constraint
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_overlap">overlap</a>
<code>- YAHOO.util.Region</code>
</h4>
<div class="detail">
<div class="description">
Property that is assigned to a drag and drop object when testing to
see if it is being targeted by another dd object. This is a region
that represents the area the draggable element overlaps this target.
DDM.getBestMatch uses this property to compare the size of the overlap
to that of other targets in order to determine the closest match in
INTERSECT mode when multiple targets are part of the same interaction.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_padding">padding</a>
<code>- int[]</code>
</h4>
<div class="detail">
<div class="description">
The padding configured for this drag and drop object for calculating
the drop zone intersection with this object.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_primaryButtonOnly">primaryButtonOnly</a>
<code>- boolean</code>
</h4>
<div class="detail">
<div class="description">
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>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_startPageX">startPageX</a>
<code>- private int</code>
</h4>
<div class="detail">
<div class="description">
The linked element's absolute X position at the time the drag was
started
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_startPageY">startPageY</a>
<code>- private int</code>
</h4>
<div class="detail">
<div class="description">
The linked element's absolute X position at the time the drag was
started
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_xTicks">xTicks</a>
<code>- int[]</code>
</h4>
<div class="detail">
<div class="description">
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>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_yTicks">yTicks</a>
<code>- int[]</code>
</h4>
<div class="detail">
<div class="description">
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>
</div>
<hr />
</div>
</div>
</div>
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="">
<h4>
<a name="method_addInvalidHandleClass">addInvalidHandleClass</a></h4>
<div class="detail">
<code>
void
<strong>addInvalidHandleClass</strong>
(
cssClass
)
</code>
<div class="description">
Lets you specify a css class of elements that will not initiate a drag
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>cssClass &lt;string&gt;</code>
the class of the elements you wish to ignore
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_addInvalidHandleId">addInvalidHandleId</a></h4>
<div class="detail">
<code>
void
<strong>addInvalidHandleId</strong>
(
id
)
</code>
<div class="description">
Lets you to specify an element id for a child of a drag handle
that should not initiate a drag
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>id &lt;string&gt;</code>
the element id of the element you wish to ignore
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_addInvalidHandleType">addInvalidHandleType</a></h4>
<div class="detail">
<code>
void
<strong>addInvalidHandleType</strong>
(
tagName
)
</code>
<div class="description">
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>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>tagName &lt;string&gt;</code>
the type of element to exclude
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_addToGroup">addToGroup</a></h4>
<div class="detail">
<code>
void
<strong>addToGroup</strong>
(
sGroup
)
</code>
<div class="description">
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>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sGroup &lt;string&gt;</code>
the name of the group
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_applyConfig">applyConfig</a></h4>
<div class="detail">
<code>
void
<strong>applyConfig</strong>
(
)
</code>
<div class="description">
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>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_b4Drag">b4Drag</a></h4>
<div class="detail">
<code>
private
void
<strong>b4Drag</strong>
(
)
</code>
<div class="description">
Code that executes immediately before the onDrag event
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_b4DragDrop">b4DragDrop</a></h4>
<div class="detail">
<code>
private
void
<strong>b4DragDrop</strong>
(
)
</code>
<div class="description">
Code that executes immediately before the onDragDrop event
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_b4DragOut">b4DragOut</a></h4>
<div class="detail">
<code>
private
void
<strong>b4DragOut</strong>
(
)
</code>
<div class="description">
Code that executes immediately before the onDragOut event
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_b4DragOver">b4DragOver</a></h4>
<div class="detail">
<code>
private
void
<strong>b4DragOver</strong>
(
)
</code>
<div class="description">
Code that executes immediately before the onDragOver event
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_b4EndDrag">b4EndDrag</a></h4>
<div class="detail">
<code>
private
void
<strong>b4EndDrag</strong>
(
)
</code>
<div class="description">
Code that executes immediately before the endDrag event
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_b4MouseDown">b4MouseDown</a></h4>
<div class="detail">
<code>
private
void
<strong>b4MouseDown</strong>
(
e
)
</code>
<div class="description">
Code executed immediately before the onMouseDown event
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;Event&gt;</code>
the mousedown event
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_b4StartDrag">b4StartDrag</a></h4>
<div class="detail">
<code>
private
void
<strong>b4StartDrag</strong>
(
)
</code>
<div class="description">
Code that executes immediately before the startDrag event
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_clearConstraints">clearConstraints</a></h4>
<div class="detail">
<code>
void
<strong>clearConstraints</strong>
(
)
</code>
<div class="description">
Clears any constraints applied to this instance. Also clears ticks
since they can't exist independent of a constraint at this time.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_clearTicks">clearTicks</a></h4>
<div class="detail">
<code>
void
<strong>clearTicks</strong>
(
)
</code>
<div class="description">
Clears any tick interval defined for this instance
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_clickValidator">clickValidator</a></h4>
<div class="detail">
<code>
void
<strong>clickValidator</strong>
(
e
)
</code>
<div class="description">
Method validates that the clicked element
was indeed the handle or a valid child of the handle
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;Event&gt;</code>
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_endDrag">endDrag</a></h4>
<div class="detail">
<code>
void
<strong>endDrag</strong>
(
e
)
</code>
<div class="description">
Fired when we are done dragging the object
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;Event&gt;</code>
the mouseup event
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getDragEl">getDragEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getDragEl</strong>
(
)
</code>
<div class="description">
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 YAHOO.util.DDProxy
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>the html element</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getEl">getEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getEl</strong>
(
)
</code>
<div class="description">
Returns a reference to the linked element
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>the html element</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_getTargetCoord">getTargetCoord</a></h4>
<div class="detail">
<code>
private
void
<strong>getTargetCoord</strong>
(
iPageX
,
iPageY
)
</code>
<div class="description">
Finds the location the element should be placed if we want to move
it to where the mouse location less the click offset would place us.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>iPageX &lt;int&gt;</code>
the X coordinate of the click
</dd>
<dd>
<code>iPageY &lt;int&gt;</code>
the Y coordinate of the click
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd>an object that contains the coordinates (Object.x and Object.y)</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_getTick">getTick</a></h4>
<div class="detail">
<code>
private
int
<strong>getTick</strong>
(
val
,
tickArray
)
</code>
<div class="description">
Normally the drag element is moved pixel by pixel, but we can specify
that it move a number of pixels at a time. This method resolves the
location when we have it set up like this.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>val &lt;int&gt;</code>
where we want to place the object
</dd>
<dd>
<code>tickArray &lt;int[]&gt;</code>
sorted array of valid points
</dd>
</dl>
<dl>
<dt>Returns:
<code>
int
</code></dt>
<dd>the closest tick</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_handleMouseDown">handleMouseDown</a></h4>
<div class="detail">
<code>
private
void
<strong>handleMouseDown</strong>
(
e
,
oDD
)
</code>
<div class="description">
Fired when this object is clicked
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;Event&gt;</code>
</dd>
<dd>
<code>oDD &lt;YAHOO.util.DragDrop&gt;</code>
the clicked dd object (this dd obj)
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_handleOnAvailable">handleOnAvailable</a></h4>
<div class="detail">
<code>
private
void
<strong>handleOnAvailable</strong>
(
)
</code>
<div class="description">
Executed when the linked element is available
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_init">init</a></h4>
<div class="detail">
<code>
void
<strong>init</strong>
(
id
,
sGroup
,
config
)
</code>
<div class="description">
Sets up the DragDrop object. Must be called in the constructor of any
YAHOO.util.DragDrop subclass
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>id &lt;object&gt;</code>
the id of the linked element
</dd>
<dd>
<code>sGroup &lt;String&gt;</code>
the group of related items
</dd>
<dd>
<code>config &lt;object&gt;</code>
configuration attributes
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_initTarget">initTarget</a></h4>
<div class="detail">
<code>
void
<strong>initTarget</strong>
(
id
,
sGroup
,
config
)
</code>
<div class="description">
Initializes Targeting functionality only... the object does not
get a mousedown handler.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>id &lt;object&gt;</code>
the id of the linked element
</dd>
<dd>
<code>sGroup &lt;String&gt;</code>
the group of related items
</dd>
<dd>
<code>config &lt;object&gt;</code>
configuration attributes
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_isLocked">isLocked</a></h4>
<div class="detail">
<code>
boolean
<strong>isLocked</strong>
(
)
</code>
<div class="description">
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>
<div class="description">
<dl>
<dt>Returns:
<code>
boolean
</code></dt>
<dd>true if this obj or all drag/drop is locked, else
false</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_isValidHandleChild">isValidHandleChild</a></h4>
<div class="detail">
<code>
boolean
<strong>isValidHandleChild</strong>
(
node
)
</code>
<div class="description">
Checks the tag exclusion list to see if this click should be ignored
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>node &lt;HTMLElement&gt;</code>
the HTMLElement to evaluate
</dd>
</dl>
<dl>
<dt>Returns:
<code>
boolean
</code></dt>
<dd>true if this is a valid tag type, false if not</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_lock">lock</a></h4>
<div class="detail">
<code>
void
<strong>lock</strong>
(
)
</code>
<div class="description">
Lock this instance
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_on">on</a></h4>
<div class="detail">
<code>
void
<strong>on</strong>
(
)
</code>
<div class="description">
Shortcut for EventProvider.subscribe, see <a href="YAHOO.util.EventProvider.html#subscribe">YAHOO.util.EventProvider.subscribe</a>
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onAvailable">onAvailable</a></h4>
<div class="detail">
<code>
void
<strong>onAvailable</strong>
(
)
</code>
<div class="description">
Override the onAvailable method to do what is needed after the initial
position was determined.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onDrag">onDrag</a></h4>
<div class="detail">
<code>
void
<strong>onDrag</strong>
(
e
)
</code>
<div class="description">
Abstract method called during the onMouseMove event while dragging an
object.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;Event&gt;</code>
the mousemove event
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onDragDrop">onDragDrop</a></h4>
<div class="detail">
<code>
void
<strong>onDragDrop</strong>
(
e
,
id
)
</code>
<div class="description">
Abstract method called when this item is dropped on another DragDrop
obj
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;Event&gt;</code>
the mouseup event
</dd>
<dd>
<code>id &lt;String|DragDrop[]&gt;</code>
In POINT mode, the element
id this was dropped on. In INTERSECT mode, an array of dd items this
was dropped on.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onDragEnter">onDragEnter</a></h4>
<div class="detail">
<code>
void
<strong>onDragEnter</strong>
(
e
,
id
)
</code>
<div class="description">
Abstract method called when this element fist begins hovering over
another DragDrop obj
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;Event&gt;</code>
the mousemove event
</dd>
<dd>
<code>id &lt;String|DragDrop[]&gt;</code>
In POINT mode, the element
id this is hovering over. In INTERSECT mode, an array of one or more
dragdrop items being hovered over.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onDragOut">onDragOut</a></h4>
<div class="detail">
<code>
void
<strong>onDragOut</strong>
(
e
,
id
)
</code>
<div class="description">
Abstract method called when we are no longer hovering over an element
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;Event&gt;</code>
the mousemove event
</dd>
<dd>
<code>id &lt;String|DragDrop[]&gt;</code>
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.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onDragOver">onDragOver</a></h4>
<div class="detail">
<code>
void
<strong>onDragOver</strong>
(
e
,
id
)
</code>
<div class="description">
Abstract method called when this element is hovering over another
DragDrop obj
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;Event&gt;</code>
the mousemove event
</dd>
<dd>
<code>id &lt;String|DragDrop[]&gt;</code>
In POINT mode, the element
id this is hovering over. In INTERSECT mode, an array of dd items
being hovered over.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onInvalidDrop">onInvalidDrop</a></h4>
<div class="detail">
<code>
void
<strong>onInvalidDrop</strong>
(
e
)
</code>
<div class="description">
Abstract method called when this item is dropped on an area with no
drop target
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;Event&gt;</code>
the mouseup event
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onMouseDown">onMouseDown</a></h4>
<div class="detail">
<code>
void
<strong>onMouseDown</strong>
(
e
)
</code>
<div class="description">
Event handler that fires when a drag/drop obj gets a mousedown
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;Event&gt;</code>
the mousedown event
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onMouseUp">onMouseUp</a></h4>
<div class="detail">
<code>
void
<strong>onMouseUp</strong>
(
e
)
</code>
<div class="description">
Event handler that fires when a drag/drop obj gets a mouseup
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;Event&gt;</code>
the mouseup event
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_removeFromGroup">removeFromGroup</a></h4>
<div class="detail">
<code>
void
<strong>removeFromGroup</strong>
(
sGroup
)
</code>
<div class="description">
Remove's this instance from the supplied interaction group
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sGroup &lt;string&gt;</code>
The group to drop
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_removeInvalidHandleClass">removeInvalidHandleClass</a></h4>
<div class="detail">
<code>
void
<strong>removeInvalidHandleClass</strong>
(
cssClass
)
</code>
<div class="description">
Unsets an invalid css class
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>cssClass &lt;string&gt;</code>
the class of the element(s) you wish to
re-enable
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_removeInvalidHandleId">removeInvalidHandleId</a></h4>
<div class="detail">
<code>
void
<strong>removeInvalidHandleId</strong>
(
id
)
</code>
<div class="description">
Unsets an invalid handle id
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>id &lt;string&gt;</code>
the id of the element to re-enable
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_removeInvalidHandleType">removeInvalidHandleType</a></h4>
<div class="detail">
<code>
void
<strong>removeInvalidHandleType</strong>
(
tagName
)
</code>
<div class="description">
Unsets an excluded tag name set by addInvalidHandleType
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>tagName &lt;string&gt;</code>
the type of element to unexclude
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_resetConstraints">resetConstraints</a></h4>
<div class="detail">
<code>
void
<strong>resetConstraints</strong>
(
)
</code>
<div class="description">
resetConstraints must be called if you manually reposition a dd element.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_setDragElId">setDragElId</a></h4>
<div class="detail">
<code>
void
<strong>setDragElId</strong>
(
id
)
</code>
<div class="description">
Allows you to specify that an element other than the linked element
will be moved with the cursor during a drag
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>id &lt;string&gt;</code>
the id of the element that will be used to initiate the drag
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_setHandleElId">setHandleElId</a></h4>
<div class="detail">
<code>
void
<strong>setHandleElId</strong>
(
id
)
</code>
<div class="description">
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>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>id &lt;string&gt;</code>
the id of the element that will be used to
initiate the drag.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_setInitialPosition">setInitialPosition</a></h4>
<div class="detail">
<code>
private
void
<strong>setInitialPosition</strong>
(
diffX
,
diffY
)
</code>
<div class="description">
Stores the initial placement of the linked element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>diffX &lt;int&gt;</code>
the X offset, default 0
</dd>
<dd>
<code>diffY &lt;int&gt;</code>
the Y offset, default 0
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_setOuterHandleElId">setOuterHandleElId</a></h4>
<div class="detail">
<code>
void
<strong>setOuterHandleElId</strong>
(
id
)
</code>
<div class="description">
Allows you to set an element outside of the linked element as a drag
handle
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>id &lt;object&gt;</code>
the id of the element that will be used to initiate the drag
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_setPadding">setPadding</a></h4>
<div class="detail">
<code>
void
<strong>setPadding</strong>
(
iTop
,
iRight
,
iBot
,
iLeft
)
</code>
<div class="description">
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>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>iTop &lt;int&gt;</code>
Top pad
</dd>
<dd>
<code>iRight &lt;int&gt;</code>
Right pad
</dd>
<dd>
<code>iBot &lt;int&gt;</code>
Bot pad
</dd>
<dd>
<code>iLeft &lt;int&gt;</code>
Left pad
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_setStartPosition">setStartPosition</a></h4>
<div class="detail">
<code>
private
void
<strong>setStartPosition</strong>
(
pos
)
</code>
<div class="description">
Sets the start position of the element. This is set when the obj
is initialized, the reset when a drag is started.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>pos &lt;object&gt;</code>
current position (from previous lookup)
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_setXConstraint">setXConstraint</a></h4>
<div class="detail">
<code>
void
<strong>setXConstraint</strong>
(
iLeft
,
iRight
,
iTickSize
)
</code>
<div class="description">
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>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>iLeft &lt;int&gt;</code>
the number of pixels the element can move to the left
</dd>
<dd>
<code>iRight &lt;int&gt;</code>
the number of pixels the element can move to the
right
</dd>
<dd>
<code>iTickSize &lt;int&gt;</code>
optional parameter for specifying that the
element
should move iTickSize pixels at a time.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_setXTicks">setXTicks</a></h4>
<div class="detail">
<code>
private
void
<strong>setXTicks</strong>
(
)
</code>
<div class="description">
Create the array of horizontal tick marks if an interval was specified
in setXConstraint().
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_setYConstraint">setYConstraint</a></h4>
<div class="detail">
<code>
void
<strong>setYConstraint</strong>
(
iUp
,
iDown
,
iTickSize
)
</code>
<div class="description">
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>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>iUp &lt;int&gt;</code>
the number of pixels the element can move up
</dd>
<dd>
<code>iDown &lt;int&gt;</code>
the number of pixels the element can move down
</dd>
<dd>
<code>iTickSize &lt;int&gt;</code>
optional parameter for specifying that the
element should move iTickSize pixels at a time.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_setYTicks">setYTicks</a></h4>
<div class="detail">
<code>
private
void
<strong>setYTicks</strong>
(
)
</code>
<div class="description">
Create the array of vertical tick marks if an interval was specified in
setYConstraint().
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_startDrag">startDrag</a></h4>
<div class="detail">
<code>
void
<strong>startDrag</strong>
(
X
,
Y
)
</code>
<div class="description">
Abstract method called after a drag/drop object is clicked
and the drag or mousedown time thresholds have beeen met.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>X &lt;int&gt;</code>
click location
</dd>
<dd>
<code>Y &lt;int&gt;</code>
click location
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_toString">toString</a></h4>
<div class="detail">
<code>
string
<strong>toString</strong>
(
)
</code>
<div class="description">
toString method
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
string
</code></dt>
<dd>string representation of the dd obj</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_unlock">unlock</a></h4>
<div class="detail">
<code>
void
<strong>unlock</strong>
(
)
</code>
<div class="description">
Unlock this instace
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_unreg">unreg</a></h4>
<div class="detail">
<code>
void
<strong>unreg</strong>
(
)
</code>
<div class="description">
Remove all drag and drop hooks for this element
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section method details">
<h3 id="events">Events</h3>
<div class="content">
<div class="">
<h4>
<a name="event_b4DragDropEvent">b4DragDropEvent</a></h4>
<div class="detail">
<code>
<strong>b4DragDropEvent</strong>
(
)
</code>
<div class="description">
Fires before the dragDropEvent
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_b4DragEvent">b4DragEvent</a></h4>
<div class="detail">
<code>
<strong>b4DragEvent</strong>
(
)
</code>
<div class="description">
Fires before the dragEvent.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_b4DragOutEvent">b4DragOutEvent</a></h4>
<div class="detail">
<code>
<strong>b4DragOutEvent</strong>
(
)
</code>
<div class="description">
Fires before the dragOutEvent
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_b4DragOverEvent">b4DragOverEvent</a></h4>
<div class="detail">
<code>
<strong>b4DragOverEvent</strong>
(
)
</code>
<div class="description">
Fires before the dragOverEvent.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_b4EndDragEvent">b4EndDragEvent</a></h4>
<div class="detail">
<code>
<strong>b4EndDragEvent</strong>
(
)
</code>
<div class="description">
Fires before the endDragEvent. Returning false will cancel.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_b4MouseDownEvent">b4MouseDownEvent</a></h4>
<div class="detail">
<code>
<strong>b4MouseDownEvent</strong>
(
)
</code>
<div class="description">
Provides access to the mousedown event, before the mouseDownEvent gets fired. Returning false will cancel the drag.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_b4StartDragEvent">b4StartDragEvent</a></h4>
<div class="detail">
<code>
<strong>b4StartDragEvent</strong>
(
)
</code>
<div class="description">
Fires before the startDragEvent, returning false will cancel the startDrag Event.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_dragDropEvent">dragDropEvent</a></h4>
<div class="detail">
<code>
<strong>dragDropEvent</strong>
(
)
</code>
<div class="description">
Fires when the dragged objects is dropped on another.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_dragEnterEvent">dragEnterEvent</a></h4>
<div class="detail">
<code>
<strong>dragEnterEvent</strong>
(
)
</code>
<div class="description">
Occurs when the dragged object first interacts with another targettable drag and drop object.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_dragEvent">dragEvent</a></h4>
<div class="detail">
<code>
<strong>dragEvent</strong>
(
)
</code>
<div class="description">
Occurs every mousemove event while dragging.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_dragOutEvent">dragOutEvent</a></h4>
<div class="detail">
<code>
<strong>dragOutEvent</strong>
(
)
</code>
<div class="description">
Fires when a dragged object is no longer over an object that had the onDragEnter fire.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_dragOverEvent">dragOverEvent</a></h4>
<div class="detail">
<code>
<strong>dragOverEvent</strong>
(
)
</code>
<div class="description">
Fires every mousemove event while over a drag and drop object.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_endDragEvent">endDragEvent</a></h4>
<div class="detail">
<code>
<strong>endDragEvent</strong>
(
)
</code>
<div class="description">
Fires on the mouseup event after a drag has been initiated (startDrag fired).
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_invalidDropEvent">invalidDropEvent</a></h4>
<div class="detail">
<code>
<strong>invalidDropEvent</strong>
(
)
</code>
<div class="description">
Fires when the dragged objects is dropped in a location that contains no drop targets.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_mouseDownEvent">mouseDownEvent</a></h4>
<div class="detail">
<code>
<strong>mouseDownEvent</strong>
(
)
</code>
<div class="description">
Provides access to the mousedown event. The mousedown does not always result in a drag operation.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_mouseUpEvent">mouseUpEvent</a></h4>
<div class="detail">
<code>
<strong>mouseUpEvent</strong>
(
)
</code>
<div class="description">
Fired from inside DragDropMgr when the drag operation is finished.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_startDragEvent">startDragEvent</a></h4>
<div class="detail">
<code>
<strong>startDragEvent</strong>
(
)
</code>
<div class="description">
Occurs after a mouse down and the drag threshold has been met. The drag threshold default is either 3 pixels of mouse movement or 1 full second of holding the mousedown.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
</div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_animation.html">animation</a></li>
<li class=""><a href="module_autocomplete.html">autocomplete</a></li>
<li class=""><a href="module_button.html">button</a></li>
<li class=""><a href="module_calendar.html">calendar</a></li>
<li class=""><a href="module_charts.html">charts</a></li>
<li class=""><a href="module_colorpicker.html">colorpicker</a></li>
<li class=""><a href="module_connection.html">connection</a></li>
<li class=""><a href="module_container.html">container</a></li>
<li class=""><a href="module_cookie.html">cookie</a></li>
<li class=""><a href="module_datasource.html">datasource</a></li>
<li class=""><a href="module_datatable.html">datatable</a></li>
<li class=""><a href="module_dom.html">dom</a></li>
<li class="selected"><a href="module_dragdrop.html">dragdrop</a></li>
<li class=""><a href="module_editor.html">editor</a></li>
<li class=""><a href="module_element.html">element</a></li>
<li class=""><a href="module_event.html">event</a></li>
<li class=""><a href="module_get.html">get</a></li>
<li class=""><a href="module_history.html">history</a></li>
<li class=""><a href="module_imagecropper.html">imagecropper</a></li>
<li class=""><a href="module_imageloader.html">imageloader</a></li>
<li class=""><a href="module_json.html">json</a></li>
<li class=""><a href="module_layout.html">layout</a></li>
<li class=""><a href="module_logger.html">logger</a></li>
<li class=""><a href="module_menu.html">menu</a></li>
<li class=""><a href="module_profiler.html">profiler</a></li>
<li class=""><a href="module_profilerviewer.html">profilerviewer</a></li>
<li class=""><a href="module_resize.html">resize</a></li>
<li class=""><a href="module_selector.html">selector</a></li>
<li class=""><a href="module_slider.html">slider</a></li>
<li class=""><a href="module_tabview.html">tabview</a></li>
<li class=""><a href="module_treeview.html">treeview</a></li>
<li class=""><a href="module_uploader.html">uploader</a></li>
<li class=""><a href="module_yahoo.html">yahoo</a></li>
<li class=""><a href="module_yuiloader.html">yuiloader</a></li>
<li class=""><a href="module_yuitest.html">yuitest</a></li>
</ul>
</div>
<div class="module">
<h4>Classes</h4>
<ul class="content">
<li class=""><a href="YAHOO.util.DD.html">YAHOO.util.DD</a></li>
<li class=""><a href="YAHOO.util.DDProxy.html">YAHOO.util.DDProxy</a></li>
<li class=""><a href="YAHOO.util.DDTarget.html">YAHOO.util.DDTarget</a></li>
<li class="selected"><a href="YAHOO.util.DragDrop.html">YAHOO.util.DragDrop</a></li>
<li class=""><a href="YAHOO.util.DragDropMgr.html">YAHOO.util.DragDropMgr</a></li>
<li class=""><a href="YAHOO.util.DragDropMgr.ElementWrapper.html">YAHOO.util.DragDropMgr.ElementWrapper</a></li>
</ul>
</div>
<div class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="DD.js.html">DD.js</a></li>
<li class=""><a href="DDProxy.js.html">DDProxy.js</a></li>
<li class=""><a href="DDTarget.js.html">DDTarget.js</a></li>
<li class=""><a href="DragDrop.js.html">DragDrop.js</a></li>
<li class=""><a href="DragDropMgr.js.html">DragDropMgr.js</a></li>
</ul>
</div>
<div class="module">
<h4>Properties</h4>
<ul class="content">
<li class="private"><a href="#property___ygDragDrop">__ygDragDrop</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class="private"><a href="#property__domRef">_domRef</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class=""><a href="#property_available">available</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class=""><a href="#property_config">config</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class="private"><a href="#property_constrainX">constrainX</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class="private"><a href="#property_constrainY">constrainY</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class=""><a href="#property_cursorIsOver">cursorIsOver</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class="private"><a href="#property_deltaX">deltaX</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class="private"><a href="#property_deltaY">deltaY</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class="private"><a href="#property_dragElId">dragElId</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class=""><a href="#property_dragOnly">dragOnly</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class=""><a href="#property_events">events</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class=""><a href="#property_groups">groups</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class="private"><a href="#property_handleElId">handleElId</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class=""><a href="#property_hasOuterHandles">hasOuterHandles</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class=""><a href="#property_id">id</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class=""><a href="#property_invalidHandleClasses">invalidHandleClasses</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class=""><a href="#property_invalidHandleIds">invalidHandleIds</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class=""><a href="#property_invalidHandleTypes">invalidHandleTypes</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class=""><a href="#property_isTarget">isTarget</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class="private"><a href="#property_locked">locked</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class=""><a href="#property_maintainOffset">maintainOffset</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class="private"><a href="#property_maxX">maxX</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class="private"><a href="#property_maxY">maxY</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class="private"><a href="#property_minX">minX</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class="private"><a href="#property_minY">minY</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class=""><a href="#property_overlap">overlap</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class=""><a href="#property_padding">padding</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class=""><a href="#property_primaryButtonOnly">primaryButtonOnly</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class="private"><a href="#property_startPageX">startPageX</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class="private"><a href="#property_startPageY">startPageY</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class=""><a href="#property_xTicks">xTicks</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
<li class=""><a href="#property_yTicks">yTicks</a>
<!--<code>&lt;int[]&gt;</code>-->
</li>
</ul>
</div>
<div class="module">
<h4>Methods</h4>
<ul class="content">
<li class=""><!--<code>void</code>-->
<a href="#method_addInvalidHandleClass">addInvalidHandleClass</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_addInvalidHandleId">addInvalidHandleId</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_addInvalidHandleType">addInvalidHandleType</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_addToGroup">addToGroup</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_applyConfig">applyConfig</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_b4Drag">b4Drag</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_b4DragDrop">b4DragDrop</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_b4DragOut">b4DragOut</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_b4DragOver">b4DragOver</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_b4EndDrag">b4EndDrag</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_b4MouseDown">b4MouseDown</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_b4StartDrag">b4StartDrag</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_clearConstraints">clearConstraints</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_clearTicks">clearTicks</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_clickValidator">clickValidator</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_endDrag">endDrag</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getDragEl">getDragEl</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getEl">getEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_getTargetCoord">getTargetCoord</a>
</li>
<li class="private"><!--<code>int</code>-->
<a href="#method_getTick">getTick</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_handleMouseDown">handleMouseDown</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_handleOnAvailable">handleOnAvailable</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_init">init</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_initTarget">initTarget</a>
</li>
<li class=""><!--<code>boolean</code>-->
<a href="#method_isLocked">isLocked</a>
</li>
<li class=""><!--<code>boolean</code>-->
<a href="#method_isValidHandleChild">isValidHandleChild</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_lock">lock</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_on">on</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onAvailable">onAvailable</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onDrag">onDrag</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onDragDrop">onDragDrop</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onDragEnter">onDragEnter</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onDragOut">onDragOut</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onDragOver">onDragOver</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onInvalidDrop">onInvalidDrop</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onMouseDown">onMouseDown</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onMouseUp">onMouseUp</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_removeFromGroup">removeFromGroup</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_removeInvalidHandleClass">removeInvalidHandleClass</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_removeInvalidHandleId">removeInvalidHandleId</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_removeInvalidHandleType">removeInvalidHandleType</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_resetConstraints">resetConstraints</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_setDragElId">setDragElId</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_setHandleElId">setHandleElId</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_setInitialPosition">setInitialPosition</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_setOuterHandleElId">setOuterHandleElId</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_setPadding">setPadding</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_setStartPosition">setStartPosition</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_setXConstraint">setXConstraint</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_setXTicks">setXTicks</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_setYConstraint">setYConstraint</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_setYTicks">setYTicks</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_startDrag">startDrag</a>
</li>
<li class=""><!--<code>string</code>-->
<a href="#method_toString">toString</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_unlock">unlock</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_unreg">unreg</a>
</li>
</ul>
</div>
<div class="module">
<h4>Events</h4>
<ul class="content">
<li class="">
<a href="#event_b4DragDropEvent">b4DragDropEvent</a>
</li>
<li class="">
<a href="#event_b4DragEvent">b4DragEvent</a>
</li>
<li class="">
<a href="#event_b4DragOutEvent">b4DragOutEvent</a>
</li>
<li class="">
<a href="#event_b4DragOverEvent">b4DragOverEvent</a>
</li>
<li class="">
<a href="#event_b4EndDragEvent">b4EndDragEvent</a>
</li>
<li class="">
<a href="#event_b4MouseDownEvent">b4MouseDownEvent</a>
</li>
<li class="">
<a href="#event_b4StartDragEvent">b4StartDragEvent</a>
</li>
<li class="">
<a href="#event_dragDropEvent">dragDropEvent</a>
</li>
<li class="">
<a href="#event_dragEnterEvent">dragEnterEvent</a>
</li>
<li class="">
<a href="#event_dragEvent">dragEvent</a>
</li>
<li class="">
<a href="#event_dragOutEvent">dragOutEvent</a>
</li>
<li class="">
<a href="#event_dragOverEvent">dragOverEvent</a>
</li>
<li class="">
<a href="#event_endDragEvent">endDragEvent</a>
</li>
<li class="">
<a href="#event_invalidDropEvent">invalidDropEvent</a>
</li>
<li class="">
<a href="#event_mouseDownEvent">mouseDownEvent</a>
</li>
<li class="">
<a href="#event_mouseUpEvent">mouseUpEvent</a>
</li>
<li class="">
<a href="#event_startDragEvent">startDragEvent</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2007 Yahoo! Inc. All rights reserved.
</div>
</div>
</body>
</html>