Static Class APE.drag.Draggable

var Draggable = APE.drag.Draggable,
    el = document.getElementById("box"),
    box = Draggable.getByNode( el );
box.keepInContainer = true;
box.activeDragClassName = "boxDragging";
box.focusClassName = "boxFocused";

var bigBx = box.addDropTarget( document.getElementById("biggerBox") );
bigBx.dragOverClassName = "boxDragOver";

_dragOverTargets

object _dragOverTargets

A subset of dropTargets that have ondragover or ondragout. created onmousedown, to help boost performance by reducing count for ondragover

activeDragClassName

String activeDragClassName

className to add before being dragged.

constraint

Number constraint

default: APE.drag.Draggable.constraints.NONE

constraints

object constraints

dragCopy

boolean dragCopy

set to true to make a temporary "ghost" copy dragged.

draggableList

Object draggableList

Internal map of draggables

dragMultiple

boolean dragMultiple

set to true to allow this to be dragged as a group.

focusClassName

String focusClassName

className to add when focused.

grabX

Number grabX

where draggable was grabbed from

grabY

Number grabY

where draggable was grabbed from

highestZIndex

Number highestZIndex

a higher z-index is assigned beforedragstart.

isDragEnabled

boolean isDragEnabled

drag object can be disabled by setting to this to false

keepInContainer

boolean keepInContainer

drag object can be dragged outside of its container

newX

Number newX

Where it will move to next. onbeforedrag

newY

Number newY

Where it will move to next. onbeforedrag

origX

Number origX

where drag started from

origY

Number origY

where drag started from

selectedClassName

String selectedClassName

className to add when selected.

x

Number x

current x position

y

Number y

current y position

addDropTarget

DropTarget addDropTarget(dropTarget)

Adds a drop target.

Parameters:
HTMLElement, APE.drag.DropTarget dropTarget - either an element or a DropTarget.

Returns:
DropTarget The drop target that was added.

animateBack

animateBack(x, y)

Starts gliding the draggable back to its original x,y coords.

Parameters:
Number x? - x coordinate to start gliding from.
Number y? - y coordinate to start gliding from.

dragDone

dragDone(e)

Parameters:
e

getByNode

<static> APE.drag.Draggable getByNode(el, constraint)

Use Draggable.getByNode, not new.

Parameters:
HTMLElement el
uint constraint? - (0 | 1 | 2) default is 0.

Returns:
APE.drag.Draggable 

grab

grab(e, xOffset, xOffset)

Grabs the draggable, centering it under the cursor.

Parameters:
Event e - the event to grab the element from.
int xOffset? - amount of horizontal adjustment to apply.
int xOffset? - amount of vertical adjustment to apply.

init

init()

undocumented

instanceDestructor

instanceDestructor()

undocumented

release

release(e)

releases the draggable, as if the mouse had been released.

Parameters:
Event e? - the event that triggered release

removeDropTarget

HTMLElement removeDropTarget(element)

Removes a drop target.

Parameters:
HTMLElement, DropTarget element - or DropTarget to remove.

Returns:
HTMLElement the removed dropTarget element.

select

select(isSelect)

Selects the draggable, adding selectedClassName

Parameters:
boolean isSelect - if false, deselects.

setContainer

setContainer(el)

A dragObj does not check search for containing block each time its grabbed/dragged. Instead, it reuses the container. If the container must change, this must be done manually, via dragObj.setContainer(newEl);

Parameters:
el

setFocus

setFocus(isFocus, e)

undocumented

Parameters:
isFocus
e

setHandle

setHandle(el, setHandleTree)

Sets a handle on a draggable

Parameters:
HTMLElement el - the element to use as a handle. By default, the handle is the draggable.
boolean setHandleTree? - if true, the draggable can use anything in the handle's subtree for dragging.

toString

toString()

undocumented

onbeforedrag

onbeforedrag()

Is about to move.

onbeforedragstart

onbeforedragstart()

Has been grabbed.

onblur

onblur()

Has been blurred.

ondrag

ondrag(e)

Being dragged

Parameters:
Event e - dom event.

ondragend

ondragend()

Dragging completed (as a result of mouseup).

ondragstart

ondragstart(e)

Parameters:
Event e - dom event. Mouse has moved.

ondragstop

ondragstop()

Dragging stopped before it escaped its container.

onfocus

onfocus()

Has been grabbed.