Module org.jhotdraw8.draw

Package org.jhotdraw8.draw.figure

Interface StrokableFigure

All Superinterfaces:

Figure, PropertyBean, StyleableBean, StyleablePropertyBean, TreeNode<Figure>

All Known Implementing Classes:

AbstractLabelConnectionFigure, AbstractLabelFigure, ArcFigure, BezierPathFigure, CombinedPathFigure, EllipseFigure, LabelFigure, LineConnectionFigure, LineConnectionWithMarkersFigure, LineFigure, PageFigure, PageLabelFigure, PolygonFigure, PolylineFigure, RectangleFigure, RegionFigure, SimpleLabelConnectionFigure, TextAreaFigure, TextFigure

public interface StrokableFigure
extends Figure

Interface for figures which render a javafx.scene.shape.Shape and can be stroked.

Author:

Werner Randelshofer

Property Summary

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 NullablePaintableStyleableKey	STROKE	Defines the paint used for filling the outline of the figure.
static final @NonNull NonNullListStyleableKey<CssSize>	STROKE_DASH_ARRAY	Defines the dash array used.
static final @NonNull CssSizeStyleableKey	STROKE_DASH_OFFSET	Defines the distance in user coordinates for the dashing pattern.
static final @NonNull NonNullEnumStyleableKey<javafx.scene.shape.StrokeLineCap>	STROKE_LINE_CAP	Defines the end cap style.
static final @NonNull NonNullEnumStyleableKey<javafx.scene.shape.StrokeLineJoin>	STROKE_LINE_JOIN	Defines the style applied where path segments meet.
static final @NonNull CssSizeStyleableKey	STROKE_MITER_LIMIT	Defines the limit for the StrokeLineJoin.MITER style.
static final @Nullable StrokeStyleableMapAccessor	STROKE_STYLE	Combined map accessor for all stroke style properties.
static final @NonNull NonNullEnumStyleableKey<javafx.scene.shape.StrokeType>	STROKE_TYPE	Defines the stroke type used for drawing outline of the figure.
static final @NonNull CssSizeStyleableKey	STROKE_WIDTH	Defines the width of the outline of the figure.

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

declaredAndInheritedKeys, JHOTDRAW_CSS_PREFIX, PARENT_PROPERTY

Method Summary

Modifier and Type	Method	Description
default void	applyStrokableFigureProperties(@Nullable RenderContext ctx, @NonNull javafx.scene.shape.Shape shape)	Updates a shape node.
default void	applyStrokeCapAndJoinProperties(RenderContext ctx, @NonNull javafx.scene.shape.Shape shape)
default void	applyStrokeColorProperties(@Nullable RenderContext ctx, @NonNull javafx.scene.shape.Shape shape)
default void	applyStrokeDashProperties(RenderContext ctx, @NonNull javafx.scene.shape.Shape shape)
default void	applyStrokeTypeProperties(RenderContext ctx, @NonNull javafx.scene.shape.Shape shape)
default void	applyStrokeWidthProperties(@Nullable RenderContext ctx, @NonNull javafx.scene.shape.Shape shape)
default @NonNull javafx.geometry.Bounds	getBoundsInLocal()	The bounds of this figure in local coordinates, including space required for a non-zero stroke.
default @NonNull BasicStroke	getStyledStroke(@Nullable RenderContext ctx)

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

addChild, addedToDrawing, createHandles, createNode, disconnect, firePropertyChangeEvent, firePropertyChangeEvent, getBoundsInParent, getBoundsInWorld, getCenterInLocal, getCenterInParent, getChildren, getCssLayoutBounds, getDrawing, getLayer, getLayoutBounds, getLayoutBoundsInParent, getLayoutBoundsInWorld, getLayoutObservers, getLayoutSubjects, getLocalToParent, getLocalToWorld, getParent, getParentToLocal, getParentToWorld, getPreferredAspectRatio, getPropertyChangeListeners, getReadOnlyLayoutObservers, getRoot, getStyleableParent, getSupportedKeys, getVisualBounds, getVisualBoundsInWorld, getWorldToLocal, getWorldToParent, hasPropertyChangeListeners, invalidateTransforms, isAllowsChildren, isDecomposable, isDeletable, isDeletWithLastLayoutSubject, isEditable, isEditableKey, isGroupReshapeableWith, isLayoutable, isSelectable, isShowing, isSuitableChild, isSuitableParent, isSupportedKey, isVisible, layout, layoutChanged, layoutObserverChanged, layoutSubjectChanged, localToParent, localToWorld, localToWorld, parentProperty, propertyChanged, removeAllLayoutSubjects, removeChild, removedFromDrawing, removeLayoutSubject, reshapeInLocal, reshapeInLocal, reshapeInLocal, reshapeInLocal, reshapeInParent, setParent, stylesheetChanged, transformChanged, transformInLocal, transformInParent, translateInLocal, translateInParent, updateCss, updateNode, worldToLocal, worldToLocal, worldToParent, worldToParent

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

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

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.fxbase.tree.TreeNode

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

