mxGraphHandler

function mxGraphHandler( graph )

Constructs an event handler that creates handles for the selection cells.

Parameters

mxGraphHandler.prototype.isEnabled = function()

Returns enabled.

mxGraphHandler.prototype.setEnabled = function( value )

Sets enabled.

mxGraphHandler.prototype.isCloneEnabled = function()

Returns cloneEnabled.

mxGraphHandler.prototype.setCloneEnabled = function( value )

Sets cloneEnabled.

Parameters

mxGraphHandler.prototype.isMoveEnabled = function()

Returns moveEnabled.

mxGraphHandler.prototype.setMoveEnabled = function( value )

Sets moveEnabled.

mxGraphHandler.prototype.isSelectEnabled = function()

Returns selectEnabled.

mxGraphHandler.prototype.setSelectEnabled = function( value )

Sets selectEnabled.

mxGraphHandler.prototype.isRemoveCellsFromParent = function()

Returns removeCellsFromParent.

mxGraphHandler.prototype.setRemoveCellsFromParent = function( value )

Sets removeCellsFromParent.

mxGraphHandler.prototype.isPropagateSelectionCell = function( cell, immediate, me )

Returns true if the given cell and parent should propagate selection state to the parent.

mxGraphHandler.prototype.getInitialCellForEvent = function( me )

Hook to return initial cell for the given event.  This returns the topmost cell that is not a swimlane or is selected.

mxGraphHandler.prototype.isDelayedSelection = function( cell, me )

Returns true if the cell or one of its ancestors is selected.

mxGraphHandler.prototype.selectDelayed = function( me )

Implements the delayed selection for the given mouse event.

mxGraphHandler.prototype.selectCellForEvent = function( cell, me )

Selects the given cell for the given mxMouseEvent.

mxGraphHandler.prototype.consumeMouseEvent = function( evtName, me )

Consumes the given mouse event.  NOTE: This may be used to enable click events for links in labels on iOS as follows as consuming the initial touchStart disables firing the subsequent click event on the link.

<code> mxGraphHandler.prototype.consumeMouseEvent = function(evtName, me) { var source = mxEvent.getSource(me.getEvent());

if (!mxEvent.isTouchEvent(me.getEvent()) || source.nodeName != ‘A’) { me.consume(); } } </code>

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

Handles the event by selecing the given cell and creating a handle for it.  By consuming the event all subsequent events of the gesture are redirected to this handler.

mxGraphHandler.prototype.getGuideStates = function()

Creates an array of cell states which should be used as guides.

mxGraphHandler.prototype.getCells = function( initialCell )

Returns the cells to be modified by this handler.  This implementation returns all selection cells that are movable, or the given initial cell if the given cell is not selected and movable.  This handles the case of moving unselectable or unselected cells.

Parameters

mxGraphHandler.prototype.getPreviewBounds = function( cells )

Returns the mxRectangle used as the preview bounds for moving the given cells.

mxGraphHandler.prototype.getBoundingBox = function( cells )

Returns the union of the mxCellStates for the given array of mxCells.  For vertices, this method uses the bounding box of the corresponding shape if one exists.  The bounding box of the corresponding text label and all controls and overlays are ignored.  See also: mxGraphView.getBounds and mxGraph.getBoundingBox.

Parameters

mxGraphHandler.prototype.createPreviewShape = function( bounds )

Creates the shape used to draw the preview for the given bounds.

mxGraphHandler.prototype.start = function( cell, x, y, cells )

Starts the handling of the mouse gesture.

mxGraphHandler.prototype.addStates = function( cell, dict )

Adds the states for the given cell recursively to the given dictionary.

mxGraphHandler.prototype.isCellMoving = function( cell )

Returns true if the given cell is currently being moved.

mxGraphHandler.prototype.useGuidesForEvent = function( me )

Returns true if the guides should be used for the given mxMouseEvent.  This implementation returns mxGuide.isEnabledForEvent.

mxGraphHandler.prototype.snap = function( vector )

Snaps the given vector to the grid and returns the given mxPoint instance.

mxGraphHandler.prototype.getDelta = function( me )

Returns an mxPoint that represents the vector for moving the cells for the given mxMouseEvent.

mxGraphHandler.prototype.updateHint = function( me )

Hook for subclassers do show details while the handler is active.

mxGraphHandler.prototype.removeHint = function()

Hooks for subclassers to hide details when the handler gets inactive.

mxGraphHandler.prototype.roundLength = function( length )

Hook for rounding the unscaled vector.  Allows for half steps in the raster so numbers coming in should be rounded if no half steps are allowed (ie for non aligned standard moving where pixel steps should be preferred).

mxGraphHandler.prototype.isValidDropTarget = function( target, me )

Returns true if the given cell is a valid drop target.

mxGraphHandler.prototype.checkPreview = function()

Updates the preview if cloning state has changed.

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

Handles the event by highlighting possible drop targets and updating the preview.

mxGraphHandler.prototype.updatePreview = function( remote )

Updates the bounds of the preview shape.

mxGraphHandler.prototype.updatePreviewShape = function()

Updates the bounds of the preview shape.

mxGraphHandler.prototype.updateLivePreview = function( dx, dy )

Updates the bounds of the preview shape.

mxGraphHandler.prototype.redrawHandles = function( states )

Redraws the preview shape for the given states array.

mxGraphHandler.prototype.resetPreviewStates = function( states )

Resets the given preview states array.

mxGraphHandler.prototype.suspend = function()

Suspends the livew preview.

mxGraphHandler.prototype.resume = function()

Suspends the livew preview.

mxGraphHandler.prototype.resetLivePreview = function()

Resets the livew preview.

mxGraphHandler.prototype.setHandlesVisibleForCells = function( cells, visible, force )

Sets wether the handles attached to the given cells are visible.

Parameters

mxGraphHandler.prototype.setHighlightColor = function( color )

Sets the color of the rectangle used to highlight drop targets.

Parameters

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

Handles the event by applying the changes to the selection cells.

mxGraphHandler.prototype.reset = function()

Resets the state of this handler.

mxGraphHandler.prototype.shouldRemoveCellsFromParent = function( parent, cells, evt )

Returns true if the given cells should be removed from the parent for the specified mousereleased event.

mxGraphHandler.prototype.moveCells = function( cells, dx, dy, clone, target, evt )

Moves the given cells by the specified amount.

mxGraphHandler.prototype.shouldRemoveParent = function( parent )

Returns true if the given parent should be removed after removal of child cells.

mxGraphHandler.prototype.destroyShapes = function()

Destroy the preview and highlight shapes.

mxGraphHandler.prototype.destroy = function()

Destroys the handler and all its resources and DOM nodes.