org.eclipse.gef4.fx.nodes

Class Connection

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.Group

org.eclipse.gef4.fx.nodes.Connection

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget

public class Connection
extends javafx.scene.Group

The Connection provides a visualization for a binary connection whose route can be influenced by a number of way points and which supports to add start and end decorations.

Property Summary

Type	Property and Description
protected javafx.beans.property.ReadOnlyMapProperty<AnchorKey,IAnchor>	anchors Returns the ReadOnlyMapProperty which stores the AnchorKeys and corresponding IAnchors which determine the start point, way points, and end point of this Connection.

Properties inherited from class javafx.scene.Group

autoSizeChildrenProperty

Properties inherited from class javafx.scene.Parent

impl_traversalEngineProperty, needsLayoutProperty

Properties inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Connection.ChopBoxHelper The Connection.ChopBoxHelper can be registered for an Connection and serves as a ChopBoxAnchor.IReferencePointProvider for all AnchorKeys of that Connection which are registered at ChopBoxAnchors.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CSS_CLASS_DECORATION CSS class assigned to decoration visuals.

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor and Description
Connection() Constructs a new Connection whose start and end point are set to null.

Method Summary

Modifier and Type	Method and Description
protected void	addAnchor(IAnchor anchor, AnchorKey anchorKey, int wayIndex) Inserts the given IAnchor into the anchorsProperty() of this Connection.
void	addWayAnchor(int index, IAnchor anchor) Adds the given IAnchor as a way point anchor for the given index into the anchorsProperty() of this Connection.
void	addWayPoint(int index, Point wayPointInLocal) Adds an StaticAnchor yielding the given Point as a way point anchor for the given index into the anchorsProperty() of this Connection.
protected javafx.beans.property.ReadOnlyMapProperty<AnchorKey,IAnchor>	anchorsProperty() Returns the ReadOnlyMapProperty which stores the AnchorKeys and corresponding IAnchors which determine the start point, way points, and end point of this Connection.
protected void	arrangeDecoration(javafx.scene.shape.Shape decoration, Point start, Vector direction) Arranges the given decoration according to the passed-in values.
protected void	arrangeEndDecoration() Updates the end decoration of this Connection.
protected void	arrangeStartDecoration() Updates the start decoration of this Connection.
protected javafx.scene.shape.Shape	clipAtDecoration(javafx.scene.shape.Shape curveClip, javafx.scene.shape.Shape decoration) Adjusts the curveClip so that the curve node does not paint through the given decoration.
protected javafx.collections.MapChangeListener<? super AnchorKey,? super Point>	createPCL(AnchorKey anchorKey) Creates a position change listener (PCL) which refreshes this Connection upon anchor position changes corresponding to the given AnchorKey.
IAnchor	getAnchor(int index) Returns the anchor at the given index.
protected int	getAnchorIndex(AnchorKey anchorKey) Returns the anchor index for the given AnchorKey which is: 0 for the start anchor key getAnchors().size() - 1 for the end anchor key getWayAnchorIndex(AnchorKey) + 1 for way point anchor keys
protected AnchorKey	getAnchorKey(int anchorIndex) Returns the AnchorKey for the given anchor index, i.e. the reverse of getAnchorIndex(AnchorKey).
java.util.List<IAnchor>	getAnchors() Returns a List containing the IAnchors which are assigned to this Connection in the order: start anchor, way point anchors, end anchor.
GeometryNode<ICurve>	getCurveNode() Returns the GeometryNode which displays the curve geometry.
IAnchor	getEndAnchor() Returns the currently assigned end anchor, or null if no end anchor is assigned.
protected AnchorKey	getEndAnchorKey() Returns the end AnchorKey for this Connection.
javafx.scene.Node	getEndDecoration() Returns the end decoration Node of this Connection, or null.
Point	getEndPoint() Returns the end Point of this Connection within its coordinate system which is determined by querying the anchor position for the end anchor key, or null when no end anchor is assigned.
Point	getPoint(int index) Returns the point at the given index.
Point[]	getPoints() Returns the Points constituting this Connection within its coordinate system in the order: start point, way points, end point.
IConnectionRouter	getRouter() Returns the IConnectionRouter of this Connection.
IAnchor	getStartAnchor() Returns the currently assigned start anchor, or null if no start anchor is assigned.
protected AnchorKey	getStartAnchorKey() Returns the start AnchorKey for this Connection.
javafx.scene.Node	getStartDecoration() Returns the start decoration Node of this Connection, or null.
Point	getStartPoint() Returns the start Point of this Connection within its coordinate system which is determined by querying the anchor position for the start anchor key, or null when no start anchor is assigned.
IAnchor	getWayAnchor(int index) Returns the way anchor for the given way anchor index which is currently assigned, or null if no way anchor is assigned for that index.
protected int	getWayAnchorIndex(AnchorKey key) Returns the way anchor index for the given AnchorKey, i.e.
protected AnchorKey	getWayAnchorKey(int index) Returns the AnchorKey for the given way anchor index.
java.util.List<IAnchor>	getWayAnchors() Returns a List containing the way anchors currently assigned to this Connection.
Point	getWayPoint(int index) Returns the way Point for the given way anchor index within the coordinate system of this Connection which is determined by querying the anchor position for the corresponding way anchor, or null if no way anchor is assigned for the given index.
java.util.List<Point>	getWayPoints() Returns a List containing the way Points of this Connection.
boolean	isEndConnected() Returns true if the currently assigned end anchor is bound to an anchorage.
boolean	isStartConnected() Returns true if the currently assigned start anchor is bound to an anchorage.
boolean	isWayConnected(int index) Returns true if the currently assigned way anchor for the given index is bound to an anchorage.
protected void	refresh() Refreshes the visualization, i.e.
protected void	registerAnchorInfos(IAdaptable adaptable) Registers anchor information as adapters on the given IAdaptable .
void	removeAllWayAnchors() Removes all way points of this Connection.
void	removeAllWayPoints() Removes all way points of this Connection.
protected void	removeAnchor(AnchorKey anchorKey, IAnchor anchor) Removes the given AnchorKey (and corresponding IAnchor) from this Connection.
void	removeWayAnchor(int index) Removes the way anchor specified by the given index from this Connection.
void	removeWayPoint(int index) Removes the way point specified by the given way anchor index from this Connection.
void	setAnchors(java.util.List<IAnchor> anchors) Replaces all anchors of this Connection with the given IAnchors, i.e. the first given IAnchor replaces the currently assigned start anchor, the last given IAnchor replaces the currently assigned end anchor, and the intermediate IAnchors replace the currently assigned way anchors.
void	setEndAnchor(IAnchor anchor) Sets the end IAnchor of this Connection to the given value.
void	setEndDecoration(javafx.scene.shape.Shape endDeco) Sets the end decoration Node of this Connection to the given value.
void	setEndPoint(Point endPointInLocal) Sets the end anchor of this Connection to an StaticAnchor yielding the given Point.
void	setRouter(IConnectionRouter router) Sets the IConnectionRouter of this Connection to the given value.
void	setStartAnchor(IAnchor anchor) Sets the start IAnchor of this Connection to the given value.
void	setStartDecoration(javafx.scene.shape.Shape startDeco) Sets the start decoration Node of this Connection to the given value.
void	setStartPoint(Point startPointInLocal) Sets the start anchor of this Connection to an StaticAnchor yielding the given Point.
void	setWayAnchor(int index, IAnchor anchor) Sets the way anchor for the given way anchor index to the given IAnchor.
void	setWayAnchors(java.util.List<IAnchor> anchors) Replaces all way anchors of this Connection with the given List of IAnchors.
void	setWayPoint(int index, Point wayPointInLocal) Sets the way anchor for the given way anchor index to an StaticAnchor which yields the given Point.
void	setWayPoints(java.util.List<Point> wayPoints) Replaces all way anchors of this Connection with StaticAnchors yielding the given Points.

