dojox/mdnd/dropMode/OverDropMode.js

• Provides:

  • dojox.mdnd.dropMode.OverDropMode

• Requires:

  • dojox.mdnd.AreaManager in common

• dojox.mdnd.dropMode.OverDropMode

  • type

    Function

  • summary

    Default class to find the nearest target only if the mouse is over an area.

• dojox.mdnd.dropMode.OverDropMode._oldXPoint

  • type

    Integer

  • summary

    used to save a X position

• dojox.mdnd.dropMode.OverDropMode._oldYPoint

  • type

    Integer

  • summary

    used to save a Y position

• dojox.mdnd.dropMode.OverDropMode._oldBehaviour

  • type

    Integer

  • summary

    see getDragpoint()

• dojox.mdnd.dropMode.OverDropMode.constructor

  • constructor - constructor
  • type

    Function

• dojox.mdnd.dropMode.OverDropMode.addArea

  • parameters:
    • areas: (typeof Array)

      array of areas

    • object: (typeof Object)

      data type of a DndArea

  • returns

    Array

  • summary

    Add a D&D Area into an array sorting by the x position.

  • return_summary

    a sorted area

  • type

    Function

• dojox.mdnd.dropMode.OverDropMode.updateAreas

  • parameters:
    • areaList: (typeof Array)

      array of areas

  • summary

    refresh areas position and size to determinate the nearest area to drop an item

  • description

    the area position (and size) is equal to the postion of the domNode associated.

  • type

    Function

• dojox.mdnd.dropMode.OverDropMode._updateArea

  • parameters:
    • area: (typeof Object)

      the D&D area.

  • summary

    update the D&D area object (i.e. update coordinates of its DOM node)

  • tags:
  • type

    Function

• dojox.mdnd.dropMode.OverDropMode.initItems

  • parameters:
    • area: (typeof Object)

      the D&D area.

  • summary

    initialize the horizontal line in order to determinate the drop zone.

  • type

    Function

• dojox.mdnd.dropMode.OverDropMode.refreshItems

  • parameters:
    • area: (typeof Object)

      a D&D area object

    • indexItem: (typeof Integer)

      index of a draggable item

    • size: (typeof Object)

      dropIndicator size

    • added: (typeof Boolean)

      boolean to know if a dropIndicator has been added or deleted

  • summary

    take into account the drop indicator DOM element in order to compute horizontal lines

  • type

    Function

• dojox.mdnd.dropMode.OverDropMode.getDragPoint

  • parameters:
    • coords: (typeof Object)

      an object encapsulating X and Y position

    • size: (typeof Object)

      an object encapsulating width and height values

    • mousePosition: (typeof Object)

      coordinates of mouse

  • returns

    Object

  • summary

    return coordinates of the draggable item.
    - For X point : the x position of mouse
    - For Y point : the y position of mouse

  • return_summary

    an object of coordinates
    examples:{'x':10,'y':10}

  • type

    Function

• dojox.mdnd.dropMode.OverDropMode.getTargetArea

  • parameters:
    • areaList: (typeof Array)

      a list of D&D areas objects

    • coords: (typeof Object)

      coordinates [x,y] of the dragItem (see getDragPoint())

    • currentIndexArea: (typeof integer)

      an index representing the active D&D area

  • returns

    Integer

  • summary

    get the nearest D&D area.

  • return_summary

    the index of the D&D area

  • type

    Function

• dojox.mdnd.dropMode.OverDropMode._checkInterval

  • parameters:
    • areaList: (typeof Array)

      a list of D&D areas objects

    • index: (typeof Integer)

      index of a D&D area (to get the interval)

    • x: (typeof Coord)

      coordinate x, of the dragNode (see getDragPoint())

    • y: (typeof Coord)
  • returns

    Boolean

  • summary

    check if the dragNode is in the interval.

  • return_summary

    true if the dragNode is in intervall

  • tags:
  • type

    Function

• dojox.mdnd.dropMode.OverDropMode.getDropIndex

  • parameters:
    • targetArea: (typeof Object)

      a D&D area object.

    • coords: (typeof Object)

      coordinates [x,y] of the draggable item.

  • returns

    integer

  • summary

    Return the index where the drop has to be placed.

  • return_summary

    a number or -1 if the area has no children or the drop index represents the last position in to the area

  • type

    Function

• dojox.mdnd.dropMode.OverDropMode.destroy

  • type

    Function

• dojox.mdnd.dropMode.OverDropMode._dragHandler

  • type

    Array

• dojox.mdnd.dropMode

  • type

    Object

• dojox.mdnd

  • type

    Object

• dojox

  • type

    Object