dojox/dnd/BoundingBoxController.js

• Provides:

  • dojox.dnd.BoundingBoxController

• dojox.dnd.BoundingBoxController

  • type

    Function

  • summary

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

  • 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.

  • source: [view]
       this.events = [
        dojo.connect(dojo.doc, "onmousedown", this, "_onMouseDown"),
        dojo.connect(dojo.doc, "onmouseup", this, "_onMouseUp"),
        // cancel text selection and text dragging
        //dojo.connect(dojo.doc, "ondragstart", dojo.stopEvent),
        //dojo.connect(dojo.doc, "onselectstart", dojo.stopEvent),
        // when a user is scrolling using a scrollbar, don't draw the bounding box.
        dojo.connect(dojo.doc, "onscroll", this, "_finishSelecting")
       ];
       // set up a subscription so the client can easily cancel a user drawing a bounding box.
       this.subscriptions = [
        dojo.subscribe("/dojox/bounding/cancel", this, "_finishSelecting")
       ];
       dojo.forEach(sources, function(item){
        // listen for "/dojox/dnd/bounding" events eminating from the bounding box.
        // for each of the dojox.dnd.selectors passed in args.
        if(item.selectByBBox){
         this.subscriptions.push(dojo.subscribe("/dojox/dnd/bounding", item, "selectByBBox"));
        }
       }, this)
       this.domNode = dojo.byId(domNode);
       dojo.style(this.domNode, {
        position: "absolute",
        display: "none"
       });

• dojox.dnd.BoundingBoxController._startX

  • summary

• dojox.dnd.BoundingBoxController._startY

  • summary

• dojox.dnd.BoundingBoxController._endX

  • summary

• dojox.dnd.BoundingBoxController._endY

  • summary

• dojox.dnd.BoundingBoxController.destroy

  • type

    Function

  • source: [view]
       dojo.forEach(this.events, dojo.disconnect);
       dojo.forEach(this.subscriptions, dojo.unsubscribe);
       this.domNode = null;
  • summary

    prepares this object to be garbage-collected

• dojox.dnd.BoundingBoxController.boundingBoxIsViable

  • type

    Function

  • source: [view]
       return true;
  • 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.

• dojox.dnd.BoundingBoxController._onMouseDown

  • type

    Function

  • parameters:
    • evt: (typeof Object)

      the mouse event which caused this callback to fire.

  • source: [view]
       if(dojo.mouseButtons.isLeft(evt)){
        if(this._startX === null){
         this._startX = evt.clientX;
         this._startY = evt.clientY;
        }
        this.events.push(
         dojo.connect(dojo.doc, "onmousemove", this, "_onMouseMove")
        );
       }
  • summary

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

• dojox.dnd.BoundingBoxController._onMouseMove

  • type

    Function

  • parameters:
    • evt: (typeof Object)

      the mouse event which caused this callback to fire.

  • source: [view]
       this._endX = evt.clientX;
       this._endY = evt.clientY;
       this._drawBoundingBox();
  • 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.

• dojox.dnd.BoundingBoxController._onMouseUp

  • type

    Function

  • parameters:
    • evt: (typeof Object)

      the mouse event which caused this callback to fire.

  • source: [view]
       if(this._endX !== null && this.boundingBoxIsViable()){
        // the user has moused up ... tell the selector to check to see whether
        // any nodes within the bounding box need to be selected.
        dojo.publish("/dojox/dnd/bounding", [this._startX, this._startY, this._endX, this._endY]);
       }
       this._finishSelecting();
  • 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.

• dojox.dnd.BoundingBoxController._finishSelecting

  • type

    Function

  • source: [view]
       if(this._startX !== null){
        dojo.disconnect(this.events.pop());
        dojo.style(this.domNode, "display", "none");
        this._startX = this._endX = null;
       }
  • summary

    hide the bounding box and reset for the next time around

• dojox.dnd.BoundingBoxController._drawBoundingBox

  • type

    Function

  • source: [view]
       dojo.style(this.domNode, {
        left: Math.min(this._startX, this._endX) + "px",
        top: Math.min(this._startY, this._endY) + "px",
        width: Math.abs(this._startX - this._endX) + "px",
        height: Math.abs(this._startY - this._endY) + "px",
        display: ""
       });
  • summary

    draws the bounding box over the document.

• dojox.dnd.BoundingBoxController.domNode

  • type

    String|DomNode

  • summary

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

• dojox.dnd.BoundingBoxController.events

  • summary

• dojox.dnd.BoundingBoxController.subscriptions

  • summary

• dojox.dnd

  • type

    Object

  • summary

• dojox

  • type

    Object

  • summary