Graph event handler that handles selection. Individual cells are handled separately using mxVertexHandler or one of the edge handlers. These handlers are created using mxGraph.createHandler in mxGraphSelectionModel.cellAdded.
To avoid the container to scroll a moved cell into view, set <scrollAfterMove> to false.
| mxGraphHandler | Graph event handler that handles selection. |
| Functions | |
| mxGraphHandler | Constructs an event handler that creates handles for the selection cells. |
| Variables | |
| graph | Reference to the enclosing mxGraph. |
| maxCells | Defines the maximum number of cells to paint subhandles for. |
| enabled | Specifies if events are handled. |
| highlightEnabled | Specifies if drop targets under the mouse should be enabled. |
| cloneEnabled | Specifies if cloning by control-drag is enabled. |
| moveEnabled | Specifies if moving is enabled. |
| guidesEnabled | Specifies if other cells should be used for snapping the right, center or left side of the current selection. |
| guide | Holds the mxGuide instance that is used for alignment. |
| currentDx | Stores the x-coordinate of the current mouse move. |
| currentDy | Stores the y-coordinate of the current mouse move. |
| updateCursor | Specifies if a move cursor should be shown if the mouse is ove a movable cell. |
| selectEnabled | Specifies if selecting is enabled. |
| removeCellsFromParent | Specifies if cells may be moved out of their parents. |
| connectOnDrop | Specifies if drop events are interpreted as new connections if no other drop action is defined. |
| scrollOnMove | Specifies if the view should be scrolled so that a moved cell is visible. |
| minimumSize | Specifies the minimum number of pixels for the width and height of a selection border. |
| previewColor | Specifies the color of the preview shape. |
| htmlPreview | Specifies if the graph container should be used for preview. |
| shape | Reference to the mxShape that represents the preview. |
| scaleGrid | Specifies if the grid should be scaled. |
| crisp | Specifies if the move preview should be rendered in crisp mode if applicable. |
| Functions | |
| isEnabled | Returns enabled. |
| setEnabled | Sets enabled. |
| isCloneEnabled | Returns cloneEnabled. |
| setCloneEnabled | Sets cloneEnabled. |
| isMoveEnabled | Returns moveEnabled. |
| setMoveEnabled | Sets moveEnabled. |
| isSelectEnabled | Returns selectEnabled. |
| setSelectEnabled | Sets selectEnabled. |
| isRemoveCellsFromParent | Returns removeCellsFromParent. |
| setRemoveCellsFromParent | Sets removeCellsFromParent. |
| getInitialCellForEvent | Hook to return initial cell for the given event. |
| isDelayedSelection | Hook to return true for delayed selections. |
| mouseDown | Handles the event by selecing the given cell and creating a handle for it. |
| getGuideStates | Creates an array of cell states which should be used as guides. |
| getCells | Returns the cells to be modified by this handler. |
| getPreviewBounds | Returns the mxRectangle used as the preview bounds for moving the given cells. |
| createPreviewShape | Creates the shape used to draw the preview for the given bounds. |
| start | Starts the handling of the mouse gesture. |
| useGuidesForEvent | Returns true if the guides should be used for the given mxMouseEvent. |
| snap | Snaps the given vector to the grid and returns the given mxPoint instance. |
| mouseMove | Handles the event by highlighting possible drop targets and updating the preview. |
| updatePreviewShape | Updates the bounds of the preview shape. |
| setHighlightColor | Sets the color of the rectangle used to highlight drop targets. |
| mouseUp | Handles the event by applying the changes to the selection cells. |
| selectDelayed | Implements the delayed selection for the given mouse event. |
| reset | Resets the state of this handler. |
| shouldRemoveCellsFromParent | Returns true if the given cells should be removed from the parent for the specified mousereleased event. |
| moveCells | Moves the given cells by the specified amount. |
| destroyShapes | Destroy the preview and highlight shapes. |
| destroy | Destroys the handler and all its resources and DOM nodes. |
function mxGraphHandler( graph )
Constructs an event handler that creates handles for the selection cells.
| graph | Reference to the enclosing mxGraph. |
mxGraphHandler.prototype.graph
Reference to the enclosing mxGraph.
mxGraphHandler.prototype.maxCells
Defines the maximum number of cells to paint subhandles for. Default is 50 for Firefox and 20 for IE. Set this to 0 if you want an unlimited number of handles to be displayed. This is only recommended if the number of cells in the graph is limited to a small number, eg. 500.
mxGraphHandler.prototype.guide
Holds the mxGuide instance that is used for alignment.
mxGraphHandler.prototype.htmlPreview
Specifies if the graph container should be used for preview. If this is used then drop target detection relies entirely on mxGraph.getCellAt because the HTML preview does not “let events through”. Default is false.
mxGraphHandler.prototype.shape
Reference to the mxShape that represents the preview.
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.
| value | Boolean that specifies the new clone enabled state. |
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.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.
| initialCell | mxCell that triggered this handler. |
mxGraphHandler.prototype.getPreviewBounds = function( cells )
Returns the mxRectangle used as the preview bounds for moving the given cells.
mxGraphHandler.prototype.useGuidesForEvent = function( me )
Returns true if the guides should be used for the given mxMouseEvent. This implementation returns mxGuide.isEnabledForEvent.
Constructs an event handler that creates handles for the selection cells.
function mxGraphHandler( graph )
Reference to the enclosing mxGraph.
mxGraphHandler.prototype.graph
Defines the maximum number of cells to paint subhandles for.
mxGraphHandler.prototype.maxCells
Specifies if events are handled.
mxGraphHandler.prototype.enabled
Specifies if drop targets under the mouse should be enabled.
mxGraphHandler.prototype.highlightEnabled
Specifies if cloning by control-drag is enabled.
mxGraphHandler.prototype.cloneEnabled
Specifies if moving is enabled.
mxGraphHandler.prototype.moveEnabled
Specifies if other cells should be used for snapping the right, center or left side of the current selection.
mxGraphHandler.prototype.guidesEnabled
Holds the mxGuide instance that is used for alignment.
mxGraphHandler.prototype.guide
Stores the x-coordinate of the current mouse move.
mxGraphHandler.prototype.currentDx
Stores the y-coordinate of the current mouse move.
mxGraphHandler.prototype.currentDy
Specifies if a move cursor should be shown if the mouse is ove a movable cell.
mxGraphHandler.prototype.updateCursor
Specifies if selecting is enabled.
mxGraphHandler.prototype.selectEnabled
Specifies if cells may be moved out of their parents.
mxGraphHandler.prototype.removeCellsFromParent
Specifies if drop events are interpreted as new connections if no other drop action is defined.
mxGraphHandler.prototype.connectOnDrop
Specifies if the view should be scrolled so that a moved cell is visible.
mxGraphHandler.prototype.scrollOnMove
Specifies the minimum number of pixels for the width and height of a selection border.
mxGraphHandler.prototype.minimumSize
Specifies the color of the preview shape.
mxGraphHandler.prototype.previewColor
Specifies if the graph container should be used for preview.
mxGraphHandler.prototype.htmlPreview
Reference to the mxShape that represents the preview.
mxGraphHandler.prototype.shape
Specifies if the grid should be scaled.
mxGraphHandler.prototype.scaleGrid
Specifies if the move preview should be rendered in crisp mode if applicable.
mxGraphHandler.prototype.crisp
Returns enabled.
mxGraphHandler.prototype.isEnabled = function()
Sets enabled.
mxGraphHandler.prototype.setEnabled = function( value )
Returns cloneEnabled.
mxGraphHandler.prototype.isCloneEnabled = function()
Sets cloneEnabled.
mxGraphHandler.prototype.setCloneEnabled = function( value )
Returns moveEnabled.
mxGraphHandler.prototype.isMoveEnabled = function()
Sets moveEnabled.
mxGraphHandler.prototype.setMoveEnabled = function( value )
Returns selectEnabled.
mxGraphHandler.prototype.isSelectEnabled = function()
Sets selectEnabled.
mxGraphHandler.prototype.setSelectEnabled = function( value )
Returns removeCellsFromParent.
mxGraphHandler.prototype.isRemoveCellsFromParent = function()
Sets removeCellsFromParent.
mxGraphHandler.prototype.setRemoveCellsFromParent = function( value )
Hook to return initial cell for the given event.
mxGraphHandler.prototype.getInitialCellForEvent = function( me )
Hook to return true for delayed selections.
mxGraphHandler.prototype.isDelayedSelection = function( cell )
Handles the event by selecing the given cell and creating a handle for it.
mxGraphHandler.prototype.mouseDown = function( sender, me )
Creates an array of cell states which should be used as guides.
mxGraphHandler.prototype.getGuideStates = function()
Returns the cells to be modified by this handler.
mxGraphHandler.prototype.getCells = function( initialCell )
Returns the mxRectangle used as the preview bounds for moving the given cells.
mxGraphHandler.prototype.getPreviewBounds = function( cells )
Creates the shape used to draw the preview for the given bounds.
mxGraphHandler.prototype.createPreviewShape = function( bounds )
Starts the handling of the mouse gesture.
mxGraphHandler.prototype.start = function( cell, x, y )
Returns true if the guides should be used for the given mxMouseEvent.
mxGraphHandler.prototype.useGuidesForEvent = function( me )
Snaps the given vector to the grid and returns the given mxPoint instance.
mxGraphHandler.prototype.snap = function( vector )
Handles the event by highlighting possible drop targets and updating the preview.
mxGraphHandler.prototype.mouseMove = function( sender, me )
Updates the bounds of the preview shape.
mxGraphHandler.prototype.updatePreviewShape = function()
Sets the color of the rectangle used to highlight drop targets.
mxGraphHandler.prototype.setHighlightColor = function( color )
Handles the event by applying the changes to the selection cells.
mxGraphHandler.prototype.mouseUp = function( sender, me )
Implements the delayed selection for the given mouse event.
mxGraphHandler.prototype.selectDelayed = function( me )
Resets the state of this handler.
mxGraphHandler.prototype.reset = function()
Returns true if the given cells should be removed from the parent for the specified mousereleased event.
mxGraphHandler.prototype.shouldRemoveCellsFromParent = function( parent, cells, evt )
Moves the given cells by the specified amount.
mxGraphHandler.prototype.moveCells = function( cells, dx, dy, clone, target, evt )
Destroy the preview and highlight shapes.
mxGraphHandler.prototype.destroyShapes = function()
Destroys the handler and all its resources and DOM nodes.
mxGraphHandler.prototype.destroy = function()
Creates a new handler for the given cell state.
mxGraph.prototype.createHandler = function( state )
Inner callback to add the specified mxCell to the selection.
mxGraphSelectionModel.prototype.cellAdded = function( cell )
Returns the bottom-most cell that intersects the given point (x, y) in the cell hierarchy starting at the given parent.
mxGraph.prototype.getCellAt = function( x, y, parent, vertices, edges )
Returns true if the guide should be enabled for the given native event.
mxGuide.prototype.isEnabledForEvent = function( evt )