Module org.jhotdraw8.draw

Package org.jhotdraw8.draw.figure

Class AbstractLabelConnectionFigure

java.lang.Object

org.jhotdraw8.fxbase.styleable.AbstractStyleablePropertyBean

org.jhotdraw8.draw.figure.AbstractFigure

org.jhotdraw8.draw.figure.AbstractLeafFigure

org.jhotdraw8.draw.figure.AbstractLabelFigure

org.jhotdraw8.draw.figure.AbstractLabelConnectionFigure

All Implemented Interfaces:

ConnectableFigure, ConnectingFigure, Figure, FillableFigure, LabelConnectionFigure, PaddableFigure, PathIterableFigure, ShapeableFigure, StrokableFigure, TextFillableFigure, TextFontableFigure, TextLayoutableFigure, TransformableFigure, TransformCachingFigure, PropertyBean, StyleableBean, StyleablePropertyBean, TreeNode<Figure>

Direct Known Subclasses:

SimpleLabelConnectionFigure

public abstract class AbstractLabelConnectionFigure
extends AbstractLabelFigure
implements ConnectingFigure, TransformableFigure, LabelConnectionFigure

A label that can be attached to another figure by setting LabelConnectionFigure.LABEL_CONNECTOR and LabelConnectionFigure.LABEL_TARGET.

When the label is attached it computes the LABELED_LOCATION using the LabelConnectionFigure.LABEL_CONNECTOR on the target figure. Then it computes the AbstractLabelFigure.ORIGIN and rotation of the label using the properties LABEL_OFFSET and LABEL_AUTOROTATE.

 LABELED_LOCATION:    x,y (has a derivative that can be rotated)
                       |
                       | + LABEL_OFFSET (perpendicular to
                       |                 LABELED_LOCATION)
                       ↓
                   +--------------------+
 ORIGIN:           |  x,y               |
 LABEL_AUTOROTATE: |   ↺                |
                   |                    |
                   |    layout bounds   |
                   +--------------------+

 

Author:

Werner Randelshofer

Property Summary

Properties

Type	Property	Description
@NonNull javafx.beans.property.ReadOnlyBooleanProperty	connected	This property is true when the figure is connected.

Properties inherited from class org.jhotdraw8.draw.figure.AbstractFigure

parent

Properties inherited from interface org.jhotdraw8.draw.figure.Figure

parent

Properties inherited from interface org.jhotdraw8.fxbase.styleable.StyleableBean

id

Nested Class Summary

Nested classes/interfaces inherited from interface org.jhotdraw8.fxbase.tree.TreeNode

TreeNode.AncestorIterator<T extends TreeNode<T>>

Field Summary

Fields

Modifier and Type	Field	Description
static final @NonNull NonNullEnumStyleableKey<LabelAutorotate>	LABEL_AUTOROTATE	Whether the label should be rotated with the target.
static final @NonNull CssPoint2DStyleableMapAccessor	LABEL_OFFSET
static final @NonNull CssSizeStyleableKey	LABEL_OFFSET_X	The tangential offset of the label.
static final @NonNull CssSizeStyleableKey	LABEL_OFFSET_Y	The perpendicular offset of the label.
static final @NonNull CssPoint2DStyleableMapAccessor	LABEL_TRANSLATE	The position relative to the parent (respectively the offset).
static final @NonNull CssSizeStyleableKey	LABEL_TRANSLATE_X
static final @NonNull CssSizeStyleableKey	LABEL_TRANSLATE_Y
static final @NonNull CssPoint2DStyleableMapAccessor	LABELED_LOCATION
static final @NonNull CssSizeStyleableKey	LABELED_LOCATION_X
static final @NonNull CssSizeStyleableKey	LABELED_LOCATION_Y

Fields inherited from class org.jhotdraw8.draw.figure.AbstractLabelFigure

