dojox/mdnd/Moveable.js

• Provides:

  • dojox.mdnd.Moveable

• dojox.mdnd.Moveable

  • type

    Function

  • parameters:
    • params: (typeof Object)

      Hash of parameters

    • node: (typeof DOMNode)

      The draggable node

  • summary

    Allow end-users to track a DOM node into the web page

• dojox.mdnd.Moveable.handle

  • type

    DOMNode

  • summary

    The node on which the user clicks to drag the main node.

• dojox.mdnd.Moveable.skip

  • type

    Boolean

  • summary

    A flag to control a drag action if a form element has been focused.
    If true, the drag action is not executed.

• dojox.mdnd.Moveable.dragDistance

  • type

    Integer

  • summary

    The user clicks on the handle, but the drag action will really begin
    if he tracks the main node to more than 3 pixels.

• dojox.mdnd.Moveable.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • params: (typeof Object)

      Hash of parameters

    • node: (typeof DOMNode)

      The draggable node

  • summary

    Configure parameters and listen to mousedown events from handle
    node.

• dojox.mdnd.Moveable.isFormElement

  • parameters:
    • e: (typeof DOMEvent)

      a DOM event

  • returns

    Boolean

  • summary

    identify the type of target node associated with a DOM event.

  • return_summary

    if true, the target is one of those specific nodes.

  • type

    Function

• dojox.mdnd.Moveable.onMouseDown

  • parameters:
    • e: (typeof DOMEvent)

      a DOM event

  • summary

    Occurs when the user clicks on the handle node.
    Skip the drag action if a specific node is targeted.
    Listens to mouseup and mousemove events on to the HTML document.

  • tags: callback
  • type

    Function

• dojox.mdnd.Moveable._selectStart

  • type

    Object

• dojox.mdnd.Moveable._firstX

• dojox.mdnd.Moveable._firstY

• dojox.mdnd.Moveable.onFirstMove

  • parameters:
    • e: (typeof DOMEvent)

      A DOM event

  • summary

    Occurs when the user moves the mouse after clicking on the
    handle.
    Determinate when the drag action will have to begin (see
    dragDistance).

  • tags: callback
  • type

    Function

• dojox.mdnd.Moveable._isDragging

  • type

    bool

• dojox.mdnd.Moveable.initOffsetDrag

  • parameters:
    • e: (typeof DOMEvent)

      A DOM event

  • summary

    Initialize the gap between main node coordinates and the clicked point.
    Call the onDragStart method.

  • type

    Function

• dojox.mdnd.Moveable.offsetDrag

  • type

    Object

• dojox.mdnd.Moveable.node.style

• dojox.mdnd.Moveable.offsetDrag.l

  • type

    Number

• dojox.mdnd.Moveable.offsetDrag.t

  • type

    Number

• dojox.mdnd.Moveable.size

  • type

    Object

• dojox.mdnd.Moveable.onMove

  • parameters:
    • e: (typeof DOMEvent)

      a DOM event

  • summary

    Occurs when the user moves the mouse.
    Calls the onDrag method.

  • tags: callback
  • type

    Function

• dojox.mdnd.Moveable.node.style.left

  • type

    String

• dojox.mdnd.Moveable.node.style.top

  • type

    String

• dojox.mdnd.Moveable.date

  • type

    Object

• dojox.mdnd.Moveable.onMouseUp

  • parameters:
    • e: (typeof DOMEvent)

      a DOM event

  • summary

    Occurs when the user releases the mouse
    Calls the onDragEnd method.

  • type

    Function

• dojox.mdnd.Moveable.onDragStart

  • parameters:
    • node: (typeof DOMNode)

      a DOM node

    • coords: (typeof Object)

      absolute position of the main node

    • size: (typeof Object)

      an object encapsulating width an height values

  • summary

    Stub function.
    Notes : border box model

  • tags: callback
  • type

    Function

• dojox.mdnd.Moveable.onDragEnd

  • parameters:
    • node: (typeof DOMNode)

      a DOM node

  • summary

    Stub function
    Notes : Coordinates don't contain margins

  • tags: callback
  • type

    Function

• dojox.mdnd.Moveable.onDrag

  • parameters:
    • node: (typeof DOMNode)

      a DOM node

    • coords: (typeof Object)

      position of the main node (equals to css left/top properties)

    • size: (typeof Object)

      an object encapsulating width and height values

    • mousePosition: (typeof Object)

      coordiantes of mouse

  • summary

    Stub function.
    Notes : border box model for size value, margin box model for coordinates

  • tags: callback
  • type

    Function

• dojox.mdnd.Moveable.destroy

  • summary

    Delecte associated events

  • type

    Function

• dojox.mdnd.Moveable.events

  • type

    Array

• dojox.mdnd.Moveable.node

  • type

    The

  • summary

    draggable node

• dojox.mdnd.Moveable.d

• dojox.mdnd.Moveable.autoScroll

• dojox.mdnd

  • type

    Object

• dojox

  • type

    Object