dojo/dnd/TimedMoveable (version 1.10)

dojo/dnd/Moveable

Summary

A specialized version of Moveable to support an FPS throttling. This class puts an upper restriction on FPS, which may reduce the CPU load. The additional parameter "timeout" regulates the delay before actually moving the moveable object.

Usage

var foo = new TimedMoveable(node,params);
dojo/dnd/TimedMoveable
Parameter Type Description
node Node | String

a node (or node's id) to be moved
params Object

object with additional parameters.

See the dojo/dnd/TimedMoveable reference documentation for more information.

Property Summary

Method Summary

  • destroy() stops watching for possible move, deletes all references, so the object can be garbage-collected
  • emit(type,event)
  • markupFactory(params,node,Ctor)
  • on(type,listener)

Event Summary

  • onDragDetected(e) called when the drag is detected; responsible for creation of the mover
  • onFirstMove(mover,e) called during the very first move notification; can be used to initialize coordinates, can be overwritten.
  • onMouseDown(e) event processor for onmousedown/ontouchstart, creates a Mover for the node
  • onMouseMove(e) event processor for onmousemove/ontouchmove, used only for delayed drags
  • onMouseUp(e) event processor for onmouseup, used only for delayed drags
  • onMove(mover,leftTop)
  • onMoved(mover,leftTop) called after every incremental move; can be overwritten.
  • onMoveStart(mover) called before every move operation
  • onMoveStop(mover)
  • onMoving(mover,leftTop) called before every incremental move; can be overwritten.
  • onSelectStart(e) event processor for onselectevent and ondragevent

Properties

delay
Defined by: dojo/dnd/Moveable
handle
Defined by: dojo/dnd/Moveable
skip
Defined by: dojo/dnd/Moveable
timeout
Defined by: dojo/dnd/TimedMoveable

Methods

destroy()
Defined by dojo/dnd/Moveable

stops watching for possible move, deletes all references, so the object can be garbage-collected

emit(type,event)
Defined by dojo/Evented
Parameter Type Description
type undefined
event undefined
Returns:undefined
markupFactory(params,node,Ctor)
Defined by dojo/dnd/Moveable
Parameter Type Description
params undefined
node undefined
Ctor undefined
Returns:instance
on(type,listener)
Defined by dojo/Evented
Parameter Type Description
type undefined
listener undefined
Returns:undefined

Events

onDragDetected(e)
Defined by: dojo/dnd/Moveable

called when the drag is detected; responsible for creation of the mover

Parameter Type Description
e Event
onFirstMove(mover,e)
Defined by: dojo/dnd/Moveable

called during the very first move notification; can be used to initialize coordinates, can be overwritten.

Parameter Type Description
mover dojo/dnd/Mover
e Event
onMouseDown(e)
Defined by: dojo/dnd/Moveable

event processor for onmousedown/ontouchstart, creates a Mover for the node

Parameter Type Description
e Event

mouse/touch event
onMouseMove(e)
Defined by: dojo/dnd/Moveable

event processor for onmousemove/ontouchmove, used only for delayed drags

Parameter Type Description
e Event

mouse/touch event
onMouseUp(e)
Defined by: dojo/dnd/Moveable

event processor for onmouseup, used only for delayed drags

Parameter Type Description
e Event

mouse event
onMove(mover,leftTop)
Defined by: dojo/dnd/TimedMoveable
Parameter Type Description
mover dojo/dnd/Mover
leftTop Object
onMoved(mover,leftTop)
Defined by: dojo/dnd/Moveable

called after every incremental move; can be overwritten.

Parameter Type Description
mover dojo/dnd/Mover
leftTop Object
onMoveStart(mover)
Defined by: dojo/dnd/Moveable

called before every move operation

Parameter Type Description
mover dojo/dnd/Mover
onMoveStop(mover)
Defined by: dojo/dnd/TimedMoveable
Parameter Type Description
mover dojo/dnd/Mover
onMoving(mover,leftTop)
Defined by: dojo/dnd/Moveable

called before every incremental move; can be overwritten.

Parameter Type Description
mover dojo/dnd/Mover
leftTop Object
onSelectStart(e)
Defined by: dojo/dnd/Moveable

event processor for onselectevent and ondragevent

Parameter Type Description
e Event

mouse event
Error in the documentation? Can’t find what you are looking for? Let us know!