dojo/dnd/move.js

• Provides:

  • dojo.dnd.move

• Requires:

  • dojo.dnd.Mover in common
  • dojo.dnd.Moveable in common

• dojo.dnd.move.__constrainedMoveableArgs

  • type

    Function

  • chains:
    • dojo.dnd.__MoveableArgs: (prototype)
    • dojo.dnd.__MoveableArgs: (call)

• dojo.dnd.move.__constrainedMoveableArgs.constraints

  • type

    Function

  • summary

    Calculates a constraint box.
    It is called in a context of the moveable object.

• dojo.dnd.move.__constrainedMoveableArgs.within

  • type

    Boolean

  • summary

    restrict move within boundaries.

• dojo.dnd.move.constrainedMoveable

  • type

    Function

  • chains:
    • dojo.dnd.Moveable: (prototype)
    • dojo.dnd.Moveable: (call)
  • parameters:
    • node: (typeof Node)

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

    • params: (typeof dojo.dnd.move.__constrainedMoveableArgs)

      an optional object with additional parameters;
      the rest is passed to the base class

  • summary

    an object that makes a node moveable

• dojo.dnd.move.constrainedMoveable.constraints

  • type

    Function

• dojo.dnd.move.constrainedMoveable.within

  • type

    bool

• dojo.dnd.move.constrainedMoveable.markupFactory

  • parameters:
    • params
    • node
  • type

    Function

• dojo.dnd.move.constrainedMoveable.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • node: (typeof Node)

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

    • params: (typeof dojo.dnd.move.__constrainedMoveableArgs)

      an optional object with additional parameters;
      the rest is passed to the base class

  • summary

    an object that makes a node moveable

• dojo.dnd.move.constrainedMoveable.onFirstMove

  • parameters:
    • mover: (typeof dojo.dnd.Mover)
  • summary

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

  • type

    Function

• dojo.dnd.move.constrainedMoveable.constraintBox

  • type

    Object

• dojo.dnd.move.constrainedMoveable.onMove

  • parameters:
    • mover: (typeof dojo.dnd.Mover)
    • leftTop: (typeof Object)
  • summary

    called during every move notification;
    should actually move the node; can be overwritten.

  • type

    Function

• dojo.dnd.move.__boxConstrainedMoveableArgs

  • type

    Function

  • chains:
    • dojo.dnd.move.__constrainedMoveableArgs: (prototype)
    • dojo.dnd.move.__constrainedMoveableArgs: (call)

• dojo.dnd.move.__boxConstrainedMoveableArgs.box

  • type

    Object

  • summary

    a constraint box

• dojo.dnd.move.boxConstrainedMoveable

  • type

    Function

  • chains:
    • dojo.dnd.move.constrainedMoveable: (prototype)
    • dojo.dnd.move.constrainedMoveable: (call)
  • parameters:
    • node: (typeof Node)

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

    • params: (typeof dojo.dnd.move.__boxConstrainedMoveableArgs)

      an optional object with parameters

  • summary

    an object, which makes a node moveable

• dojo.dnd.move.boxConstrainedMoveable.box

  • type

    object

  • summary

    attributes (for markup)

• dojo.dnd.move.boxConstrainedMoveable.markupFactory

  • parameters:
    • params
    • node
  • type

    Function

• dojo.dnd.move.boxConstrainedMoveable.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • node: (typeof Node)

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

    • params: (typeof dojo.dnd.move.__boxConstrainedMoveableArgs)

      an optional object with parameters

  • summary

    an object, which makes a node moveable

• dojo.dnd.move.boxConstrainedMoveable.constraints

  • type

    Function

• dojo.dnd.move.__parentConstrainedMoveableArgs

  • type

    Function

  • chains:
    • dojo.dnd.move.__constrainedMoveableArgs: (prototype)
    • dojo.dnd.move.__constrainedMoveableArgs: (call)

• dojo.dnd.move.__parentConstrainedMoveableArgs.area

  • type

    String

  • summary

    A parent's area to restrict the move.
    Can be "margin", "border", "padding", or "content".

• dojo.dnd.move.parentConstrainedMoveable

  • type

    Function

  • chains:
    • dojo.dnd.move.constrainedMoveable: (prototype)
    • dojo.dnd.move.constrainedMoveable: (call)
  • parameters:
    • node: (typeof Node)

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

    • params: (typeof dojo.dnd.move.__parentConstrainedMoveableArgs)

      an optional object with parameters

  • returns

    Object

  • summary

    an object, which makes a node moveable

• dojo.dnd.move.parentConstrainedMoveable.area

  • type

    object

  • summary

    attributes (for markup)

• dojo.dnd.move.parentConstrainedMoveable.markupFactory

  • parameters:
    • params
    • node
  • type

    Function

• dojo.dnd.move.parentConstrainedMoveable.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • node: (typeof Node)

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

    • params: (typeof dojo.dnd.move.__parentConstrainedMoveableArgs)

      an optional object with parameters

  • returns

    Object

  • summary

    an object, which makes a node moveable

• dojo.dnd.move.parentConstrainedMoveable.constraints

  • returns

    Object

  • type

    Function

• dojo.dnd.move.parentConstrainedMoveable.node.parentNode

• dojo.dnd.constrainedMover

  • alias - dojo.dnd.move.constrainedMover

• dojo.dnd.boxConstrainedMover

  • alias - dojo.dnd.move.boxConstrainedMover

• dojo.dnd.parentConstrainedMover

  • alias - dojo.dnd.move.parentConstrainedMover

• dojo.dnd.move

  • type

    Object

• dojo.dnd

  • type

    Object

• dojo

  • type

    Object