ICON_FILL, ICON_POSITION, ICON_ROTATE, ICON_SHAPE, ICON_SIZE, ICON_TEXT_GAP, ICON_TRANSLATE, ICON_TRANSLATE_X, ICON_TRANSLATE_Y, ORIGIN, ORIGIN_X, ORIGIN_Y, TEXT_HPOS

Fields inherited from class org.jhotdraw8.fxbase.styleable.AbstractStyleablePropertyBean

keyMaps, properties

Fields inherited from interface org.jhotdraw8.draw.figure.Figure

declaredAndInheritedKeys, JHOTDRAW_CSS_PREFIX, PARENT_PROPERTY

Fields inherited from interface org.jhotdraw8.draw.figure.FillableFigure

FILL

Fields inherited from interface org.jhotdraw8.draw.figure.LabelConnectionFigure

LABEL_CONNECTOR, LABEL_TARGET

Fields inherited from interface org.jhotdraw8.draw.figure.PaddableFigure

PADDING, PADDING_BOTTOM, PADDING_LEFT, PADDING_RIGHT, PADDING_TOP

Fields inherited from interface org.jhotdraw8.draw.figure.ShapeableFigure

SHAPE, SHAPE_BOUNDS, SHAPE_BOUNDS_HEIGHT, SHAPE_BOUNDS_WIDTH, SHAPE_BOUNDS_X, SHAPE_BOUNDS_Y, SHAPE_SLICE, SHAPE_SLICE_BOTTOM, SHAPE_SLICE_LEFT, SHAPE_SLICE_RIGHT, SHAPE_SLICE_TOP, SVG_SQUARE

Fields inherited from interface org.jhotdraw8.draw.figure.StrokableFigure

STROKE, STROKE_DASH_ARRAY, STROKE_DASH_OFFSET, STROKE_LINE_CAP, STROKE_LINE_JOIN, STROKE_MITER_LIMIT, STROKE_STYLE, STROKE_TYPE, STROKE_WIDTH

Fields inherited from interface org.jhotdraw8.draw.figure.TextFillableFigure

TEXT_FILL

Fields inherited from interface org.jhotdraw8.draw.figure.TextFontableFigure

FONT, FONT_FAMILY, FONT_SIZE, FONT_STYLE, FONT_WEIGHT, STRIKETHROUGH, UNDERLINE

Fields inherited from interface org.jhotdraw8.draw.figure.TextLayoutableFigure

LINE_SPACING, TEXT_ALIGNMENT, TEXT_VPOS, WRAPPING_WIDTH

Fields inherited from interface org.jhotdraw8.draw.figure.TransformableFigure

CACHE, ROTATE, ROTATION_AXIS, ROTATION_PIVOT, SCALE, SCALE_X, SCALE_Y, SCALE_Z, TRANSFORMS, TRANSLATE, TRANSLATE_X, TRANSLATE_Y, TRANSLATE_Z

Fields inherited from interface org.jhotdraw8.draw.figure.TransformCachingFigure

CACHE

Constructor Summary

Constructors

Constructor	Description
AbstractLabelConnectionFigure()

Method Summary

