mxEdgeHandler

function mxEdgeHandler( state )

Constructs an edge handler for the specified mxCellState.

Parameters

mxEdgeHandler.prototype.init = function()

Initializes the shapes required for this edge handler.

mxEdgeHandler.prototype.createCustomHandles = function()

Returns an array of custom handles.  This implementation returns null.

mxEdgeHandler.prototype.isVirtualBendsEnabled = function( evt )

Returns true if virtual bends should be added.  This returns true if virtualBendsEnabled is true and the current style allows and renders custom waypoints.

mxEdgeHandler.prototype.isCellEnabled = function( cell )

Returns true if the given cell allows new connections to be created.  This implementation always returns true.

mxEdgeHandler.prototype.isAddPointEvent = function( evt )

Returns true if the given event is a trigger to add a new point.  This implementation returns true if shift is pressed.

mxEdgeHandler.prototype.isRemovePointEvent = function( evt )

Returns true if the given event is a trigger to remove a point.  This implementation returns true if shift is pressed.

mxEdgeHandler.prototype.getSelectionPoints = function( state )

Returns the list of points that defines the selection stroke.

Creates the shape used to draw the selection border.

mxEdgeHandler.prototype.createSelectionShape = function( points )

Creates the shape used to draw the selection border.

mxEdgeHandler.prototype.getSelectionColor = function()

Returns mxConstants.EDGE_SELECTION_COLOR.

mxEdgeHandler.prototype.getSelectionStrokeWidth = function()

Returns mxConstants.EDGE_SELECTION_STROKEWIDTH.

mxEdgeHandler.prototype.isSelectionDashed = function()

Returns <mxConstants.EDGE_SELECTION_DASHED>.

mxEdgeHandler.prototype.isConnectableCell = function( cell )

Returns true if the given cell is connectable.  This is a hook to disable floating connections.  This implementation returns true.

mxEdgeHandler.prototype.getCellAt = function( x, y )

Creates and returns the mxCellMarker used in marker.

mxEdgeHandler.prototype.createMarker = function()

Creates and returns the mxCellMarker used in marker.

mxEdgeHandler.prototype.validateConnection = function( source, target )

Returns the error message or an empty string if the connection for the given source, target pair is not valid.  Otherwise it returns null.  This implementation uses mxGraph.getEdgeValidationError.

Parameters

mxEdgeHandler.prototype.createBends = function()

Creates and returns the bends used for modifying the edge.  This is typically an array of mxRectangleShapes.

mxEdgeHandler.prototype.createVirtualBends = function()

Creates and returns the bends used for modifying the edge.  This is typically an array of mxRectangleShapes.

mxEdgeHandler.prototype.isHandleEnabled = function( index )

Creates the shape used to display the given bend.

mxEdgeHandler.prototype.isHandleVisible = function( index )

Returns true if the handle at the given index is visible.

mxEdgeHandler.prototype.createHandleShape = function( index )

Creates the shape used to display the given bend.  Note that the index may be null for special cases, such as when called from mxElbowEdgeHandler.createVirtualBend.  Only images and rectangles should be returned if support for HTML labels with not foreign objects is required.  Index if null for virtual handles.

mxEdgeHandler.prototype.createLabelHandleShape = function()

Creates the shape used to display the the label handle.

mxEdgeHandler.prototype.initBend = function( bend, dblClick )

Helper method to initialize the given bend.

Parameters

mxEdgeHandler.prototype.getHandleForEvent = function( me )

Returns the index of the handle for the given event.

mxEdgeHandler.prototype.isAddVirtualBendEvent = function( me )

Returns true if the given event allows virtual bends to be added.  This implementation returns true.

mxEdgeHandler.prototype.isCustomHandleEvent = function( me )

Returns true if the given event allows custom handles to be changed.  This implementation returns true.

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

Handles the event by checking if a special element of the handler was clicked, in which case the index parameter is non-null.  The indices may be one of <LABEL_HANDLE> or the number of the respective control point.  The source and target points are used for reconnecting the edge.

mxEdgeHandler.prototype.start = function( x, y, index )

