%META:TOPICPARENT{name="OATDOCIndex"}%
---+ drag.js

Provides dragging (moving) capability for any DOM node

%TOC%

---++ Functions

---+++ OAT.Drag.create(clicker, mover, optObj)

Modifies element <tt>mover</tt> such that clicking and moving on <tt>clicker</tt> will cause it to move. Additional options can be specified using <tt>optObj</tt> object:
   * <tt>*type*</tt> - one of the constants, specifies direction in which element may be dragged
   * <tt>*restrictionFunction*</tt> - callback which specifies movement restriction
   * <tt>*endFunction*</tt> - callback to be executed when dragging ends
   * <tt>*magnetsH*</tt> - array of elements to horizontally snap to
   * <tt>*magnetsV*</tt> - array of elements to vertically snap to
   * <tt>*cursor*</tt> - bool, automatically adjust CSS cursor

---+++ OAT.Drag.remove(clicker, mover)

Removes dragging relation between <tt>clicker</tt> and <tt>mover</tt>.

---+++ OAT.Drag.removeAll(clicker)

Removes all dragging relations from <tt>clicker</tt>.

---++ Constants

---+++ OAT.Drag.TYPE_X

ToBeDone

---+++ OAT.Drag.TYPE_Y

ToBeDone

---+++ OAT.Drag.TYPE_XY

ToBeDone

---++ Example

<verbatim>
var header = Dom.create("div");
var body = Dom.create("div");
body.appendChild(header);
OAT.Drag.create(header, body, {type:TYPE_XY});
</verbatim>

CategoryOAT CategoryDocumentation CategoryOpenSource CategoryToBeDone