dojox/dnd/BoundingBoxController.js

• Provides:

  • dojox.dnd.BoundingBoxController

• dojox.dnd.BoundingBoxController

  • type

    Function

  • parameters:
    • sources: (typeof Array:)

      an array of dojox.dnd.Selectors which need to be aware of
      the positioning of the bounding box.

    • domNode: (typeof String|DomNode:)

      the DOM node or id which represents the bounding box on the page.

  • summary

    Allows the user draw bounding boxes around nodes on the page.
    Publishes to the "/dojox/dnd/bounding" topic to tell the selector to check
    to see whether any dnd items fall within the coordinates of the bounding box

• dojox.dnd.BoundingBoxController._startX

  • type

    Object

• dojox.dnd.BoundingBoxController._startY

  • type

    Object

• dojox.dnd.BoundingBoxController._endX

  • type

    Object

• dojox.dnd.BoundingBoxController._endY

  • type

    Object

• dojox.dnd.BoundingBoxController.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • sources: (typeof Array:)

      an array of dojox.dnd.Selectors which need to be aware of
      the positioning of the bounding box.

    • domNode: (typeof String|DomNode:)

      the DOM node or id which represents the bounding box on the page.

  • summary

    Sets mouse handlers for the document to capture when a user
    is trying to draw a bounding box.

• dojox.dnd.BoundingBoxController.destroy

  • summary

    prepares this object to be garbage-collected

  • type

    Function

• dojox.dnd.BoundingBoxController.domNode

  • type

    String|DomNode:

  • summary

    the DOM node or id which represents the bounding box on the page.

• dojox.dnd.BoundingBoxController.boundingBoxIsViable

  • summary

    Override-able by the client as an extra check to ensure that a bounding
    box is viable. In some instances, it might not make sense that
    a mouse down -> mouse move -> mouse up interaction represents a bounding box.
    For example, if a dialog is open the client might want to suppress a bounding
    box. This function could be used by the client to ensure that a bounding box is only
    drawn on the document when certain conditions are met.

  • type

    Function

• dojox.dnd.BoundingBoxController._onMouseDown

  • parameters:
    • evt: (typeof Object:)

      the mouse event which caused this callback to fire.

  • summary

    Executed when the user mouses down on the document. Resets the
    this._startX and this._startY member variables.

  • type

    Function

• dojox.dnd.BoundingBoxController._onMouseMove

  • parameters:
    • evt: (typeof Object:)

      the mouse event which caused this callback to fire.

  • summary

    Executed when the user moves the mouse over the document. Delegates to
    this._drawBoundingBox if the user is trying to draw a bounding box.
    whether the user was drawing a bounding box and publishes to the
    "/dojox/dnd/bounding" topic if the user is finished drawing their bounding box.

  • type

    Function

• dojox.dnd.BoundingBoxController._onMouseUp

  • parameters:
    • evt: (typeof Object:)

      the mouse event which caused this callback to fire.

  • summary

    Executed when the users mouses up on the document. Checks to see
    whether the user was drawing a bounding box and publishes to the
    "/dojox/dnd/bounding" topic if the user is finished drawing their bounding box.

  • type

    Function

• dojox.dnd.BoundingBoxController._finishSelecting

  • summary

    hide the bounding box and reset for the next time around

  • type

    Function

• dojox.dnd.BoundingBoxController._drawBoundingBox

  • summary

    draws the bounding box over the document.

  • type

    Function

• dojox.dnd.BoundingBoxController.events

  • type

    Array

• dojox.dnd.BoundingBoxController.subscriptions

  • type

    Array

• dojox.dnd

  • type

    Object

• dojox

  • type

    Object