DragPlugin.html revision 4fcbec6145d16637205990699912fb90f6a3807c
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>API: dd-plugin DragPlugin (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>dd-plugin&nbsp; <span class="subtitle">3.00PR1</span></h3>
<p>
<a href="/index.html">Yahoo! UI Library</a>
&gt; <a href="/module_dd-plugin.html">dd-plugin</a>
&gt; DragPlugin
</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" /> <label for="showprivate">Show Private</label></span>
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> <label for="showprotected">Show Protected</label></span>
<span id="classopts"><input type="checkbox" name="showdeprecated" id="showdeprecated" /> <label for="showdeprecated">Show Deprecated</label></span>
</form>
<h2>
Class <b>DragPlugin</b>
<span class="extends">
- extends <a href="Drag.html">Drag</a>
</span>
<span class="extends">
</span>
</code>
</h2>
<!-- class tree goes here -->
<div class="summary description">
This is a simple Drag plugin that can be attached to a Node via the plug method.
</div>
<div class="section constructor details">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong>DragPlugin</strong>
<code>
(
)
</code>
<div class="description">
</div>
</div>
</div>
</div>
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="">
<h4><a name="property_NAME">NAME</a>
<code>- {String}</code>
</h4>
<div class="detail">
<div class="description">
dd-plugin
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_NS">NS</a>
<code>- {String}</code>
</h4>
<div class="detail">
<div class="description">
The Drag instance will be placed on the Node instance under the dd namespace. It can be accessed via Node.dd;
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Properties inherited from <a href="Attribute.html">Attribute</a>:</h4>
<div class="content">
<code>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Properties inherited from <a href="Drag.html">Drag</a>:</h4>
<div class="content">
<code>
<a class="private" href="Drag.html#property__clickTimeout">_clickTimeout</a><span class="private">,</span>
<a class="private" href="Drag.html#property__dragThreshMet">_dragThreshMet</a><span class="private">,</span>
<a class="private" href="Drag.html#property__endTime">_endTime</a><span class="private">,</span>
<a class="private" href="Drag.html#property__ev_md">_ev_md</a><span class="private">,</span>
<a class="private" href="Drag.html#property__fromTimeout">_fromTimeout</a><span class="private">,</span>
<a class="private" href="Drag.html#property__groups">_groups</a><span class="private">,</span>
<a class="private" href="Drag.html#property__handles">_handles</a><span class="private">,</span>
<a class="private" href="Drag.html#property__ieSelectBack">_ieSelectBack</a><span class="private">,</span>
<a class="private" href="Drag.html#property__invalids">_invalids</a><span class="private">,</span>
<a class="private" href="Drag.html#property__invalidsDefault">_invalidsDefault</a><span class="private">,</span>
<a class="private" href="Drag.html#property__startTime">_startTime</a><span class="private">,</span>
<a class="" href="Drag.html#property_deltaXY">deltaXY</a><span class="">,</span>
<a class="" href="Drag.html#property_lastXY">lastXY</a><span class="">,</span>
<a class="" href="Drag.html#property_mouseXY">mouseXY</a><span class="">,</span>
<a class="" href="Drag.html#property_nodeXY">nodeXY</a><span class="">,</span>
<a class="" href="Drag.html#property_region">region</a><span class="">,</span>
<a class="" href="Drag.html#property_startXY">startXY</a><span class="">,</span>
<a class="" href="Drag.html#property_target">target</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Properties inherited from <a href="Base.html">Base</a>:</h4>
<div class="content">
<code>
<a class="" href="Base.html#property_name">name</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="Attribute.html">Attribute</a>:</h4>
<div class="content">
<code>
<a class="private" href="Attribute.html#method__cloneAttVal">_cloneAttVal</a><span class="private">,</span> <a class="private" href="Attribute.html#method__defAttSet">_defAttSet</a><span class="private">,</span> <a class="private" href="Attribute.html#method__fireAttChange">_fireAttChange</a><span class="private">,</span> <a class="private" href="Attribute.html#method__getSubAttVal">_getSubAttVal</a><span class="private">,</span> <a class="protected" href="Attribute.html#method__initAtts">_initAtts</a><span class="protected">,</span> <a class="private" href="Attribute.html#method__initAttVal">_initAttVal</a><span class="private">,</span> <a class="private" href="Attribute.html#method__setSubAttVal">_setSubAttVal</a><span class="private">,</span> <a class="private" href="Attribute.html#method__splitAttrValues">_splitAttrValues</a><span class="private">,</span> <a class="" href="Attribute.html#method_addAtt">addAtt</a><span class="">,</span> <a class="" href="Attribute.html#method_get">get</a><span class="">,</span> <a class="" href="Attribute.html#method_getAtts">getAtts</a><span class="">,</span> <a class="" href="Attribute.html#method_on">on</a><span class="">,</span> <a class="" href="Attribute.html#method_removeAtt">removeAtt</a><span class="">,</span> <a class="" href="Attribute.html#method_set">set</a><span class="">,</span> <a class="" href="Attribute.html#method_setAtts">setAtts</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="Drag.html">Drag</a>:</h4>
<div class="content">
<code>
<a class="private" href="Drag.html#method__align">_align</a><span class="private">,</span> <a class="private" href="Drag.html#method__createEvents">_createEvents</a><span class="private">,</span> <a class="private" href="Drag.html#method__fixIEMouseDown">_fixIEMouseDown</a><span class="private">,</span> <a class="private" href="Drag.html#method__fixIEMouseUp">_fixIEMouseUp</a><span class="private">,</span> <a class="private" href="Drag.html#method__handleMouseDown">_handleMouseDown</a><span class="private">,</span> <a class="private" href="Drag.html#method__handleMouseDownEvent">_handleMouseDownEvent</a><span class="private">,</span> <a class="private" href="Drag.html#method__handleMouseUp">_handleMouseUp</a><span class="private">,</span> <a class="private" href="Drag.html#method__handleTarget">_handleTarget</a><span class="private">,</span> <a class="private" href="Drag.html#method__ieSelectFix">_ieSelectFix</a><span class="private">,</span> <a class="private" href="Drag.html#method__move">_move</a><span class="private">,</span> <a class="private" href="Drag.html#method__moveNode">_moveNode</a><span class="private">,</span> <a class="private" href="Drag.html#method__prep">_prep</a><span class="private">,</span> <a class="private" href="Drag.html#method__setStartPosition">_setStartPosition</a><span class="private">,</span> <a class="private" href="Drag.html#method__timeoutCheck">_timeoutCheck</a><span class="private">,</span> <a class="private" href="Drag.html#method__unprep">_unprep</a><span class="private">,</span> <a class="" href="Drag.html#method_addHandle">addHandle</a><span class="">,</span> <a class="" href="Drag.html#method_addInvalid">addInvalid</a><span class="">,</span> <a class="" href="Drag.html#method_addToGroup">addToGroup</a><span class="">,</span> <a class="private" href="Drag.html#method_destructor">destructor</a><span class="private">,</span> <a class="" href="Drag.html#method_end">end</a><span class="">,</span> <a class="private" href="Drag.html#method_initializer">initializer</a><span class="private">,</span> <a class="" href="Drag.html#method_removeFromGroup">removeFromGroup</a><span class="">,</span> <a class="" href="Drag.html#method_removeHandle">removeHandle</a><span class="">,</span> <a class="" href="Drag.html#method_removeInvalid">removeInvalid</a><span class="">,</span> <a class="" href="Drag.html#method_start">start</a><span class="">,</span> <a class="" href="Drag.html#method_stopDrag">stopDrag</a><span class="">,</span> <a class="" href="Drag.html#method_validClick">validClick</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="Base.html">Base</a>:</h4>
<div class="content">
<code>
<a class="protected" href="Base.html#method__defDestroyFn">_defDestroyFn</a><span class="protected">,</span> <a class="protected" href="Base.html#method__defInitFn">_defInitFn</a><span class="protected">,</span> <a class="private" href="Base.html#method__destroyHierarchy">_destroyHierarchy</a><span class="private">,</span> <a class="protected" href="Base.html#method__getClasses">_getClasses</a><span class="protected">,</span> <a class="private" href="Base.html#method__initHierarchy">_initHierarchy</a><span class="private">,</span> <a class="private" href="Base.html#method__prefixEvtType">_prefixEvtType</a><span class="private">,</span> <a class="" href="Base.html#method_after">after</a><span class="">,</span> <a class="" href="Base.html#method_destroy">destroy</a><span class="">,</span> <a class="" href="Base.html#method_fire">fire</a><span class="">,</span> <a class="" href="Base.html#method_init">init</a><span class="">,</span> <a class="" href="Base.html#method_publish">publish</a><span class="">,</span> <a class="" href="Base.html#method_subscribe">subscribe</a><span class="">,</span> <a class="" href="Base.html#method_toString">toString</a><span class="">,</span> <a class="" href="Base.html#method_unsubscribe">unsubscribe</a><span class="">,</span> <a class="" href="Base.html#method_unsubscribeAll">unsubscribeAll</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="Event.Target.html">Event.Target</a>:</h4>
<div class="content">
<code>
<a class="" href="Event.Target.html#method_addTarget">addTarget</a><span class="">,</span> <a class="" href="Event.Target.html#method_after">after</a><span class="">,</span> <a class="" href="Event.Target.html#method_bubble">bubble</a><span class="">,</span> <a class="" href="Event.Target.html#method_fire">fire</a><span class="">,</span> <a class="" href="Event.Target.html#method_getEvent">getEvent</a><span class="">,</span> <a class="" href="Event.Target.html#method_publish">publish</a><span class="">,</span> <a class="" href="Event.Target.html#method_ready">ready</a><span class="">,</span> <a class="" href="Event.Target.html#method_removeTarget">removeTarget</a><span class="">,</span> <a class="" href="Event.Target.html#method_subscribe">subscribe</a><span class="">,</span> <a class="" href="Event.Target.html#method_unsubscribe">unsubscribe</a><span class="">,</span> <a class="" href="Event.Target.html#method_unsubscribeAll">unsubscribeAll</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Events inherited from <a href="Drag.html">Drag</a>:</h4>
<div class="content">
<code>
<a class="" href="Drag.html#event_activeHandleChange">activeHandleChange</a><span class="">,</span> <a class="" href="Drag.html#event_clickPixelThreshChange">clickPixelThreshChange</a><span class="">,</span> <a class="" href="Drag.html#event_clickTimeThreshChange">clickTimeThreshChange</a><span class="">,</span> <a class="" href="Drag.html#event_dataChange">dataChange</a><span class="">,</span> <a class="" href="Drag.html#event_drag:addHandle">drag:addHandle</a><span class="">,</span> <a class="" href="Drag.html#event_drag:addInvalid">drag:addInvalid</a><span class="">,</span> <a class="" href="Drag.html#event_drag:afterMouseDown">drag:afterMouseDown</a><span class="">,</span> <a class="" href="Drag.html#event_drag:drag">drag:drag</a><span class="">,</span> <a class="" href="Drag.html#event_drag:drophit">drag:drophit</a><span class="">,</span> <a class="" href="Drag.html#event_drag:dropmiss">drag:dropmiss</a><span class="">,</span> <a class="" href="Drag.html#event_drag:end">drag:end</a><span class="">,</span> <a class="" href="Drag.html#event_drag:enter">drag:enter</a><span class="">,</span> <a class="" href="Drag.html#event_drag:exit">drag:exit</a><span class="">,</span> <a class="" href="Drag.html#event_drag:mouseDown">drag:mouseDown</a> <a class="" href="Drag.html#event_drag:over">drag:over</a> <a class="" href="Drag.html#event_drag:removeHandle">drag:removeHandle</a> <a class="" href="Drag.html#event_drag:removeInvalid">drag:removeInvalid</a> <a class="" href="Drag.html#event_drag:start">drag:start</a> <a class="" href="Drag.html#event_draggingChange">draggingChange</a> <a class="" href="Drag.html#event_dragModeChange">dragModeChange</a> <a class="" href="Drag.html#event_dragNodeChange">dragNodeChange</a> <a class="" href="Drag.html#event_groupsChange">groupsChange</a> <a class="" href="Drag.html#event_handlesChange">handlesChange</a> <a class="" href="Drag.html#event_lockChange">lockChange</a> <a class="" href="Drag.html#event_moveChange">moveChange</a> <a class="" href="Drag.html#event_nodeChange">nodeChange</a> <a class="" href="Drag.html#event_offsetNodeChange">offsetNodeChange</a> <a class="" href="Drag.html#event_primaryButtonOnlyChange">primaryButtonOnlyChange</a> <a class="" href="Drag.html#event_targetChange">targetChange</a> <a class="" href="Drag.html#event_useShimChange">useShimChange</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Events inherited from <a href="Base.html">Base</a>:</h4>
<div class="content">
<code>
<a class="" href="Base.html#event_destroy">destroy</a><span class="">,</span> <a class="" href="Base.html#event_destroyedChange">destroyedChange</a><span class="">,</span> <a class="" href="Base.html#event_init">init</a><span class="">,</span> <a class="" href="Base.html#event_initializedChange">initializedChange</a><span class="">,</span>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Configuration attributes inherited from <a href="Drag.html">Drag</a>:</h4>
<div class="content">
<code>
<a class="" href="Drag.html#config_activeHandle">activeHandle</a><span class="">,</span> <a class="" href="Drag.html#config_clickPixelThresh">clickPixelThresh</a><span class="">,</span> <a class="" href="Drag.html#config_clickTimeThresh">clickTimeThresh</a><span class="">,</span> <a class="" href="Drag.html#config_data">data</a><span class="">,</span> <a class="" href="Drag.html#config_dragging">dragging</a><span class="">,</span> <a class="" href="Drag.html#config_dragMode">dragMode</a><span class="">,</span> <a class="" href="Drag.html#config_dragNode">dragNode</a><span class="">,</span> <a class="" href="Drag.html#config_groups">groups</a><span class="">,</span> <a class="" href="Drag.html#config_handles">handles</a><span class="">,</span> <a class="" href="Drag.html#config_lock">lock</a><span class="">,</span> <a class="" href="Drag.html#config_move">move</a><span class="">,</span> <a class="" href="Drag.html#config_node">node</a><span class="">,</span> <a class="" href="Drag.html#config_offsetNode">offsetNode</a><span class="">,</span> <a class="" href="Drag.html#config_primaryButtonOnly">primaryButtonOnly</a> <a class="" href="Drag.html#config_target">target</a> <a class="" href="Drag.html#config_useShim">useShim</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Configuration attributes inherited from <a href="Base.html">Base</a>:</h4>
<div class="content">
<code>
<a class="" href="Base.html#config_destroyed">destroyed</a><span class="">,</span> <a class="" href="Base.html#config_initialized">initialized</a><span class="">,</span>
</code>
</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_anim.html">anim</a></li>
<li class=""><a href="module_attribute.html">attribute</a></li>
<li class=""><a href="module_base.html">base</a></li>
<li class=""><a href="module_dd.html">dd</a></li>
<li class="selected"><a href="module_dd-plugin.html">dd-plugin</a></li>
<li class=""><a href="module_dump.html">dump</a></li>
<li class=""><a href="module_event.html">event</a></li>
<li class=""><a href="module_io.html">io</a></li>
<li class=""><a href="module_node.html">node</a></li>
<li class=""><a href="module_oop.html">oop</a></li>
<li class=""><a href="module_queue.html">queue</a></li>
<li class=""><a href="module_substitute.html">substitute</a></li>
<li class=""><a href="module_yui.html">yui</a></li>
</ul>
</div>
<div class="module">
<h4>Classes</h4>
<ul class="content">
<li class="selected"><a href="DragPlugin.html">DragPlugin</a></li>
<li class=""><a href="DropPlugin.html">DropPlugin</a></li>
</ul>
</div>
<div class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="dd-drop-plugin.js.html">dd-drop-plugin.js</a></li>
<li class=""><a href="dd-plugin.js.html">dd-plugin.js</a></li>
</ul>
</div>
<div class="module">
<h4>Properties</h4>
<ul class="content">
<li class=""><a href="#property_NAME">NAME</a>
<!--<code>&lt;{String}&gt;</code>-->
</li>
<li class=""><a href="#property_NS">NS</a>
<!--<code>&lt;{String}&gt;</code>-->
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2008 Yahoo! Inc. All rights reserved.
</div>
</div>
</body>
</html>