Methods inherited from class javafx.scene.Group

autoSizeChildrenProperty, getChildren, impl_computeLayoutBounds, isAutoSizeChildren, layoutChildren, minHeight, minWidth, prefHeight, prefWidth, setAutoSizeChildren

Methods inherited from class javafx.scene.Parent

computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getBaselineOffset, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_computeContains, impl_computeGeomBounds, impl_createPeer, impl_getAllParentStylesheets, impl_pickNodeLocal, impl_processCSS, impl_processMXNode, impl_traversalEngineProperty, impl_updatePeer, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestLayout, requestParentLayout, setImpl_traversalEngine, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClassCssMetaData, getClip, getContentBias, getCssMetaData, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_cssGetFocusTraversableInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_notifyLayoutBoundsChanged, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isResizable, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, maxHeight, maxWidth, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resize, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Property Detail

anchors

protected javafx.beans.property.ReadOnlyMapProperty<AnchorKey,IAnchor> anchorsProperty

Returns the ReadOnlyMapProperty which stores the AnchorKeys and corresponding IAnchors which determine the start point, way points, and end point of this Connection.

See Also:

getAnchors(), setAnchors(List)

Field Detail

CSS_CLASS_DECORATION

public static final java.lang.String CSS_CLASS_DECORATION

