org.eclipse.gef4.fx.anchors

Class ChopBoxAnchor

java.lang.Object

org.eclipse.gef4.fx.anchors.AbstractAnchor

org.eclipse.gef4.fx.anchors.ChopBoxAnchor

All Implemented Interfaces:

IAnchor

public class ChopBoxAnchor
extends AbstractAnchor

The ChopBoxAnchor computes anchor positions based on a reference position per anchored and one reference position for the anchorage. The anchoreds' reference positions are provided when attaching an AnchorKey. The computation is carried out by a ChopBoxAnchor.IComputationStrategy. The default computation strategy (ChopBoxAnchor.IComputationStrategy.Impl) will connect anchored and anchorage reference position and compute the intersection with the outline of the anchorage.

Property Summary

Properties inherited from class org.eclipse.gef4.fx.anchors.AbstractAnchor

anchorageProperty, positionProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ChopBoxAnchor.IComputationStrategy The ChopBoxAnchor.IComputationStrategy is responsible for computing anchor positions based on an anchorage Node, an anchored Node, and an anchored reference position ( ChopBoxAnchor.IComputationStrategy.computePositionInScene(Node, Node, Point)).
static interface	ChopBoxAnchor.IReferencePointProvider A ChopBoxAnchor.IReferencePointProvider needs to be provided as default adapter (see AdapterKey.get(Class)) on the IAdaptable info that gets passed into attach(AnchorKey, IAdaptable) and detach(AnchorKey, IAdaptable).

Constructor Summary

Constructors

Constructor and Description
ChopBoxAnchor(javafx.scene.Node anchorage) Constructs a new ChopBoxAnchor for the given anchorage visual.
ChopBoxAnchor(javafx.scene.Node anchorage, ChopBoxAnchor.IComputationStrategy computationStrategy) Constructs a new ChopBoxAnchor for the given anchorage visual using the given ChopBoxAnchor.IComputationStrategy.

Method Summary

Modifier and Type	Method and Description
void	attach(AnchorKey key, IAdaptable info) Attaches the given AnchorKey to this ChopBoxAnchor.
protected Point	computePosition(AnchorKey key) Recomputes the position for the given attached AnchorKey by retrieving a reference position via the ChopBoxAnchor.IReferencePointProvider that was obtained when attaching the AnchorKey ( attach(AnchorKey, IAdaptable)).
protected Point	computePosition(javafx.scene.Node anchored, Point anchoredReferencePointInLocal) Computes the point of intersection between the outline of the anchorage reference shape and the line through the reference points of anchorage and anchored.
void	detach(AnchorKey key, IAdaptable info) Detaches the given AnchorKey from this ChopBoxAnchor.

Methods inherited from class org.eclipse.gef4.fx.anchors.AbstractAnchor

anchorageProperty, getAnchorage, getKeys, getPosition, isAttached, positionProperty, registerVCL, registerVCLs, setAnchorage, unregisterVCL, unregisterVCLs, updatePosition

Methods inherited from class java.lang.Object

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

Constructor Detail

ChopBoxAnchor

public ChopBoxAnchor(javafx.scene.Node anchorage)

Constructs a new ChopBoxAnchor for the given anchorage visual. Uses the default computation strategy (ChopBoxAnchor.IComputationStrategy.Impl).

Parameters:

anchorage - The anchorage visual.

ChopBoxAnchor

public ChopBoxAnchor(javafx.scene.Node anchorage,
                     ChopBoxAnchor.IComputationStrategy computationStrategy)

Constructs a new ChopBoxAnchor for the given anchorage visual using the given ChopBoxAnchor.IComputationStrategy.

Parameters:

anchorage - The anchorage visual.

computationStrategy - The ChopBoxAnchor.IComputationStrategy to use.

Method Detail

attach

public void attach(AnchorKey key,
                   IAdaptable info)

Attaches the given AnchorKey to this ChopBoxAnchor. Requires that an ChopBoxAnchor.IReferencePointProvider can be obtained from the passed in IAdaptable.

Specified by:

attach in interface IAnchor

Overrides:

attach in class AbstractAnchor

Parameters:

key - The AnchorKey to be attached.

info - An IAdaptable, which will be used to obtain an ChopBoxAnchor.IReferencePointProvider that provides reference points for this ChopBoxAnchor.

computePosition

protected Point computePosition(AnchorKey key)

Recomputes the position for the given attached AnchorKey by retrieving a reference position via the ChopBoxAnchor.IReferencePointProvider that was obtained when attaching the AnchorKey ( attach(AnchorKey, IAdaptable)).

Specified by:

computePosition in class AbstractAnchor

Parameters:

key - The AnchorKey for which to compute an anchor position.

Returns:

The position for the given AnchorKey.

computePosition

protected Point computePosition(javafx.scene.Node anchored,
                                Point anchoredReferencePointInLocal)

Computes the point of intersection between the outline of the anchorage reference shape and the line through the reference points of anchorage and anchored.

Parameters:

anchored - The to be anchored Node for which the anchor position is to be determined.

anchoredReferencePointInLocal - A reference Point used for calculation of the anchor position, provided within the local coordinate system of the to be anchored Node.

Returns:

Point The anchor position within the local coordinate system of the to be anchored Node.

detach

public void detach(AnchorKey key,
                   IAdaptable info)

Detaches the given AnchorKey from this ChopBoxAnchor. Requires that an ChopBoxAnchor.IReferencePointProvider can be obtained from the passed in IAdaptable.

Specified by:

detach in interface IAnchor

Overrides:

detach in class AbstractAnchor

Parameters:

key - The AnchorKey to be detached.

info - An IAdaptable, which will be used to obtain an ChopBoxAnchor.IReferencePointProvider that provides reference points for this ChopBoxAnchor.