Field Details

STROKE_DASH_OFFSET

static final @NonNull CssSizeStyleableKey STROKE_DASH_OFFSET

Defines the distance in user coordinates for the dashing pattern. Default value: 0.

References:

SVG Stroke Properties

w3.org

STROKE_LINE_CAP

static final @NonNull NonNullEnumStyleableKey<javafx.scene.shape.StrokeLineCap> STROKE_LINE_CAP

Defines the end cap style. Default value: SQUARE.

References:

SVG Stroke Properties

w3.org

STROKE_LINE_JOIN

static final @NonNull NonNullEnumStyleableKey<javafx.scene.shape.StrokeLineJoin> STROKE_LINE_JOIN

Defines the style applied where path segments meet. Default value: MITER.

References:

SVG Stroke Properties

w3.org

STROKE_MITER_LIMIT

static final @NonNull CssSizeStyleableKey STROKE_MITER_LIMIT

Defines the limit for the StrokeLineJoin.MITER style.

Default value: 4.0.

References:

SVG Stroke Properties

w3.org

STROKE

static final @NonNull NullablePaintableStyleableKey STROKE

Defines the paint used for filling the outline of the figure. Default value: Color.BLACK.

References:

SVG Stroke Properties

w3.org

STROKE_TYPE

static final @NonNull NonNullEnumStyleableKey<javafx.scene.shape.StrokeType> STROKE_TYPE

Defines the stroke type used for drawing outline of the figure.

Default value: StrokeType.CENTERED.

STROKE_WIDTH

static final @NonNull CssSizeStyleableKey STROKE_WIDTH

Defines the width of the outline of the figure.

Default value: 1.0.

References:

SVG Stroke Properties

w3.org

STROKE_DASH_ARRAY

static final @NonNull NonNullListStyleableKey<CssSize> STROKE_DASH_ARRAY

Defines the dash array used. Default value: empty array.

References:

SVG Stroke Properties

w3.org

STROKE_STYLE

static final @Nullable StrokeStyleableMapAccessor STROKE_STYLE

Combined map accessor for all stroke style properties.

Note: this is a non-standard composite map accessor and thus transient!

Method Details

applyStrokeCapAndJoinProperties

default void applyStrokeCapAndJoinProperties(RenderContext ctx,
 @NonNull javafx.scene.shape.Shape shape)

applyStrokeDashProperties

default void applyStrokeDashProperties(RenderContext ctx,
 @NonNull javafx.scene.shape.Shape shape)

applyStrokeTypeProperties

default void applyStrokeTypeProperties(RenderContext ctx,
 @NonNull javafx.scene.shape.Shape shape)

applyStrokableFigureProperties

default void applyStrokableFigureProperties(@Nullable RenderContext ctx,
 @NonNull javafx.scene.shape.Shape shape)

Updates a shape node.

Parameters:

ctx - the render context

shape - a shape node

applyStrokeColorProperties

default void applyStrokeColorProperties(@Nullable RenderContext ctx,
 @NonNull javafx.scene.shape.Shape shape)

applyStrokeWidthProperties

default void applyStrokeWidthProperties(@Nullable RenderContext ctx,
 @NonNull javafx.scene.shape.Shape shape)

getStyledStroke

default @NonNull BasicStroke getStyledStroke(@Nullable RenderContext ctx)

getBoundsInLocal

default @NonNull javafx.geometry.Bounds getBoundsInLocal()

Description copied from interface: Figure

The bounds of this figure in local coordinates, including space required for a non-zero stroke.

Specified by:

getBoundsInLocal in interface Figure

Returns:

the local bounds