Module org.jhotdraw8.draw

Package org.jhotdraw8.draw.figure

Class AbstractCompositeFigure

java.lang.Object

org.jhotdraw8.fxbase.styleable.AbstractStyleablePropertyBean

org.jhotdraw8.draw.figure.AbstractFigure

org.jhotdraw8.draw.figure.AbstractCompositeFigure

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractDrawing, ClippingFigure, CombinedPathFigure, GroupFigure, LayerFigure, PageFigure

public abstract class AbstractCompositeFigure
extends AbstractFigure

This base class can be used to implement figures which support child figures.

Author:

Werner Randelshofer

Property Summary

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

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

CACHE

Constructor Summary

Constructors

Constructor	Description
AbstractCompositeFigure()

Method Summary

Modifier and Type	Method	Description
void	firePropertyChangeEvent(@NonNull FigurePropertyChangeEvent event)	Fires a property change event.
<T> void	firePropertyChangeEvent(@Nullable Figure source, Key<T> key, T oldValue, T newValue, boolean wasAdded, boolean wasRemoved)	Fires a property change event.
@NonNull javafx.geometry.Bounds	getBoundsInLocal()	The bounds of this figure in local coordinates, including space required for a non-zero stroke.
@NonNull javafx.collections.ObservableList<Figure>	getChildren()	The child figures.
@NonNull CssRectangle2D	getCssLayoutBounds()
@NonNull javafx.geometry.Bounds	getLayoutBounds()	The bounds that should be used for transformations of this figure.
@NonNull javafx.geometry.Bounds	getLayoutBoundsInParent()	The layout bounds of this figure in parent coordinates.
final boolean	isAllowsChildren()	Whether children may be added to this figure.

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

addedToDrawing, createKeyMap, doAddedToDrawing, doRemovedFromDrawing, getCachedLocalToParent, getCachedLocalToWorld, getCachedParentToLocal, getCachedParentToWorld, getCachedWorldToLocal, getCachedWorldToParent, getDrawing, getLayoutObservers, getPropertyChangeListeners, getReadOnlyLayoutObservers, getStyledNonNull, hasPropertyChangeListeners, onPropertyChanged, parentProperty, removeAllLayoutSubjects, removedFromDrawing, removeLayoutSubject, 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.Figure

addChild, createHandles, createNode, disconnect, getBoundsInParent, getBoundsInWorld, getCenterInLocal, getCenterInParent, getLayer, getLayoutBoundsInWorld, getLayoutSubjects, getLocalToParent, getParent, getParentToLocal, getPreferredAspectRatio, getRoot, getStyleableParent, getSupportedKeys, getVisualBounds, getVisualBoundsInWorld, isDecomposable, isDeletable, isDeletWithLastLayoutSubject, isEditable, isEditableKey, isGroupReshapeableWith, isLayoutable, isSelectable, isShowing, isSuitableChild, isSuitableParent, isSupportedKey, isVisible, layout, layoutChanged, layoutObserverChanged, layoutSubjectChanged, localToParent, localToWorld, localToWorld, propertyChanged, removeChild, reshapeInLocal, reshapeInLocal, reshapeInLocal, reshapeInLocal, reshapeInParent, setParent, stylesheetChanged, transformChanged, transformInLocal, transformInParent, translateInLocal, translateInParent, 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, remove, removeAll, resetStyledValues, setStyled

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

getLocalToWorld, getParentToWorld, getWorldToLocal, getWorldToParent, invalidateTransforms

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

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

Constructor Details

AbstractCompositeFigure

public AbstractCompositeFigure()

Method Details

getChildren

public @NonNull javafx.collections.ObservableList<Figure> getChildren()

Description copied from interface: Figure

The child figures.

All changes on this list causes this figure to fire an invalidation event.

If a child is added to this list, then this figure removes the child from its former parent, and then sets itself as the parent of the child.

If a child is removed from this list, then this figure sets the parent of the child to null.

Returns:

the children

isAllowsChildren

public final boolean isAllowsChildren()

Description copied from interface: Figure

Whether children may be added to this figure.

Returns:

true if getChildren are allowed

getLayoutBounds

public @NonNull javafx.geometry.Bounds getLayoutBounds()

Description copied from interface: Figure

The bounds that should be used for transformations of this figure.

The bounds are given in the untransformed local coordinate space of the figure.

This method may use caching and return incorrect results if the cache is stale. Invoke Figure.layout(org.jhotdraw8.draw.render.RenderContext) if you are not sure that the cache is valid.

Returns:

the local bounds

getBoundsInLocal

public @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.

Returns:

the local bounds

getCssLayoutBounds

public @NonNull CssRectangle2D getCssLayoutBounds()

getLayoutBoundsInParent

public @NonNull javafx.geometry.Bounds getLayoutBoundsInParent()

Description copied from interface: Figure

The layout bounds of this figure in parent coordinates.

The bounds are given in the coordinate space of the parent figure.

This method may use caching and return incorrect results if the caches are stale. Invoke Figure.invalidateTransforms() and Figure.layout(org.jhotdraw8.draw.render.RenderContext) if you are not sure that the cache is valid.

Returns:

the local bounds

firePropertyChangeEvent

public void firePropertyChangeEvent(@NonNull FigurePropertyChangeEvent event)

Description copied from interface: Figure

Fires a property change event.

Parameters:

event - the event

firePropertyChangeEvent

public <T> void firePropertyChangeEvent(@Nullable Figure source,
 Key<T> key,
 T oldValue,
 T newValue,
 boolean wasAdded,
 boolean wasRemoved)

Description copied from interface: Figure

Fires a property change event.

Type Parameters:

T - the value type

Parameters:

source - the event source

key - the property key

oldValue - the old property value

newValue - the new property value

wasAdded - true if the new property value was added

wasRemoved - true if the old property value was removed