CSS class assigned to decoration visuals.

See Also:

Constant Field Values

Constructor Detail

Connection

public Connection()

Constructs a new Connection whose start and end point are set to null.

Method Detail

addAnchor

protected void addAnchor(IAnchor anchor,
                         AnchorKey anchorKey,
                         int wayIndex)

Inserts the given IAnchor into the anchorsProperty() of this Connection. The given AnchorKey is attached to the IAnchor, supplying it with the previously registered anchor information. Furthermore, a PCL for the AnchorKey is registered on the position property of the IAnchor and the visualization is refreshed.

Parameters:

anchor - The IAnchor which is inserted.

anchorKey - The AnchorKey under which the IAnchor is registered.

wayIndex - The way anchor index (only for way point anchors, ignored for start and end anchors).

addWayAnchor

public void addWayAnchor(int index,
                         IAnchor anchor)

Adds the given IAnchor as a way point anchor for the given index into the anchorsProperty() of this Connection.

Parameters:

index - The position where the IAnchor is inserted within the way point anchors of this Connection.

anchor - The IAnchor which determines the position of the corresponding way point.

addWayPoint

public void addWayPoint(int index,
                        Point wayPointInLocal)

Adds an StaticAnchor yielding the given Point as a way point anchor for the given index into the anchorsProperty() of this Connection.

Parameters:

index - The position where the IAnchor is inserted within the way point anchors of this Connection.

wayPointInLocal - The position for the specified way point.

anchorsProperty

protected javafx.beans.property.ReadOnlyMapProperty<AnchorKey,IAnchor> anchorsProperty()

Returns the ReadOnlyMapProperty which stores the AnchorKeys and corresponding IAnchors which determine the start point, way points, and end point of this Connection.

See Also:

getAnchors(), setAnchors(List)

arrangeDecoration

protected void arrangeDecoration(javafx.scene.shape.Shape decoration,
                                 Point start,
                                 Vector direction)

Arranges the given decoration according to the passed-in values.

Parameters:

decoration - The decoration Node to arrange.

start - The offset for the decoration visual.

direction - The direction of the Connection at the point where the decoration is arranged.

arrangeEndDecoration

protected void arrangeEndDecoration()

Updates the end decoration of this Connection.

arrangeStartDecoration

protected void arrangeStartDecoration()

Updates the start decoration of this Connection.

clipAtDecoration

protected javafx.scene.shape.Shape clipAtDecoration(javafx.scene.shape.Shape curveClip,
                                                    javafx.scene.shape.Shape decoration)

Adjusts the curveClip so that the curve node does not paint through the given decoration.

Parameters:

curveClip - A shape that represents the clip of the curve node, interpreted in scene coordinates.

decoration - The decoration to clip the curve node from.

Returns:

A shape representing the resulting clip, interpreted in scene coordinates.

createPCL

protected javafx.collections.MapChangeListener<? super AnchorKey,? super Point> createPCL(AnchorKey anchorKey)

Creates a position change listener (PCL) which refreshes this Connection upon anchor position changes corresponding to the given AnchorKey.

Parameters:

anchorKey - The AnchorKey for which a position change will trigger a refresh() with the returned PCL.

Returns:

A position change listener to refresh this Connection when the position for the given AnchorKey changes.

getAnchor

public IAnchor getAnchor(int index)

Returns the anchor at the given index. The start anchor will be provided for index == 0, the end anchor for the last defined index. Way anchors will be returned for all indices in between.

Parameters:

index - The index of the anchor to retrieve.

Returns:

The anchor at the given index.

getAnchorIndex

protected int getAnchorIndex(AnchorKey anchorKey)

Returns the anchor index for the given AnchorKey which is:

• 0 for the start anchor key
• getAnchors().size() - 1 for the end anchor key
• getWayAnchorIndex(AnchorKey) + 1 for way point anchor keys

Parameters:

anchorKey - The AnchorKey for which the anchor index is determined.

Returns:

The anchor index for the given AnchorKey.

getAnchorKey

protected AnchorKey getAnchorKey(int anchorIndex)

Returns the AnchorKey for the given anchor index, i.e. the reverse of getAnchorIndex(AnchorKey).

Parameters:

anchorIndex - The anchor index for which to determine the AnchorKey.

Returns:

The AnchorKey for the given anchor index.

getAnchors

public java.util.List<IAnchor> getAnchors()

Returns a List containing the IAnchors which are assigned to this Connection in the order: start anchor, way point anchors, end anchor.

Returns:

A List containing the IAnchors which are assigned to this Connection.

getCurveNode

public GeometryNode<ICurve> getCurveNode()