Modifier and Type	Method	Description
@NonNull javafx.beans.property.ReadOnlyBooleanProperty	connectedProperty()	This property is true when the figure is connected.
void	createHandles(@NonNull HandleType handleType, @NonNull List<Handle> list)	Creates handles of the specified level and adds them to the provided list.
void	doAddedToDrawing(@NonNull Drawing drawing)	This method is called by Figure.addedToDrawing(org.jhotdraw8.draw.figure.Drawing).
protected void	doRemovedFromDrawing(@NonNull Drawing drawing)	This method is called by AbstractFigure.removedFromDrawing(org.jhotdraw8.draw.figure.Drawing).
@NonNull ReadOnlySet<Figure>	getLayoutSubjects()	Returns all figures which are connected by this figure - they provide to the layout of this figure.
boolean	isConnected()	Gets the value of the connected property.
boolean	isGroupReshapeableWith(@NonNull Set<Figure> others)	Whether the figure can be reshaped as a group together with other figures.
boolean	isLayoutable()	Whether the layout method of this figure does anything.
void	layout(@NonNull RenderContext ctx)	Computes the layout bounds of this figure.
protected void	layoutOrigin(@NonNull RenderContext ctx)	If the label has a LabelConnectionFigure.LABEL_TARGET and a LabelConnectionFigure.LABEL_CONNECTOR, computes the LABELED_LOCATION, AbstractLabelFigure.ORIGIN and TransformableFigure.TRANSFORMS of the label.
protected <T> void	onPropertyChanged(@NonNull Key<T> key, @Nullable T oldValue, @Nullable T newValue, boolean wasAdded, boolean wasRemoved)	Overrides of this method must call super!
void	removeAllLayoutSubjects()	This implementation is empty.
void	removeLayoutSubject(@NonNull Figure subject)	This implementation is empty.
void	reshapeInLocal(@NonNull CssSize x, @NonNull CssSize y, @NonNull CssSize width, @NonNull CssSize height)	Attempts to change the local bounds of the figure.
void	setLabelConnection(@Nullable Figure target, @Nullable Connector connector)
void	translateInLocal(@NonNull CssPoint2D delta)	Attempts to translate the local bounds of the figure.
void	updateGroupNode(@NonNull RenderContext ctx, @NonNull javafx.scene.Group node)	Updates the group node that holds all other nodes of the label.

Methods inherited from class org.jhotdraw8.draw.figure.AbstractLabelFigure

createNode, findConnector, getCachedLayoutBounds, getCssLayoutBounds, getLayoutBounds, getPathIterator, getText, hasIcon, setCachedLayoutBounds, updateIconNode, updateIconNodeImage, updateIconNodeTransform, updateNode, updatePathNode, updateTextNode, updateTextNodeFontAndText, updateTextNodeLayout, updateTextNodePaint

Methods inherited from class org.jhotdraw8.draw.figure.AbstractLeafFigure

getChildren, isAllowsChildren, isSuitableChild, isSuitableParent

Methods inherited from class org.jhotdraw8.draw.figure.AbstractFigure

addedToDrawing, createKeyMap, getCachedLocalToParent, getCachedLocalToWorld, getCachedParentToLocal, getCachedParentToWorld, getCachedWorldToLocal, getCachedWorldToParent, getDrawing, getLayoutObservers, getPropertyChangeListeners, getReadOnlyLayoutObservers, getStyledNonNull, hasPropertyChangeListeners, parentProperty, removedFromDrawing, setCachedLocalToParent, setCachedLocalToWorld, setCachedParentToLocal, setCachedParentToWorld, setCachedWorldToLocal, setCachedWorldToParent, updateCss

Methods inherited from class org.jhotdraw8.fxbase.styleable.AbstractStyleablePropertyBean

callObservers, containsMapAccessor, getProperties, getStyleableMap, getStyled, getStyled, remove, removeAll, resetStyledValues, setStyled

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jhotdraw8.draw.figure.ConnectableFigure

findConnector

Methods inherited from interface org.jhotdraw8.draw.figure.ConnectingFigure

canConnect

Methods inherited from interface org.jhotdraw8.draw.figure.Figure

