537 lines
30 KiB
HTML
537 lines
30 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.DDProxy (YUI Library)</title>
|
|
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css">
|
|
<link rel="stylesheet" type="text/css" href="assets/api.css">
|
|
</head>
|
|
|
|
<body id="yahoo-com">
|
|
<div id="doc3" class="yui-t2">
|
|
|
|
<div id="hd">
|
|
<h1>Yahoo! UI Library</h1>
|
|
<h3>Drag and Drop </h3>
|
|
<p>
|
|
<a href="./index.html">Yahoo! UI Library</a>
|
|
> <a href="./module_dragdrop.html">dragdrop</a>
|
|
> YAHOO.util.DDProxy
|
|
|
|
</p>
|
|
</div>
|
|
|
|
<div id="bd">
|
|
<div id="yui-main">
|
|
<div class="yui-b">
|
|
|
|
|
|
<h2>
|
|
|
|
|
|
|
|
|
|
Class <b>YAHOO.util.DDProxy</b>
|
|
<span class="extends">
|
|
- extends <a href="YAHOO.util.DD.html">YAHOO.util.DD</a>
|
|
</span>
|
|
|
|
<span class="extends">
|
|
</span>
|
|
|
|
</code>
|
|
</h2>
|
|
<!-- class tree goes here -->
|
|
|
|
|
|
|
|
|
|
<div class="summary description">
|
|
A DragDrop implementation that inserts an empty, bordered div into
|
|
the document that follows the cursor during drag operations. At the time of
|
|
the click, the frame div is resized to the dimensions of the linked html
|
|
element, and moved to the exact location of the linked element.
|
|
References to the "frame" element refer to the single proxy element that
|
|
was created to be dragged in place of all DDProxy elements on the
|
|
page.
|
|
</div>
|
|
|
|
<div class="section constructor details">
|
|
<h3><a name="constructor_detail">Constructor</a></h3>
|
|
<div class="content">
|
|
<div class="detail">
|
|
<strong>YAHOO.util.DDProxy</strong>
|
|
<code>
|
|
(
|
|
|
|
|
|
|
|
id
|
|
|
|
,
|
|
sGroup
|
|
|
|
,
|
|
config
|
|
)
|
|
</code>
|
|
<div class="description">
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>id
|
|
<String>
|
|
</code>
|
|
the id of the linked html element
|
|
</dd>
|
|
<dd>
|
|
<code>sGroup
|
|
<String>
|
|
</code>
|
|
the group of related DragDrop objects
|
|
</dd>
|
|
<dd>
|
|
<code>config
|
|
<object>
|
|
</code>
|
|
an object containing configurable attributes
|
|
Valid properties for DDProxy in addition to those in DragDrop:
|
|
resizeFrame, centerFrame, dragElId
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section field details">
|
|
<h3><a name="field_detail">Properties</a></h3>
|
|
<div class="content">
|
|
<h4><a name="centerFrame">centerFrame</a>
|
|
<code>- boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
By default the frame is positioned exactly where the drag element is, so
|
|
we use the cursor offset provided by YAHOO.util.DD. Another option that works only if
|
|
you do not have constraints on the obj is to have the drag frame centered
|
|
around the cursor. Set centerFrame to true for this effect.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="resizeFrame">resizeFrame</a>
|
|
<code>- boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
By default we resize the drag frame to be the same size as the element
|
|
we want to drag (this is to get the frame effect). We can turn it off
|
|
if we want a different behavior.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="YAHOO.util.DDProxy.dragElId">YAHOO.util.DDProxy.dragElId</a>
|
|
<code>- static String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The default drag frame div id
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section field inheritance">
|
|
<h4>Properties inherited from <a href="YAHOO.util.DD.html">YAHOO.util.DD</a>:</h4>
|
|
<div class="content">
|
|
<code>
|
|
|
|
<a href="YAHOO.util.DD.html#scroll">scroll</a>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
<div class="section field inheritance">
|
|
<h4>Properties inherited from <a href="YAHOO.util.DragDrop.html">YAHOO.util.DragDrop</a>:</h4>
|
|
<div class="content">
|
|
<code>
|
|
|
|
<a href="YAHOO.util.DragDrop.html#__ygDragDrop">__ygDragDrop</a>,
|
|
<a href="YAHOO.util.DragDrop.html#_domRef">_domRef</a>,
|
|
<a href="YAHOO.util.DragDrop.html#available">available</a>,
|
|
<a href="YAHOO.util.DragDrop.html#config">config</a>,
|
|
<a href="YAHOO.util.DragDrop.html#constrainX">constrainX</a>,
|
|
<a href="YAHOO.util.DragDrop.html#constrainY">constrainY</a>,
|
|
<a href="YAHOO.util.DragDrop.html#dragElId">dragElId</a>,
|
|
<a href="YAHOO.util.DragDrop.html#groups">groups</a>,
|
|
<a href="YAHOO.util.DragDrop.html#handleElId">handleElId</a>,
|
|
<a href="YAHOO.util.DragDrop.html#hasOuterHandles">hasOuterHandles</a>,
|
|
<a href="YAHOO.util.DragDrop.html#id">id</a>,
|
|
<a href="YAHOO.util.DragDrop.html#invalidHandleClasses">invalidHandleClasses</a>,
|
|
<a href="YAHOO.util.DragDrop.html#invalidHandleIds">invalidHandleIds</a>,
|
|
<a href="YAHOO.util.DragDrop.html#invalidHandleTypes">invalidHandleTypes</a>,
|
|
<a href="YAHOO.util.DragDrop.html#locked">locked</a>,
|
|
<a href="YAHOO.util.DragDrop.html#maintainOffset">maintainOffset</a>,
|
|
<a href="YAHOO.util.DragDrop.html#maxX">maxX</a>,
|
|
<a href="YAHOO.util.DragDrop.html#maxY">maxY</a>,
|
|
<a href="YAHOO.util.DragDrop.html#minX">minX</a>,
|
|
<a href="YAHOO.util.DragDrop.html#minY">minY</a>,
|
|
<a href="YAHOO.util.DragDrop.html#primaryButtonOnly">primaryButtonOnly</a>,
|
|
<a href="YAHOO.util.DragDrop.html#startPageX">startPageX</a>,
|
|
<a href="YAHOO.util.DragDrop.html#startPageY">startPageY</a>,
|
|
<a href="YAHOO.util.DragDrop.html#xTicks">xTicks</a>,
|
|
<a href="YAHOO.util.DragDrop.html#yTicks">yTicks</a>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section method details">
|
|
<h3><a name="methodDetails">Methods</a></h3>
|
|
<div class="content">
|
|
<h4>
|
|
<a name="_resizeProxy">_resizeProxy</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_resizeProxy</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
The proxy is automatically resized to the dimensions of the linked
|
|
element when a drag is initiated, unless resizeFrame is set to false
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="createFrame">createFrame</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>createFrame</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Creates the proxy element if it does not yet exist
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="initFrame">initFrame</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>initFrame</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Initialization for the drag frame element. Must be called in the
|
|
constructor of all subclasses
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="showFrame">showFrame</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>showFrame</strong>
|
|
(
|
|
|
|
|
|
iPageX
|
|
|
|
|
|
,
|
|
iPageY
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Resizes the drag frame to the dimensions of the clicked object, positions
|
|
it over the object, and finally displays it
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>iPageX <int></code>
|
|
X click position
|
|
</dd>
|
|
<dd>
|
|
<code>iPageY <int></code>
|
|
Y click position
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section field inheritance">
|
|
<h4>Methods inherited from <a href="YAHOO.util.DD.html">YAHOO.util.DD</a>:</h4>
|
|
<div class="content">
|
|
<code>
|
|
|
|
<a href="YAHOO.util.DD.html#alignElWithMouse">alignElWithMouse</a>,
|
|
<a href="YAHOO.util.DD.html#autoOffset">autoOffset</a>,
|
|
<a href="YAHOO.util.DD.html#autoScroll">autoScroll</a>,
|
|
<a href="YAHOO.util.DD.html#cachePosition">cachePosition</a>,
|
|
<a href="YAHOO.util.DD.html#getTargetCoord">getTargetCoord</a>,
|
|
<a href="YAHOO.util.DD.html#setDelta">setDelta</a>,
|
|
<a href="YAHOO.util.DD.html#setDragElPos">setDragElPos</a>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
<div class="section field inheritance">
|
|
<h4>Methods inherited from <a href="YAHOO.util.DragDrop.html">YAHOO.util.DragDrop</a>:</h4>
|
|
<div class="content">
|
|
<code>
|
|
|
|
<a href="YAHOO.util.DragDrop.html#addInvalidHandleClass">addInvalidHandleClass</a>,
|
|
<a href="YAHOO.util.DragDrop.html#addInvalidHandleId">addInvalidHandleId</a>,
|
|
<a href="YAHOO.util.DragDrop.html#addInvalidHandleType">addInvalidHandleType</a>,
|
|
<a href="YAHOO.util.DragDrop.html#addToGroup">addToGroup</a>,
|
|
<a href="YAHOO.util.DragDrop.html#applyConfig">applyConfig</a>,
|
|
<a href="YAHOO.util.DragDrop.html#b4Drag">b4Drag</a>,
|
|
<a href="YAHOO.util.DragDrop.html#b4DragDrop">b4DragDrop</a>,
|
|
<a href="YAHOO.util.DragDrop.html#b4DragOut">b4DragOut</a>,
|
|
<a href="YAHOO.util.DragDrop.html#b4DragOver">b4DragOver</a>,
|
|
<a href="YAHOO.util.DragDrop.html#b4EndDrag">b4EndDrag</a>,
|
|
<a href="YAHOO.util.DragDrop.html#b4MouseDown">b4MouseDown</a>,
|
|
<a href="YAHOO.util.DragDrop.html#b4StartDrag">b4StartDrag</a>,
|
|
<a href="YAHOO.util.DragDrop.html#clearConstraints">clearConstraints</a>,
|
|
<a href="YAHOO.util.DragDrop.html#clearTicks">clearTicks</a>,
|
|
<a href="YAHOO.util.DragDrop.html#endDrag">endDrag</a>,
|
|
<a href="YAHOO.util.DragDrop.html#getDragEl">getDragEl</a>,
|
|
<a href="YAHOO.util.DragDrop.html#getEl">getEl</a>,
|
|
<a href="YAHOO.util.DragDrop.html#getTick">getTick</a>,
|
|
<a href="YAHOO.util.DragDrop.html#handleMouseDown">handleMouseDown</a>,
|
|
<a href="YAHOO.util.DragDrop.html#handleOnAvailable">handleOnAvailable</a>,
|
|
<a href="YAHOO.util.DragDrop.html#init">init</a>,
|
|
<a href="YAHOO.util.DragDrop.html#initTarget">initTarget</a>,
|
|
<a href="YAHOO.util.DragDrop.html#isLocked">isLocked</a>,
|
|
<a href="YAHOO.util.DragDrop.html#isTarget">isTarget</a>,
|
|
<a href="YAHOO.util.DragDrop.html#isValidHandleChild">isValidHandleChild</a>,
|
|
<a href="YAHOO.util.DragDrop.html#lock">lock</a>,
|
|
<a href="YAHOO.util.DragDrop.html#onAvailable">onAvailable</a>,
|
|
<a href="YAHOO.util.DragDrop.html#onDrag">onDrag</a>,
|
|
<a href="YAHOO.util.DragDrop.html#onDragDrop">onDragDrop</a>,
|
|
<a href="YAHOO.util.DragDrop.html#onDragEnter">onDragEnter</a>,
|
|
<a href="YAHOO.util.DragDrop.html#onDragOut">onDragOut</a>,
|
|
<a href="YAHOO.util.DragDrop.html#onDragOver">onDragOver</a>,
|
|
<a href="YAHOO.util.DragDrop.html#onInvalidDrop">onInvalidDrop</a>,
|
|
<a href="YAHOO.util.DragDrop.html#onMouseDown">onMouseDown</a>,
|
|
<a href="YAHOO.util.DragDrop.html#onMouseUp">onMouseUp</a>,
|
|
<a href="YAHOO.util.DragDrop.html#padding">padding</a>,
|
|
<a href="YAHOO.util.DragDrop.html#removeFromGroup">removeFromGroup</a>,
|
|
<a href="YAHOO.util.DragDrop.html#removeInvalidHandleClass">removeInvalidHandleClass</a>,
|
|
<a href="YAHOO.util.DragDrop.html#removeInvalidHandleId">removeInvalidHandleId</a>,
|
|
<a href="YAHOO.util.DragDrop.html#removeInvalidHandleType">removeInvalidHandleType</a>,
|
|
<a href="YAHOO.util.DragDrop.html#resetConstraints">resetConstraints</a>,
|
|
<a href="YAHOO.util.DragDrop.html#setDragElId">setDragElId</a>,
|
|
<a href="YAHOO.util.DragDrop.html#setHandleElId">setHandleElId</a>,
|
|
<a href="YAHOO.util.DragDrop.html#setInitialPosition">setInitialPosition</a>,
|
|
<a href="YAHOO.util.DragDrop.html#setOuterHandleElId">setOuterHandleElId</a>,
|
|
<a href="YAHOO.util.DragDrop.html#setPadding">setPadding</a>,
|
|
<a href="YAHOO.util.DragDrop.html#setStartPosition">setStartPosition</a>,
|
|
<a href="YAHOO.util.DragDrop.html#setXConstraint">setXConstraint</a>,
|
|
<a href="YAHOO.util.DragDrop.html#setXTicks">setXTicks</a>,
|
|
<a href="YAHOO.util.DragDrop.html#setYConstraint">setYConstraint</a>,
|
|
<a href="YAHOO.util.DragDrop.html#setYTicks">setYTicks</a>,
|
|
<a href="YAHOO.util.DragDrop.html#startDrag">startDrag</a>,
|
|
<a href="YAHOO.util.DragDrop.html#toString">toString</a>,
|
|
<a href="YAHOO.util.DragDrop.html#unlock">unlock</a>,
|
|
<a href="YAHOO.util.DragDrop.html#unreg">unreg</a>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="yui-b">
|
|
<div class="nav">
|
|
|
|
<div class="module">
|
|
<h4>Modules</h4>
|
|
<ul class="content">
|
|
<li><a href="module_animation.html">animation</a></li>
|
|
<li><a href="module_autocomplete.html">autocomplete</a></li>
|
|
<li><a href="module_calendar.html">calendar</a></li>
|
|
<li><a href="module_connection.html">connection</a></li>
|
|
<li><a href="module_container.html">container</a></li>
|
|
<li><a href="module_dom.html">dom</a></li>
|
|
<li><a href="module_dragdrop.html">dragdrop</a></li>
|
|
<li><a href="module_event.html">event</a></li>
|
|
<li><a href="module_logger.html">logger</a></li>
|
|
<li><a href="module_menu.html">menu</a></li>
|
|
<li><a href="module_slider.html">slider</a></li>
|
|
<li><a href="module_tabview.html">tabview</a></li>
|
|
<li><a href="module_treeview.html">treeview</a></li>
|
|
<li><a href="module_yahoo.html">yahoo</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Classes</h4>
|
|
<ul class="content">
|
|
<li><a href="YAHOO.util.DD.html">YAHOO.util.DD</a></li>
|
|
<li><a href="YAHOO.util.DDProxy.html">YAHOO.util.DDProxy</a></li>
|
|
<li><a href="YAHOO.util.DDTarget.html">YAHOO.util.DDTarget</a></li>
|
|
<li><a href="YAHOO.util.DragDrop.html">YAHOO.util.DragDrop</a></li>
|
|
<li><a href="YAHOO.util.DragDropMgr.html">YAHOO.util.DragDropMgr</a></li>
|
|
<li><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><a href="DD.js.html">DD.js</a></li>
|
|
<li><a href="DDProxy.js.html">DDProxy.js</a></li>
|
|
<li><a href="DDTarget.js.html">DDTarget.js</a></li>
|
|
<li><a href="DragDrop.js.html">DragDrop.js</a></li>
|
|
<li><a href="DragDropMgr.js.html">DragDropMgr.js</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Properties</h4>
|
|
<ul class="content">
|
|
<li><a href="#centerFrame">centerFrame</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#resizeFrame">resizeFrame</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#YAHOO.util.DDProxy.dragElId">YAHOO.util.DDProxy.dragElId</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Methods</h4>
|
|
<ul class="content">
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_resizeProxy">_resizeProxy</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#createFrame">createFrame</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#initFrame">initFrame</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#showFrame">showFrame</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="ft">
|
|
<hr />
|
|
Copyright © 2006 Yahoo! Inc. All rights reserved.
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|