mxRubberband

Event handler that selects rectangular regions. This is not built-into mxGraph. To enable rubberband selection in a graph, use the following code.

Example

var rubberband = new mxRubberband(graph);

Summary

mxRubberband	Event handler that selects rectangular regions.
Functions
mxRubberband	Constructs an event handler that selects rectangular regions in the graph using rubberband selection.
Variables
defaultOpacity	Specifies the default opacity to be used for the rubberband div.
enabled	Specifies if events are handled.
div	Holds the DIV element which is currently visible.
sharedDiv	Holds the DIV element which is used to display the rubberband.
currentX	Holds the value of the x argument in the last call to update.
currentY	Holds the value of the y argument in the last call to update.
fadeOut	Optional fade out effect.
Functions
isEnabled	Returns true if events are handled.
setEnabled	Enables or disables event handling.
isForceRubberbandEvent	Returns true if the given mxMouseEvent should start rubberband selection.
mouseDown	Handles the event by initiating a rubberband selection.
start	Sets the start point for the rubberband selection.
mouseMove	Handles the event by updating therubberband selection.
createShape	Creates the rubberband selection shape.
isActive	Returns true if this handler is active.
mouseUp	Handles the event by selecting the region of the rubberband using mxGraph.selectRegion.
execute	Resets the state of this handler and selects the current region for the given event.
reset	Resets the state of the rubberband selection.
update	Sets currentX and currentY and calls repaint.
repaint	Computes the bounding box and updates the style of the div.
destroy	Destroys the handler and all its resources and DOM nodes.

Functions

mxRubberband

function mxRubberband( graph )

Constructs an event handler that selects rectangular regions in the graph using rubberband selection.

Variables

defaultOpacity

mxRubberband.prototype.defaultOpacity

Specifies the default opacity to be used for the rubberband div. Default is 20.

enabled

mxRubberband.prototype.enabled

Specifies if events are handled. Default is true.

div

mxRubberband.prototype.div

Holds the DIV element which is currently visible.

sharedDiv

mxRubberband.prototype.sharedDiv

Holds the DIV element which is used to display the rubberband.

currentX

mxRubberband.prototype.currentX

Holds the value of the x argument in the last call to update.

currentY

mxRubberband.prototype.currentY

Holds the value of the y argument in the last call to update.

fadeOut

mxRubberband.prototype.fadeOut

Optional fade out effect. Default is false.

Functions

isEnabled

mxRubberband.prototype.isEnabled = function()

Returns true if events are handled. This implementation returns enabled.

setEnabled

mxRubberband.prototype.setEnabled = function( enabled )

Enables or disables event handling. This implementation updates enabled.

isForceRubberbandEvent

mxRubberband.prototype.isForceRubberbandEvent = function( me )

Returns true if the given mxMouseEvent should start rubberband selection. This implementation returns true if the alt key is pressed.

mouseDown

mxRubberband.prototype.mouseDown = function( sender,
me )

Handles the event by initiating a rubberband selection. By consuming the event all subsequent events of the gesture are redirected to this handler.

start

mxRubberband.prototype.start = function( x,
y )

Sets the start point for the rubberband selection.

mouseMove

mxRubberband.prototype.mouseMove = function( sender,
me )

Handles the event by updating therubberband selection.

createShape

mxRubberband.prototype.createShape = function()

Creates the rubberband selection shape.

isActive

mxRubberband.prototype.isActive = function( sender,
me )

Returns true if this handler is active.

mouseUp

mxRubberband.prototype.mouseUp = function( sender,
me )

Handles the event by selecting the region of the rubberband using mxGraph.selectRegion.

execute

mxRubberband.prototype.execute = function( evt )

Resets the state of this handler and selects the current region for the given event.

reset

mxRubberband.prototype.reset = function()

Resets the state of the rubberband selection.

update

mxRubberband.prototype.update = function( x,
y )

Sets currentX and currentY and calls repaint.

repaint

mxRubberband.prototype.repaint = function()

Computes the bounding box and updates the style of the div.

destroy

mxRubberband.prototype.destroy = function()

Destroys the handler and all its resources and DOM nodes. This does normally not need to be called, it is called automatically when the window unloads.