dojox/mdnd/AreaManager.js

• Provides:

  • dojox.mdnd.AreaManager

• Requires:

  • dojox.mdnd.Moveable in common

• dijit._Widget

  • type

    Function

• dijit._Widget.dndType

  • type

    String

  • summary

    Defines a type of widget.

• dojox.mdnd.AreaManager

  • type

    Function

  • summary

    Drag And Drop manager

• dojox.mdnd.AreaManager.autoRefresh

  • type

    Boolean

  • summary

    Enable the refresh of registered areas on drag start.

• dojox.mdnd.AreaManager.areaClass

  • type

    String

  • summary

    CSS class enabled an area if areaClass is defined

• dojox.mdnd.AreaManager.dragHandleClass

  • type

    String

  • summary

    CSS class enabled a drag handle.

• dojox.mdnd.AreaManager.constructor

  • constructor - constructor
  • type

    Function

  • summary

    Constructor of AreaManager class.
    Initialize arrays, connects and subscribes.

• dojox.mdnd.AreaManager.init

  • summary

    Initialize the manager by calling the registerByClass method

  • type

    Function

• dojox.mdnd.AreaManager.registerByNode

  • parameters:
    • area: (typeof DOMNode)

      a DOM node corresponding to the Dnd Area

    • notInitAreas: (typeof Boolean)

      if false or undefined, init the areas.

  • summary

    To register Dnd Area : insert the DndArea using the specific sort of dropMode.

  • type

    Function

• dojox.mdnd.AreaManager._areaList

  • type

    Array

• dojox.mdnd.AreaManager.registerByClass

  • summary

    Register all Dnd Areas identified by the attribute areaClass :
    insert Dnd Areas using the specific sort of dropMode.

  • type

    Function

• dojox.mdnd.AreaManager.unregister

  • parameters:
    • area: (typeof DOMNode)

      A node corresponding to the D&D Area.

  • returns

    Boolean

  • summary

    Unregister a D&D Area and its children into the AreaManager.

  • return_summary

    True if the area is found and unregistered.

  • type

    Function

• dojox.mdnd.AreaManager._addMoveableItem

  • parameters:
    • node: (typeof DOMNode)

      A child of the D&D Area.

  • returns

    Object

  • summary

    Create a draggable item with a DOM node.

  • return_summary

    The draggable item.

  • tags:
  • type

    Function

• dojox.mdnd.AreaManager._deleteMoveableItem

  • parameters:
    • objItem: (typeof Object)
  • summary

    Delete the Moveable object associated with a node.
    item:
    A moveable Object.

  • tags:
  • type

    Function

• dojox.mdnd.AreaManager._getIndexArea

  • parameters:
    • area: (typeof DOMNode)

      A moveable Object.

  • returns

    Integer

  • summary

    Get the index of an area.

  • return_summary

    area index or -1

  • tags:
  • type

    Function

• dojox.mdnd.AreaManager._searchDragHandle

  • parameters:
    • node: (typeof DOMNode)

      A child of the D&D Area.

  • returns

    DomNode

  • summary

    Return the node which contains the first specific CSS class handle.

  • return_summary

    The drag handle node.

  • tags:
  • type

    Function

• dojox.mdnd.AreaManager.addDragItem

  • parameters:
    • area: (typeof DOMNode)

      a node corresponding to the D&D Area

    • node: (typeof DOMNode)

      the node which has to be treated.

    • index: (typeof Integer)

      the place in the area
      noCheckParent:
      if true, doesn't check if node has a parent.

    • notCheckParent: (typeof Boolean)
  • returns

    Boolean

  • summary

    To add an item programmatically.

  • return_summary

    True if the node has been inserted else false.

  • type

    Function

• dojox.mdnd.AreaManager.removeDragItem

  • parameters:
    • area: (typeof DOMNode)

      A node corresponding to the DndArea.

    • node: (typeof DOMNode)

      The node which has to be treated.

  • returns

    Object

  • summary

    Delete a moveable item programmatically. The node is removed from the area.

  • return_summary

    the removed node

  • type

    Function

• dojox.mdnd.AreaManager._getChildren

  • parameters:
    • area: (typeof DOMNode)

      A DnD area.

  • returns

    Array

  • summary

    Get the children of a D&D area.

  • return_summary

    The children of a DnD area

  • tags:
  • type

    Function

• dojox.mdnd.AreaManager._setMarginArea

  • parameters:
    • area: (typeof Object)

      The object of a D&D Area.

    • node: (typeof DOMNode)

      The node which contains margins

  • summary

    Set the value of margin in the data type of areaManager
    only when the margin has never been computed.

  • tags:
  • type

    Function

