Class ConstraintHandler

constructor

• new ConstraintHandler(graph): ConstraintHandler

• Parameters

  • graph: Graph

  Returns ConstraintHandler

constraints

currentConstraint

currentFocus

currentFocusArea

currentPoint

enabled

focusHighlight

focusIcons

focusPoints

graph

highlightColor

mouseleaveHandler

pointImage

resetHandler

createHighlightShape

• createHighlightShape(): RectangleShape

• Create the shape used to paint the highlight.

  Returns true if the given icon intersects the given point.

  Returns RectangleShape

destroyFocusHighlight

• destroyFocusHighlight(): void

• Destroys the focusHighlight if one exists.

  Returns void

destroyIcons

• destroyIcons(): void

• Destroys the focusIcons if they exist.

  Returns void

getCellForEvent

• getCellForEvent(me, point): null | Cell

• Returns the cell for the given event.

  Parameters

  • me: InternalMouseEvent
  • point: null | Point

  Returns null | Cell

getImageForConstraint

• getImageForConstraint(state, constraint, point): ImageBox

• Returns the tolerance to be used for intersecting connection points.

  Parameters

  • state: CellState
  • constraint: ConnectionConstraint
  • point: Point

  Returns ImageBox

getTolerance

• getTolerance(me): number

• Returns the tolerance to be used for intersecting connection points. This implementation returns mxGraph.tolerance.

  Parameters

  • me: InternalMouseEvent

    mxMouseEvent whose tolerance should be returned.

  Returns number

intersects

• intersects(icon, mouse, source, existingEdge): boolean

• Returns true if the given icon intersects the given rectangle.

  Parameters

  • icon: ImageShape
  • mouse: Rectangle
  • source: boolean
  • existingEdge: boolean

  Returns boolean

isEnabled

• isEnabled(): boolean

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

  Returns boolean

isEventIgnored

• isEventIgnored(me, source?): boolean

• Returns true if the given mxMouseEvent should be ignored in update. This implementation always returns false.

  Parameters

  • me: InternalMouseEvent
  • source: boolean = false

  Returns boolean

isKeepFocusEvent

• isKeepFocusEvent(me): boolean

• Returns true if the current focused state should not be changed for the given event. This returns true if shift and alt are pressed.

  Parameters

  • me: InternalMouseEvent

  Returns boolean

isStateIgnored

• isStateIgnored(state, source?): boolean

• Returns true if the given state should be ignored. This always returns false.

  Parameters

  • state: CellState
  • source: boolean = false

  Returns boolean

onDestroy

• onDestroy(): void

• Destroy this handler.

  Returns void

redraw

• redraw(): void

• Transfers the focus to the given state as a source or target terminal. If the handler is not enabled then the outline is painted, but the constraints are ignored.

  Returns void

reset

• reset(): void

• Resets the state of this handler.

  Returns void

setEnabled

• setEnabled(enabled): void

• Enables or disables event handling. This implementation updates enabled.

  Parameters

  • enabled: boolean

    Boolean that specifies the new enabled state.

  Returns void

setFocus

• setFocus(me, state, source): void

• Transfers the focus to the given state as a source or target terminal. If the handler is not enabled then the outline is painted, but the constraints are ignored.

  Parameters

  • me: InternalMouseEvent
  • state: null | CellState
  • source: boolean

  Returns void

update

• update(me, source, existingEdge, point): void

• Updates the state of this handler based on the given mxMouseEvent. Source is a boolean indicating if the cell is a source or target.

  Parameters

  • me: InternalMouseEvent
  • source: boolean
  • existingEdge: boolean
  • point: null | Point

  Returns void