Starts the handling of the mouse gesture.

mxEdgeHandler.prototype.clonePreviewState = function( point, terminal )

Returns a clone of the current preview state for the given point and terminal.

mxEdgeHandler.prototype.getSnapToTerminalTolerance = function()

Returns the tolerance for the guides.  Default value is gridSize * scale / 2.

mxEdgeHandler.prototype.updateHint = function( me, point )

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

mxEdgeHandler.prototype.removeHint = function()

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

mxEdgeHandler.prototype.roundLength = function( length )

Hook for rounding the unscaled width or height.  This uses Math.round.

mxEdgeHandler.prototype.isSnapToTerminalsEvent = function( me )

Returns true if snapToTerminals is true and if alt is not pressed.

mxEdgeHandler.prototype.getPointForEvent = function( me )

Returns the point for the given event.

mxEdgeHandler.prototype.getPreviewTerminalState = function( me )

Updates the given preview state taking into account the state of the constraint handler.

mxEdgeHandler.prototype.getPreviewPoints = function( pt, me )

Updates the given preview state taking into account the state of the constraint handler.

Parameters

mxEdgeHandler.prototype.isOutlineConnectEvent = function( me )

Returns true if outlineConnect is true and the source of the event is the outline shape or shift is pressed.

mxEdgeHandler.prototype.updatePreviewState = function( edge, point, terminalState, me, outline )

Updates the given preview state taking into account the state of the constraint handler.

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

Handles the event by updating the preview.

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

Handles the event to applying the previewed changes on the edge by using moveLabel, connect or changePoints.

mxEdgeHandler.prototype.reset = function()

Resets the state of this handler.

mxEdgeHandler.prototype.setPreviewColor = function( color )

Sets the color of the preview to the given value.

mxEdgeHandler.prototype.convertPoint = function( point, gridEnabled )

Converts the given point in-place from screen to unscaled, untranslated graph coordinates and applies the grid.  Returns the given, modified point instance.

Parameters

mxEdgeHandler.prototype.moveLabel = function( edgeState, x, y )

Changes the coordinates for the label of the given edge.

Parameters

mxEdgeHandler.prototype.connect = function( edge, terminal, isSource, isClone, me )

Changes the terminal or terminal point of the given edge in the graph model.

Parameters

mxEdgeHandler.prototype.changeTerminalPoint = function( edge, point, isSource, clone )

Changes the terminal point of the given edge.

mxEdgeHandler.prototype.changePoints = function( edge, points, clone )

Changes the control points of the given edge in the graph model.

mxEdgeHandler.prototype.addPoint = function( state, evt )

Adds a control point for the given state and event.

mxEdgeHandler.prototype.addPointAt = function( state, x, y )

Adds a control point at the given point.

mxEdgeHandler.prototype.removePoint = function( state, index )

Removes the control point at the given index from the given state.

mxEdgeHandler.prototype.getHandleFillColor = function( index )

Returns the fillcolor for the handle at the given index.

mxEdgeHandler.prototype.redraw = function( ignoreHandles )

Redraws the preview, and the bends- and label control points.

mxEdgeHandler.prototype.redrawHandles = function()

Redraws the handles.

mxEdgeHandler.prototype.isCustomHandleVisible = function( handle )

Returns true if the given custom handle is visible.

Shortcut to <hideSizers>.

mxEdgeHandler.prototype.redrawInnerBends = function( p0, pe )

Updates and redraws the inner bends.

Parameters

mxEdgeHandler.prototype.checkLabelHandle = function( b )

Checks if the label handle intersects the given bounds and moves it if it intersects.

mxEdgeHandler.prototype.drawPreview = function()

Redraws the preview.

mxEdgeHandler.prototype.refresh = function()

Refreshes the bends of this handler.

mxEdgeHandler.prototype.destroyBends = function( bends )

Destroys all elements in bends.

mxEdgeHandler.prototype.destroy = function()

Destroys the handler and all its resources and DOM nodes.  This does normally not need to be called as handlers are destroyed automatically when the corresponding cell is deselected.