Proxy.html revision 4fcbec6145d16637205990699912fb90f6a3807c
<html>
<head>
<title>API: dd Proxy (YUI Library)</title>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<h3>dd <span class="subtitle">3.00PR1</span></h3>
<p>
> Proxy
</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>Proxy</b>
<span class="extends">
</span>
<span class="extends">
</span>
</code>
</h2>
<!-- class tree goes here -->
<div class="summary description">
This class extends dd-drag to allow for creating a proxy drag node, instead of dragging the original node.
</div>
<div class="section constructor details">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong>Proxy</strong>
<code>
(
)
</code>
<div class="description">
</div>
</div>
</div>
</div>
<div class="section field inheritance">
<div class="content">
<code>
</code>
</div>
</div>
<div class="section field inheritance">
<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__fromTimeout">_fromTimeout</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__invalidsDefault">_invalidsDefault</a><span class="private">,</span>
<a class="private" href="Drag.html#property__startTime">_startTime</a><span class="private">,</span>
</code>
</div>
</div>
<div class="section field inheritance">
<div class="content">
<code>
</code>
</div>
</div>
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="private">
<h4>
<a name="method__createFrame">_createFrame</a></h4>
<div class="detail">
<code>
private
void
<strong>_createFrame</strong>
(
)
</code>
<div class="description">
Create the proxy element if it doesn't already exist and set the DD.DDM._proxy value
</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__setFrame">_setFrame</a></h4>
<div class="detail">
<code>
private
void
<strong>_setFrame</strong>
(
)
</code>
<div class="description">
If resizeProxy is set to true (default) it will resize the proxy element to match the size of the Drag Element.
If positionProxy is set to true (default) it will position the proxy element in the same location as the Drag 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_end">end</a></h4>
<div class="detail">
<code>
void
<strong>end</strong>
(
)
</code>
<div class="description">
Ends the drag operation, if moveOnEnd is set it will position the Drag Element to the new location of the proxy.
</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_initializer">initializer</a></h4>
<div class="detail">
<code>
private
void
<strong>initializer</strong>
(
)
</code>
<div class="description">
Lifecycle method
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_start">start</a></h4>
<div class="detail">
<code>
void
<strong>start</strong>
(
)
</code>
<div class="description">
Starts the drag operation and sets the dragNode config option.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<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">
<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">
<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">
<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 method details">
<h3 id="events">Events</h3>
<div class="content">
<div class="">
<h4>
<a name="event_borderStyleChange">borderStyleChange</a></h4>
<div class="detail">
<code>
<strong>borderStyleChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'borderStyle' is changed. You can listen for the event using the <a href="Attribute.html#method_on>on</a> method if you wish to be notified before the attribute's value has changed, or using the <a href="Event.Target.html#method_after>after</a> method if you wish to be notified after the attribute's value has changed.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
An Event Facade object with the following attribute specific properties added: <dl> <dt>prevVal</dt> <dd>The value of the attribute, prior to it being set</dd> <dt>newVal</dt> <dd>The value the attribute is to be set to</dd> <dt>attrName</dt> <dd>The name of the attribute being set</dd> <dt>subAttrName</dt> <dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</dd> </dl>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_moveOnEndChange">moveOnEndChange</a></h4>
<div class="detail">
<code>
<strong>moveOnEndChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'moveOnEnd' is changed. You can listen for the event using the <a href="Attribute.html#method_on>on</a> method if you wish to be notified before the attribute's value has changed, or using the <a href="Event.Target.html#method_after>after</a> method if you wish to be notified after the attribute's value has changed.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
An Event Facade object with the following attribute specific properties added: <dl> <dt>prevVal</dt> <dd>The value of the attribute, prior to it being set</dd> <dt>newVal</dt> <dd>The value the attribute is to be set to</dd> <dt>attrName</dt> <dd>The name of the attribute being set</dd> <dt>subAttrName</dt> <dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</dd> </dl>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_positionProxyChange">positionProxyChange</a></h4>
<div class="detail">
<code>
<strong>positionProxyChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'positionProxy' is changed. You can listen for the event using the <a href="Attribute.html#method_on>on</a> method if you wish to be notified before the attribute's value has changed, or using the <a href="Event.Target.html#method_after>after</a> method if you wish to be notified after the attribute's value has changed.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
An Event Facade object with the following attribute specific properties added: <dl> <dt>prevVal</dt> <dd>The value of the attribute, prior to it being set</dd> <dt>newVal</dt> <dd>The value the attribute is to be set to</dd> <dt>attrName</dt> <dd>The name of the attribute being set</dd> <dt>subAttrName</dt> <dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</dd> </dl>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_proxyChange">proxyChange</a></h4>
<div class="detail">
<code>
<strong>proxyChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'proxy' is changed. You can listen for the event using the <a href="Attribute.html#method_on>on</a> method if you wish to be notified before the attribute's value has changed, or using the <a href="Event.Target.html#method_after>after</a> method if you wish to be notified after the attribute's value has changed.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
An Event Facade object with the following attribute specific properties added: <dl> <dt>prevVal</dt> <dd>The value of the attribute, prior to it being set</dd> <dt>newVal</dt> <dd>The value the attribute is to be set to</dd> <dt>attrName</dt> <dd>The name of the attribute being set</dd> <dt>subAttrName</dt> <dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</dd> </dl>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_resizeFrameChange">resizeFrameChange</a></h4>
<div class="detail">
<code>
<strong>resizeFrameChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'resizeFrame' is changed. You can listen for the event using the <a href="Attribute.html#method_on>on</a> method if you wish to be notified before the attribute's value has changed, or using the <a href="Event.Target.html#method_after>after</a> method if you wish to be notified after the attribute's value has changed.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
An Event Facade object with the following attribute specific properties added: <dl> <dt>prevVal</dt> <dd>The value of the attribute, prior to it being set</dd> <dt>newVal</dt> <dd>The value the attribute is to be set to</dd> <dt>attrName</dt> <dd>The name of the attribute being set</dd> <dt>subAttrName</dt> <dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</dd> </dl>
</dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<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">
<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 details">
<h3 id="configattributes">Configuration Attributes</h3>
<div class="content">
<div class="">
<h4><a name="config_borderStyle">borderStyle</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
The default border style for the border of the proxy. Default: 1px solid #808080
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="config_moveOnEnd">moveOnEnd</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
Move the original node at the end of the drag. Default: true
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="config_positionProxy">positionProxy</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
Make the Proxy node appear in the same place as the original node. Default: true
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="config_proxy">proxy</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
Make this Draggable instance a Proxy instance. Default: false
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="config_resizeFrame">resizeFrame</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
Make the Proxy node assume the size of the original node. Default: true
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<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">
<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">
</ul>
</div>
<div class="module">
<h4>Classes</h4>
<ul class="content">
</ul>
</div>
<div class="module">
<h4>Files</h4>
<ul class="content">
</ul>
</div>
<div class="module">
<h4>Methods</h4>
<ul class="content">
<li class="private"><!--<code>void</code>-->
<a href="#method__createFrame">_createFrame</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__setFrame">_setFrame</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_end">end</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_initializer">initializer</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_start">start</a>
</li>
</ul>
</div>
<div class="module">
<h4>Events</h4>
<ul class="content">
<li class="">
<a href="#event_borderStyleChange">borderStyleChange</a>
</li>
<li class="">
<a href="#event_moveOnEndChange">moveOnEndChange</a>
</li>
<li class="">
<a href="#event_positionProxyChange">positionProxyChange</a>
</li>
<li class="">
<a href="#event_proxyChange">proxyChange</a>
</li>
<li class="">
<a href="#event_resizeFrameChange">resizeFrameChange</a>
</li>
</ul>
</div>
<div class="module">
<h4>Configuration Attributes</h4>
<ul class="content">
<li class="">
<a href="#config_borderStyle">borderStyle</a>
</li>
<li class="">
<a href="#config_moveOnEnd">moveOnEnd</a>
</li>
<li class="">
<a href="#config_positionProxy">positionProxy</a>
</li>
<li class="">
<a href="#config_proxy">proxy</a>
</li>
<li class="">
<a href="#config_resizeFrame">resizeFrame</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright © 2008 Yahoo! Inc. All rights reserved.
</div>
</div>
</body>
</html>