addChild, addedToDrawing, createNode, disconnect, firePropertyChangeEvent, firePropertyChangeEvent, getBoundsInParent, getBoundsInWorld, getCenterInLocal, getCenterInParent, getChildren, getCssLayoutBounds, getDrawing, getLayer, getLayoutBounds, getLayoutBoundsInParent, getLayoutBoundsInWorld, getLayoutObservers, getParent, getPreferredAspectRatio, getPropertyChangeListeners, getReadOnlyLayoutObservers, getRoot, getStyleableParent, getSupportedKeys, getVisualBounds, getVisualBoundsInWorld, hasPropertyChangeListeners, isAllowsChildren, isDecomposable, isDeletable, isDeletWithLastLayoutSubject, isEditable, isEditableKey, isSelectable, isShowing, isSuitableChild, isSuitableParent, isSupportedKey, isVisible, layoutChanged, layoutObserverChanged, layoutSubjectChanged, localToParent, localToWorld, localToWorld, parentProperty, propertyChanged, removeChild, removedFromDrawing, reshapeInLocal, reshapeInLocal, setParent, stylesheetChanged, transformChanged, translateInParent, updateCss, updateNode, worldToLocal, worldToLocal, worldToParent, worldToParent

Methods inherited from interface org.jhotdraw8.draw.figure.FillableFigure

applyFillableFigureProperties

Methods inherited from interface org.jhotdraw8.fxbase.beans.PropertyBean

get, getNonNull, getProperties, getProperty, put, remove, set, setNonNull, valueAt

Methods inherited from interface org.jhotdraw8.draw.figure.ShapeableFigure

applyShapeableProperties, applyShapeableProperties

Methods inherited from interface org.jhotdraw8.draw.figure.StrokableFigure

applyStrokableFigureProperties, applyStrokeCapAndJoinProperties, applyStrokeColorProperties, applyStrokeDashProperties, applyStrokeTypeProperties, applyStrokeWidthProperties, getBoundsInLocal, getStyledStroke

Methods inherited from interface org.jhotdraw8.fxbase.styleable.StyleableBean

getId, getPseudoClassStates, getStyle, getStyleClasses, getTypeSelector, idProperty

Methods inherited from interface org.jhotdraw8.fxbase.styleable.StyleablePropertyBean

containsMapAccessor, getStyled, getStyled, getStyledNonNull, remove, removeAll, resetStyledValues, setStyled

Methods inherited from interface org.jhotdraw8.draw.figure.TextFillableFigure

applyTextFillableFigureProperties, applyTextFillableFigureProperties

Methods inherited from interface org.jhotdraw8.draw.figure.TextFontableFigure

applyTextFontableFigureProperties, applyTextFontableFigureProperties

Methods inherited from interface org.jhotdraw8.draw.figure.TextLayoutableFigure

applyTextLayoutableFigureProperties, applyTextLayoutableFigureProperties

Methods inherited from interface org.jhotdraw8.draw.figure.TransformableFigure

applyTransformableFigureProperties, clearTransforms, flattenTransforms, getInverseTransform, getLocalToParent, getLocalToParent, getLocalToParentAsList, getParentToLocal, getParentToLocal, getTransform, hasCenterTransforms, reshapeInLocal, reshapeInParent, setTransforms, transformInLocal, transformInParent

Methods inherited from interface org.jhotdraw8.draw.figure.TransformCachingFigure

getCachedLocalToParent, getCachedLocalToWorld, getCachedParentToLocal, getCachedParentToWorld, getCachedWorldToLocal, getCachedWorldToParent, getLocalToWorld, getParentToWorld, getWorldToLocal, getWorldToParent, invalidateTransforms, setCachedLocalToParent, setCachedLocalToWorld, setCachedParentToLocal, setCachedParentToWorld, setCachedWorldToLocal, setCachedWorldToParent

Methods inherited from interface org.jhotdraw8.fxbase.tree.TreeNode

ancestorIterable, breadthFirstIterable, depthFirstIterable, dumpTree, dumpTree, getAncestor, getChild, getDepth, getFirstChild, getLastChild, getMaxDepth, getPath, postorderIterable, preorderIterable, preorderSpliterator

Property Details

connected

public @NonNull javafx.beans.property.ReadOnlyBooleanProperty connectedProperty

This property is true when the figure is connected.

See Also:

• isConnected()
• connectedProperty()

Field Details

LABELED_LOCATION_X

public static final @NonNull CssSizeStyleableKey LABELED_LOCATION_X

