Module org.jhotdraw8.draw

Package org.jhotdraw8.draw.figure

Interface StyleableFigure

All Superinterfaces:

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

All Known Implementing Classes:

ArcFigure, BezierPathFigure, ClippingFigure, CombinedPathFigure, EllipseFigure, GroupFigure, ImageFigure, LabelFigure, LayerFigure, LineConnectionFigure, LineConnectionWithMarkersFigure, LineFigure, PageFigure, PageLabelFigure, PolygonFigure, PolylineFigure, RectangleFigure, RegionFigure, SimpleDrawing, SimpleLabelConnectionFigure, SimpleLayeredDrawing, SliceFigure, TextAreaFigure, TextFigure

public interface StyleableFigure
extends Figure

StyleableFigure provides user-editable "id", "style class" and "style" properties, and a non-user-editable "pseudo-class" property.

Author:

Werner Randelshofer

Property Summary

Properties

Type	Property	Description
default @NonNull javafx.beans.property.ReadOnlyProperty<String>	id

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

parent

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 NullableStringStyleableKey	ID	Defines the id for styling the figure with CSS.
static final @NonNull WordSetKey	PSEUDO_CLASS	Defines the pseudo class states of the figure.
static final @NonNull StringReadOnlyStyleableKey	STYLE	Defines the style of the figure.
static final @NonNull WordSetKey	STYLE_CLASS	Defines the style class of the figure.
static final String	TYPE_SELECTOR_NODE_KEY	We store the type selector of the figure on the node that is used to render 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	applyStyleableFigureProperties(@NonNull RenderContext ctx, @NonNull javafx.scene.Node node)	Updates a figure node with all style and effect properties defined in this interface.
default @Nullable String	getId()	Gets the value of the id property.
default @NonNull ReadOnlySet<String>	getPseudoClassStates()
default @Nullable String	getStyle()
default @NonNull ReadOnlySet<String>	getStyleClasses()
default @NonNull javafx.beans.property.ReadOnlyProperty<String>	idProperty()

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

addChild, addedToDrawing, createHandles, createNode, disconnect, firePropertyChangeEvent, firePropertyChangeEvent, getBoundsInLocal, 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

getTypeSelector

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

Property Details

id

default @NonNull javafx.beans.property.ReadOnlyProperty<String> idProperty

Specified by:

idProperty in interface StyleableBean

See Also:

• getId()
• idProperty()

Field Details

ID

static final @NonNull NullableStringStyleableKey ID

Defines the id for styling the figure with CSS.

Default value: null.

STYLE_CLASS

static final @NonNull WordSetKey STYLE_CLASS

Defines the style class of the figure. The style class is used for styling a figure with CSS.

Default value: empty set.

PSEUDO_CLASS

static final @NonNull WordSetKey PSEUDO_CLASS

Defines the pseudo class states of the figure. The pseudo class states are used for styling a figure with CSS. This property should not be made persistent because it is a computed value.

Default value: empty set.

STYLE

static final @NonNull StringReadOnlyStyleableKey STYLE

Defines the style of the figure. The style is used for styling a figure with CSS.

Default value: null.

TYPE_SELECTOR_NODE_KEY

static final String TYPE_SELECTOR_NODE_KEY

We store the type selector of the figure on the node that is used to render the figure. This allows to pass this information through to classes that export a rendered scene graph.

This key is a String, because it is set as a property on the JavaFX node that is used to render the figure. The value type of the property is a String.

See Also:

• Constant Field Values

Method Details

applyStyleableFigureProperties

default void applyStyleableFigureProperties(@NonNull RenderContext ctx,
 @NonNull javafx.scene.Node node)

Updates a figure node with all style and effect properties defined in this interface.

Applies the following properties: ID, VISIBLE.

This method is intended to be used by Figure.updateNode(org.jhotdraw8.draw.render.RenderContext, javafx.scene.Node).

Parameters:

ctx - the render context

node - a node which was created with method Figure.createNode(org.jhotdraw8.draw.render.RenderContext).

getStyle

default @Nullable String getStyle()

Specified by:

getStyle in interface StyleableBean

getStyleClasses

default @NonNull ReadOnlySet<String> getStyleClasses()

Specified by:

getStyleClasses in interface StyleableBean

getPseudoClassStates

default @NonNull ReadOnlySet<String> getPseudoClassStates()

Specified by:

getPseudoClassStates in interface StyleableBean

getId

default @Nullable String getId()

Gets the value of the id property.

Specified by:

getId in interface StyleableBean

Property description:

Returns:

the value of the id property

See Also:

• idProperty()

idProperty

default @NonNull javafx.beans.property.ReadOnlyProperty<String> idProperty()

Specified by:

idProperty in interface StyleableBean

Returns:

the id property

See Also:

• getId()