• dojox.mdnd.AreaManager.findCurrentIndexArea

  • parameters:
    • coords: (typeof Object)

      an object encapsulating X and Y position

    • size: (typeof Object)

      an object encapsulating the area size

  • returns

    Integer

  • summary

    find the nearest target area according to coordinates.
    Coordinates are representing by an object : for example, {'x':10,'y':10}

  • return_summary

    an index of area

  • type

    Function

• dojox.mdnd.AreaManager._oldIndexArea

  • type

    Number

• dojox.mdnd.AreaManager._currentIndexArea

  • type

    Number

• dojox.mdnd.AreaManager._isAccepted

  • parameters:
    • type: (typeof Array)

      containing item type

    • accept: (typeof Array)

      containing types

  • summary

    True if user can drop widget on this node.

  • type

    Function

• dojox.mdnd.AreaManager._accept

  • type

    bool

• dojox.mdnd.AreaManager.onDragStart

  • parameters:
    • node: (typeof DOMNode)

      The node which is about to be dragged

    • coords: (typeof Object)

      an object encapsulating X and Y position

    • size: (typeof Object)

      an object encapsulating width and height values

  • summary

    Initialize the drag (see dojox.mdnd.Moveable.initOffsetDrag())

  • tags: callback
  • type

    Function

• dojox.mdnd.AreaManager._cover

  • type

    Object

• dojox.mdnd.AreaManager._cover2

  • type

    Object

• dojox.mdnd.AreaManager._cover.style.height

• dojox.mdnd.AreaManager._cover2.style.height

• dojox.mdnd.AreaManager._dragStartHandler

  • type

    Object

• dojox.mdnd.AreaManager._sourceIndexArea

  • type

    Number

• dojox.mdnd.AreaManager._lastValidIndexArea

  • type

    Object

• dojox.mdnd.AreaManager._dragItem

  • type

    Object

• dojox.mdnd.AreaManager._currentDropIndex

  • type

    Number

• dojox.mdnd.AreaManager._sourceDropIndex

  • type

    Number

• dojox.mdnd.AreaManager._eventsIE7

  • type

    Array

• dojox.mdnd.AreaManager.onDragEnter

  • parameters:
    • coords: (typeof Object)

      coordinates of the dragged Node.

    • size: (typeof Object)

      size of the dragged Node.

  • summary

    Optionally called by the getTargetArea method of TargetFinder class.

  • tags: callback
  • type

    Function

• dojox.mdnd.AreaManager.onDragExit

  • parameters:
    • coords: (typeof Object)

      coordinates of the dragged Node.

    • size: (typeof Object)

      size of the dragged Node.

  • summary

    Optionally called by the getTargetArea method of TargetFinder class.

  • tags: callback
  • type

    Function

• dojox.mdnd.AreaManager.onDrag

  • parameters:
    • node: (typeof DOMNode)

      The node which is dragged

    • 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

  • summary

    Occurs when the dojo.dnd.Moveable.onDrag is fired.
    Search the nearest target area and called the placeDropIndicator

  • tags: callback
  • type

    Function

• dojox.mdnd.AreaManager.placeDropIndicator

  • parameters:
    • coords: (typeof Object)

      an object encapsulating X and Y position

    • size: (typeof Object)

      an object encapsulating width and height values

  • returns

    Integer

  • summary

    Search the right place to insert the dropIndicator and display the dropIndicator.

  • return_summary

    the current drop index

  • type

    Function

• dojox.mdnd.AreaManager._oldDropIndex

  • type

    Number

• dojox.mdnd.AreaManager._placeDropIndicator

  • parameters:
    • size: (typeof Object)

      an object encapsulating width and height values

  • summary

    place the dropIndicator

  • tags:
  • type

    Function

• dojox.mdnd.AreaManager.onDropCancel

  • summary

    Cancel the drop.
    The dragNode returns into the source.

  • tags: callback
  • type

    Function

• dojox.mdnd.AreaManager.onDrop

  • parameters:
    • node: (typeof DOMNode)

      The node which is about to be dropped

  • summary

    Drop the dragged item where the dropIndicator is displayed.

  • tags: callback
  • type

    Function

• dojox.mdnd.AreaManager._resetAfterDrop

  • summary

    reset manager properties after dropping an item

  • tags:
  • type

    Function

• dojox.mdnd.AreaManager.destroy

  • summary

    Destroy the component.

  • type

    Function

• dojox.mdnd.AreaManager.resizeHandler

  • type

    Object

• dojox.mdnd._areaManager

  • type

    Object

• dojox.mdnd.areaManager

  • returns

    Object

  • summary

    Returns the current areaManager, creates one if it is not created yet.

  • type

    Function

• dojox.mdnd

  • type

    Object

• dojox

  • type

    Object