Returns the GeometryNode which displays the curve geometry.

Returns:

The GeometryNode which displays the curve geometry.

getEndAnchor

public IAnchor getEndAnchor()

Returns the currently assigned end anchor, or null if no end anchor is assigned.

Returns:

The currently assigned end anchor, or null.

getEndAnchorKey

protected AnchorKey getEndAnchorKey()

Returns the end AnchorKey for this Connection. An end AnchorKey uses the curve node as its anchored and "end" as its role.

Returns:

The end AnchorKey for this Connection.

getEndDecoration

public javafx.scene.Node getEndDecoration()

Returns the end decoration Node of this Connection, or null.

Returns:

The end decoration Node of this Connection, or null.

getEndPoint

public Point getEndPoint()

Returns the end Point of this Connection within its coordinate system which is determined by querying the anchor position for the end anchor key, or null when no end anchor is assigned.

Returns:

The end Point of this Connection, or null.

getPoint

public Point getPoint(int index)

Returns the point at the given index. The start point will be provided for index == 0, the end point for the last defined index. Way points will be returned for all indices in between.

Parameters:

index - The index of the point to retrieve.

Returns:

The point at the given index.

See Also:

getPoints()

getPoints

public Point[] getPoints()

Returns the Points constituting this Connection within its coordinate system in the order: start point, way points, end point. They are determined by querying the corresponding anchor positions. In case not all anchors are assigned, an empty array is returned.

Returns:

The Points constituting this Connection.

getRouter

public IConnectionRouter getRouter()

Returns the IConnectionRouter of this Connection.

Returns:

The IConnectionRouter of this Connection.

getStartAnchor

public IAnchor getStartAnchor()

Returns the currently assigned start anchor, or null if no start anchor is assigned.

Returns:

The currently assigned start anchor, or null.

getStartAnchorKey

protected AnchorKey getStartAnchorKey()

Returns the start AnchorKey for this Connection. A start AnchorKey uses the curve node as its anchored and "start" as its role.

Returns:

The start AnchorKey for this Connection.

getStartDecoration

public javafx.scene.Node getStartDecoration()

Returns the start decoration Node of this Connection, or null.

Returns:

The start decoration Node of this Connection, or null.

getStartPoint

public Point getStartPoint()

Returns the start Point of this Connection within its coordinate system which is determined by querying the anchor position for the start anchor key, or null when no start anchor is assigned.

Returns:

The start Point of this Connection, or null.

getWayAnchor

public IAnchor getWayAnchor(int index)

Returns the way anchor for the given way anchor index which is currently assigned, or null if no way anchor is assigned for that index.

Parameters:

index - The way anchor index determining which way anchor to return.

Returns:

The way anchor for the given index, or null.

getWayAnchorIndex

protected int getWayAnchorIndex(AnchorKey key)

Returns the way anchor index for the given AnchorKey, i.e. 0 for the first way anchor, 1 for the seconds, etc.

Parameters:

key - The AnchorKey whose way anchor index is returned.

Returns:

The way anchor index for the given AnchorKey.

Throws:

java.lang.IllegalArgumentException - when there currently is no way anchor assigned to this Connection for the given AnchorKey.

getWayAnchorKey

protected AnchorKey getWayAnchorKey(int index)

Returns the AnchorKey for the given way anchor index.

Parameters:

index - The way anchor index for which the AnchorKey is returned.

Returns:

The AnchorKey for the given way anchor index.

getWayAnchors

public java.util.List<IAnchor> getWayAnchors()

Returns a List containing the way anchors currently assigned to this Connection.

Returns:

A List containing the way anchors currently assigned to this Connection.

getWayPoint

public Point getWayPoint(int index)

Returns the way Point for the given way anchor index within the coordinate system of this Connection which is determined by querying the anchor position for the corresponding way anchor, or null if no way anchor is assigned for the given index.

Parameters:

index - The way anchor index for which to return the anchor position.

Returns:

The start Point of this Connection, or null.

getWayPoints

public java.util.List<Point> getWayPoints()

Returns a List containing the way Points of this Connection.

Returns:

A List containing the way Points of this Connection.

isEndConnected

public boolean isEndConnected()

Returns true if the currently assigned end anchor is bound to an anchorage. Otherwise returns false.

Returns:

true if the currently assigned end anchor is bound to an anchorage, otherwise false.

isStartConnected

public boolean isStartConnected()

Returns true if the currently assigned start anchor is bound to an anchorage. Otherwise returns false.

Returns:

true if the currently assigned start anchor is bound to an anchorage, otherwise false.

isWayConnected

public boolean isWayConnected(int index)

