Module org.jhotdraw8.draw

Package org.jhotdraw8.draw.figure

Interface CompositableFigure

All Superinterfaces:

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

All Known Implementing Classes:

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

public interface CompositableFigure
extends Figure

Provides properties for compositing a figure.

Usage:

 class MyFigureClass implements CompositableFigure {
     public void updateNode(@NonNull RenderContext ctx, Node n) {
         applyCompositableFigureProperties(ctx, n);
     }
 }
 

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 NonNullEnumStyleableKey<javafx.scene.effect.BlendMode>	BLEND_MODE	Specifies a blend mode applied to the figure.
static final @NonNull EffectStyleableKey	EFFECT	Specifies an effect applied to the figure.
static final @NonNull DoubleStyleableKey	OPACITY	Specifies the opacity 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	applyCompositableFigureProperties(@NonNull RenderContext ctx, @NonNull javafx.scene.Node node)	Updates a figure node with all effect properties defined in this interface.

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

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

BLEND_MODE

static final @NonNull NonNullEnumStyleableKey<javafx.scene.effect.BlendMode> BLEND_MODE

Specifies a blend mode applied to the figure.

Default value: SRC_OVER.

EFFECT

static final @NonNull EffectStyleableKey EFFECT

Specifies an effect applied to the figure. The null value means that no effect is applied.

Default value: null.

OPACITY

static final @NonNull DoubleStyleableKey OPACITY

Specifies the opacity of the figure. A figure with 0 opacity is completely translucent. A figure with 1 opacity is completely opaque.

Values smaller than 0 are treated as 0. Values larger than 1 are treated as 1.

Default value: 1.

Method Details

applyCompositableFigureProperties

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

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

Applies the following properties: BLEND_MODE, EFFECT, OPACITY.

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).