LABELED_LOCATION_Y

public static final @NonNull CssSizeStyleableKey LABELED_LOCATION_Y

LABELED_LOCATION

public static final @NonNull CssPoint2DStyleableMapAccessor LABELED_LOCATION

LABEL_OFFSET_Y

public static final @NonNull CssSizeStyleableKey LABEL_OFFSET_Y

The perpendicular offset of the label.

The offset is perpendicular to the tangent line of the figure.

LABEL_OFFSET_X

public static final @NonNull CssSizeStyleableKey LABEL_OFFSET_X

The tangential offset of the label.

The offset is on tangent line of the figure.

LABEL_OFFSET

public static final @NonNull CssPoint2DStyleableMapAccessor LABEL_OFFSET

LABEL_AUTOROTATE

public static final @NonNull NonNullEnumStyleableKey<LabelAutorotate> LABEL_AUTOROTATE

Whether the label should be rotated with the target.

LABEL_TRANSLATE_Y

public static final @NonNull CssSizeStyleableKey LABEL_TRANSLATE_Y

LABEL_TRANSLATE_X

public static final @NonNull CssSizeStyleableKey LABEL_TRANSLATE_X

LABEL_TRANSLATE

public static final @NonNull CssPoint2DStyleableMapAccessor LABEL_TRANSLATE

The position relative to the parent (respectively the offset).

Constructor Details

AbstractLabelConnectionFigure

public AbstractLabelConnectionFigure()

Method Details

onPropertyChanged

protected <T> void onPropertyChanged(@NonNull Key<T> key,
 @Nullable T oldValue,
 @Nullable T newValue,
 boolean wasAdded,
 boolean wasRemoved)

Description copied from class: AbstractFigure

Overrides of this method must call super!

Overrides:

onPropertyChanged in class AbstractFigure

Type Parameters:

T - the value type of the property

Parameters:

key - the changed key

oldValue - the old value

newValue - the new value

wasAdded - whether the value was added (hence oldValue does not matter)

wasRemoved - whether the value was removed (hence newValue does not matter)

doAddedToDrawing

public void doAddedToDrawing(@NonNull Drawing drawing)

Description copied from class: AbstractFigure

This method is called by Figure.addedToDrawing(org.jhotdraw8.draw.figure.Drawing). The implementation of this class is empty.

Overrides:

doAddedToDrawing in class AbstractFigure

Parameters:

drawing - the drawing

doRemovedFromDrawing

protected void doRemovedFromDrawing(@NonNull Drawing drawing)

Description copied from class: AbstractFigure

This method is called by AbstractFigure.removedFromDrawing(org.jhotdraw8.draw.figure.Drawing). The implementation of this class is empty.

Overrides:

doRemovedFromDrawing in class AbstractFigure

Parameters:

drawing - the drawing

connectedProperty

public @NonNull javafx.beans.property.ReadOnlyBooleanProperty connectedProperty()

This property is true when the figure is connected.

Returns:

the connected property

See Also:

• isConnected()

createHandles

public void createHandles(@NonNull HandleType handleType,
 @NonNull List<Handle> list)

Description copied from interface: Figure

Creates handles of the specified level and adds them to the provided list.

Specified by:

createHandles in interface Figure

Parameters:

handleType - The desired handle type

list - The handles.

getLayoutSubjects

public @NonNull ReadOnlySet<Figure> getLayoutSubjects()

Returns all figures which are connected by this figure - they provide to the layout of this figure.

Specified by:

getLayoutSubjects in interface Figure

Returns:

a list of connected figures

isConnected

public boolean isConnected()

Gets the value of the connected property.

Property description:

This property is true when the figure is connected.

Returns:

the value of the connected property

See Also:

• connectedProperty()

isGroupReshapeableWith

public boolean isGroupReshapeableWith(@NonNull Set<Figure> others)

Description copied from interface: Figure

Whether the figure can be reshaped as a group together with other figures.