Returns true if the currently assigned way anchor for the given index is bound to an anchorage. Otherwise returns false.

Parameters:

index - The way anchor index of the way anchor to test for connectedness.

Returns:

true if the currently assigned way anchor for the given index is bound to an anchorage, otherwise false.

refresh

protected void refresh()

Refreshes the visualization, i.e.

1. determines the points constituting this Connection,
2. computes an ICurve geometry through those Points using the IConnectionRouter of this Connection,
3. replaces the geometry of the curve node with that ICurve,
4. arranges the start decoration and end decoration of this Connection.

registerAnchorInfos

protected void registerAnchorInfos(IAdaptable adaptable)

Registers anchor information as adapters on the given IAdaptable . These anchor information is supplied to all anchors which are assigned to this Connection. Per default, an Connection.ChopBoxHelper is registered as a ChopBoxAnchor.IReferencePointProvider , so that the Connection works in conjunction with ChopBoxAnchor.

Parameters:

adaptable - The IAdaptable on which anchor information is registered via adapters.

removeAllWayAnchors

public void removeAllWayAnchors()

Removes all way points of this Connection.

removeAllWayPoints

public void removeAllWayPoints()

Removes all way points of this Connection.

removeAnchor

protected void removeAnchor(AnchorKey anchorKey,
                            IAnchor anchor)

Removes the given AnchorKey (and corresponding IAnchor) from this Connection.

Parameters:

anchorKey - The AnchorKey to remove.

anchor - The corresponding IAnchor.

removeWayAnchor

public void removeWayAnchor(int index)

Removes the way anchor specified by the given index from this Connection.

Parameters:

index - The index specifying which way anchor to remove.

removeWayPoint

public void removeWayPoint(int index)

Removes the way point specified by the given way anchor index from this Connection.

Parameters:

index - The way anchor index specifying which way point to remove.

setAnchors

public void setAnchors(java.util.List<IAnchor> anchors)

Replaces all anchors of this Connection with the given IAnchors, i.e. the first given IAnchor replaces the currently assigned start anchor, the last given IAnchor replaces the currently assigned end anchor, and the intermediate IAnchors replace the currently assigned way anchors.

Parameters:

anchors - The new IAnchors for this Connection.

Throws:

java.lang.IllegalArgumentException - when less than 2 IAnchors are given.

setEndAnchor

public void setEndAnchor(IAnchor anchor)

Sets the end IAnchor of this Connection to the given value.

Parameters:

anchor - The new end IAnchor for this Connection.

setEndDecoration

public void setEndDecoration(javafx.scene.shape.Shape endDeco)

Sets the end decoration Node of this Connection to the given value.

Parameters:

endDeco - The new end decoration Node for this Connection.

setEndPoint

public void setEndPoint(Point endPointInLocal)

Sets the end anchor of this Connection to an StaticAnchor yielding the given Point.

Parameters:

endPointInLocal - The new end Point for this Connection.

setRouter

public void setRouter(IConnectionRouter router)

Sets the IConnectionRouter of this Connection to the given value.

Parameters:

router - The new IConnectionRouter for this Connection.

setStartAnchor

public void setStartAnchor(IAnchor anchor)

Sets the start IAnchor of this Connection to the given value.

Parameters:

anchor - The new start IAnchor for this Connection.

setStartDecoration

public void setStartDecoration(javafx.scene.shape.Shape startDeco)

Sets the start decoration Node of this Connection to the given value.

Parameters:

startDeco - The new start decoration Node for this Connection.

setStartPoint

public void setStartPoint(Point startPointInLocal)

Sets the start anchor of this Connection to an StaticAnchor yielding the given Point.

Parameters:

startPointInLocal - The new start Point for this Connection.

setWayAnchor

public void setWayAnchor(int index,
                         IAnchor anchor)

Sets the way anchor for the given way anchor index to the given IAnchor.

Parameters:

index - The way anchor index of the way anchor to replace.

anchor - The new way IAnchor for that index.

setWayAnchors

public void setWayAnchors(java.util.List<IAnchor> anchors)

Replaces all way anchors of this Connection with the given List of IAnchors.

Parameters:

anchors - The new way IAnchors for this Connection.

setWayPoint

public void setWayPoint(int index,
                        Point wayPointInLocal)

Sets the way anchor for the given way anchor index to an StaticAnchor which yields the given Point.

Parameters:

index - The way anchor index of the way anchor to replace.

wayPointInLocal - The new way Point for that index.

setWayPoints

public void setWayPoints(java.util.List<Point> wayPoints)

Replaces all way anchors of this Connection with StaticAnchors yielding the given Points.

Parameters:

wayPoints - The new way Points for this Connection.