If this figure uses one of the other figures for computing its position or its layout, then it will return false.

The default implementation always returns true.

Specified by:

isGroupReshapeableWith in interface Figure

Parameters:

others - A set of figures.

Returns:

true if the user may svgStringReshapeToBuilder this figure together with those in the set.

isLayoutable

public boolean isLayoutable()

Description copied from interface: Figure

Whether the layout method of this figure does anything.

The default implementation returns false.

Specified by:

isLayoutable in interface Figure

Returns:

true if the layout method is not empty.

layout

public void layout(@NonNull RenderContext ctx)

Description copied from class: AbstractLabelFigure

Computes the layout bounds of this figure.

Specified by:

layout in interface Figure

Overrides:

layout in class AbstractLabelFigure

Parameters:

ctx - the render context

layoutOrigin

protected void layoutOrigin(@NonNull RenderContext ctx)

If the label has a LabelConnectionFigure.LABEL_TARGET and a LabelConnectionFigure.LABEL_CONNECTOR, computes the LABELED_LOCATION, AbstractLabelFigure.ORIGIN and TransformableFigure.TRANSFORMS of the label.

Else leaves the AbstractLabelFigure.ORIGIN and the TransformableFigure.TRANSFORMS unchanged.

The following properties affect the result: LABEL_OFFSET, LABEL_AUTOROTATE.

Parameters:

ctx -

removeAllLayoutSubjects

public void removeAllLayoutSubjects()

Description copied from class: AbstractFigure

This implementation is empty.

Specified by:

removeAllLayoutSubjects in interface Figure

Overrides:

removeAllLayoutSubjects in class AbstractFigure

removeLayoutSubject

public void removeLayoutSubject(@NonNull Figure subject)

Description copied from class: AbstractFigure

This implementation is empty.

Specified by:

removeLayoutSubject in interface Figure

Overrides:

removeLayoutSubject in class AbstractFigure

Parameters:

subject - the connected figure

updateGroupNode

public void updateGroupNode(@NonNull RenderContext ctx,
 @NonNull javafx.scene.Group node)

Description copied from class: AbstractLabelFigure

Updates the group node that holds all other nodes of the label.

This method is empty. Subclasses may apply properties to the group node.

Overrides:

updateGroupNode in class AbstractLabelFigure

Parameters:

ctx - the render context

node - the group node

reshapeInLocal

public void reshapeInLocal(@NonNull CssSize x,
 @NonNull CssSize y,
 @NonNull CssSize width,
 @NonNull CssSize height)

Description copied from interface: Figure

Attempts to change the local bounds of the figure.

See {#link #reshapeInLocal(Transform)} for a description of this method.

This method takes parameters as CssSizes. This can be used to avoid rounding errors when the figure is reshaped in non-pixel units.

This method can forward a call to Figure.reshapeInLocal(Transform) using the following code:

 void reshapeInLocal(@NonNull CssSize x, @NonNull CssSize y, @NonNull CssSize width, @NonNull CssSize height) {
   Transform tx = Transforms.createReshapeTransform(getCssBoundsInLocal(), x, y, width, height);
   reshapeInLocal(tx);
 }
 

Specified by:

reshapeInLocal in interface Figure

Overrides:

reshapeInLocal in class AbstractLabelFigure

Parameters:

x - desired x-position in parent coordinates

y - desired y-position in parent coordinates

width - desired width in parent coordinates, may be negative

height - desired height in parent coordinates, may be negative

translateInLocal

public void translateInLocal(@NonNull CssPoint2D delta)

Description copied from interface: Figure

Attempts to translate the local bounds of the figure.

Specified by:

translateInLocal in interface Figure

Overrides:

translateInLocal in class AbstractLabelFigure

Parameters:

delta - the translation in x and in y direction

setLabelConnection

public void setLabelConnection(@Nullable Figure target,
 @Nullable Connector connector)