Module org.jhotdraw8.draw

Package org.jhotdraw8.draw.figure

Class AbstractFigure

java.lang.Object

org.jhotdraw8.fxbase.styleable.AbstractStyleablePropertyBean

org.jhotdraw8.draw.figure.AbstractFigure

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractCompositeFigure, AbstractLeafFigure

public abstract class AbstractFigure
extends AbstractStyleablePropertyBean
implements Figure, TransformCachingFigure

AbstractFigure.

Author:

Werner Randelshofer

Property Summary

Properties

Type	Property	Description
@NonNull javafx.beans.property.ObjectProperty<Figure>	parent	The parent figure.

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
AbstractFigure()

Method Summary

Modifier and Type	Method	Description
final void	addedToDrawing(@NonNull Drawing drawing)	This method calls doAddedToDrawing(org.jhotdraw8.draw.figure.Drawing).
protected @NonNull Map<Key<?>,Integer>	createKeyMap()
protected void	doAddedToDrawing(@NonNull Drawing drawing)	This method is called by Figure.addedToDrawing(org.jhotdraw8.draw.figure.Drawing).
protected void	doRemovedFromDrawing(Drawing drawing)	This method is called by removedFromDrawing(org.jhotdraw8.draw.figure.Drawing).
@Nullable javafx.scene.transform.Transform	getCachedLocalToParent()
@Nullable javafx.scene.transform.Transform	getCachedLocalToWorld()
@Nullable javafx.scene.transform.Transform	getCachedParentToLocal()
@Nullable javafx.scene.transform.Transform	getCachedParentToWorld()
@Nullable javafx.scene.transform.Transform	getCachedWorldToLocal()
@Nullable javafx.scene.transform.Transform	getCachedWorldToParent()
final @Nullable Drawing	getDrawing()	Returns the ancestor Drawing.
final @NonNull Set<Figure>	getLayoutObservers()	Returns all figures which observe the layout of this figure.
CopyOnWriteArrayList<org.jhotdraw8.base.event.Listener<FigurePropertyChangeEvent>>	getPropertyChangeListeners()	List of property change listeners.
@NonNull ReadOnlySet<Figure>	getReadOnlyLayoutObservers()
<T> @NonNull T	getStyledNonNull(@NonNull NonNullMapAccessor<T> key)
boolean	hasPropertyChangeListeners()	Whether this figure has property change listeners.
protected <T> void	onPropertyChanged(Key<T> key, T oldValue, T newValue, boolean wasAdded, boolean wasRemoved)	Overrides of this method must call super!
@NonNull javafx.beans.property.ObjectProperty<Figure>	parentProperty()	The parent figure.
void	removeAllLayoutSubjects()	This implementation is empty.
final void	removedFromDrawing(Drawing drawing)	This method calls doAddedToDrawing(org.jhotdraw8.draw.figure.Drawing).
void	removeLayoutSubject(Figure connectedFigure)	This implementation is empty.
void	setCachedLocalToParent(@Nullable javafx.scene.transform.Transform newValue)
void	setCachedLocalToWorld(@Nullable javafx.scene.transform.Transform newValue)
void	setCachedParentToLocal(@Nullable javafx.scene.transform.Transform newValue)
void	setCachedParentToWorld(@Nullable javafx.scene.transform.Transform newValue)
void	setCachedWorldToLocal(@Nullable javafx.scene.transform.Transform newValue)
void	setCachedWorldToParent(@Nullable javafx.scene.transform.Transform newValue)
void	updateCss(RenderContext ctx)	Updates the stylesheet cache of this figure depending on its property values and on the and the property values of its ancestors.

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, firePropertyChangeEvent, firePropertyChangeEvent, getBoundsInLocal, getBoundsInParent, getBoundsInWorld, getCenterInLocal, getCenterInParent, getChildren, getCssLayoutBounds, getLayer, getLayoutBounds, getLayoutBoundsInParent, getLayoutBoundsInWorld, getLayoutSubjects, getLocalToParent, getParent, getParentToLocal, getPreferredAspectRatio, getRoot, getStyleableParent, getSupportedKeys, getVisualBounds, getVisualBoundsInWorld, isAllowsChildren, 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

Property Details

parent

public @NonNull javafx.beans.property.ObjectProperty<Figure> parentProperty

Specified by:

parentProperty in interface Figure

Returns:

the parent property, with getBean() returning this figure, and getName() returning PARENT_PROPERTY.

See Also:

• parentProperty()

Constructor Details

AbstractFigure

public AbstractFigure()

Method Details

createKeyMap

protected @NonNull Map<Key<?>,Integer> createKeyMap()

Overrides:

createKeyMap in class AbstractStyleablePropertyBean

addedToDrawing

public final void addedToDrawing(@NonNull Drawing drawing)

This method calls doAddedToDrawing(org.jhotdraw8.draw.figure.Drawing).

Specified by:

addedToDrawing in interface Figure

Parameters:

drawing - the drawing

doAddedToDrawing

protected void doAddedToDrawing(@NonNull Drawing drawing)

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

Parameters:

drawing - the drawing

doRemovedFromDrawing

protected void doRemovedFromDrawing(Drawing drawing)

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

Parameters:

drawing - the drawing

getDrawing

public final @Nullable Drawing getDrawing()

Description copied from interface: Figure

Returns the ancestor Drawing.

Specified by:

getDrawing in interface Figure

Returns:

the drawing or null if no ancestor is a drawing. Returns this, if this figure is a drawing.

getLayoutObservers

public final @NonNull Set<Figure> getLayoutObservers()

Description copied from interface: Figure

Returns all figures which observe the layout of this figure.

When the layout of this figure changes, then the layout of the observers figures must be updated.

The update strategy is implemented in DrawingModel. DrawingMode observes state changes in figures and updates dependent figures. DrawingModel can coalesce multiple state changes of an observed figure into a smaller number of layout calls on the observers. DrawingModel can also detect cyclic layout dependencies and prevent endless update loops.

This set must be synchronized, because it is accessed by other figures, when there properties are changed.

Specified by:

getLayoutObservers in interface Figure

Returns:

a list of dependent figures

getReadOnlyLayoutObservers

public @NonNull ReadOnlySet<Figure> getReadOnlyLayoutObservers()

Specified by:

getReadOnlyLayoutObservers in interface Figure

getPropertyChangeListeners

public CopyOnWriteArrayList<org.jhotdraw8.base.event.Listener<FigurePropertyChangeEvent>> getPropertyChangeListeners()

Description copied from interface: Figure

List of property change listeners.

Specified by:

getPropertyChangeListeners in interface Figure

Returns:

a list of property change listeners

hasPropertyChangeListeners

public boolean hasPropertyChangeListeners()

Description copied from interface: Figure

Whether this figure has property change listeners.

Specified by:

hasPropertyChangeListeners in interface Figure

Returns:

true if this figure has property change listeners

parentProperty

public @NonNull javafx.beans.property.ObjectProperty<Figure> parentProperty()

Description copied from interface: Figure

The parent figure.

If this figure has not been added as a child to another figure, then this variable will be null.

By convention the parent is set exclusively by a composite figure on its child figures. The composite figure sets parent to itself on a child immediately after the child figure has been added to the composite figure. The composite figure sets parent to null on a child immediately after the child figure has been removed from the composite figure.

Specified by:

parentProperty in interface Figure

Returns:

the parent property

removeAllLayoutSubjects

public void removeAllLayoutSubjects()

This implementation is empty.

Specified by:

removeAllLayoutSubjects in interface Figure

removeLayoutSubject

public void removeLayoutSubject(Figure connectedFigure)

This implementation is empty.

Specified by:

removeLayoutSubject in interface Figure

Parameters:

connectedFigure - the connected figure

removedFromDrawing

public final void removedFromDrawing(Drawing drawing)

This method calls doAddedToDrawing(org.jhotdraw8.draw.figure.Drawing).

Specified by:

removedFromDrawing in interface Figure

Parameters:

drawing - the drawing from which this figure has been removed

getCachedLocalToWorld

public @Nullable javafx.scene.transform.Transform getCachedLocalToWorld()

Specified by:

getCachedLocalToWorld in interface TransformCachingFigure

setCachedLocalToWorld

public void setCachedLocalToWorld(@Nullable javafx.scene.transform.Transform newValue)

Specified by:

setCachedLocalToWorld in interface TransformCachingFigure

getCachedWorldToParent

public @Nullable javafx.scene.transform.Transform getCachedWorldToParent()

Specified by:

getCachedWorldToParent in interface TransformCachingFigure

setCachedWorldToParent

public void setCachedWorldToParent(@Nullable javafx.scene.transform.Transform newValue)

Specified by:

setCachedWorldToParent in interface TransformCachingFigure

getCachedParentToLocal

public @Nullable javafx.scene.transform.Transform getCachedParentToLocal()

Specified by:

getCachedParentToLocal in interface TransformCachingFigure

setCachedParentToLocal

public void setCachedParentToLocal(@Nullable javafx.scene.transform.Transform newValue)

Specified by:

setCachedParentToLocal in interface TransformCachingFigure

getCachedLocalToParent

public @Nullable javafx.scene.transform.Transform getCachedLocalToParent()

Specified by:

getCachedLocalToParent in interface TransformCachingFigure

setCachedLocalToParent

public void setCachedLocalToParent(@Nullable javafx.scene.transform.Transform newValue)

Specified by:

setCachedLocalToParent in interface TransformCachingFigure

getCachedWorldToLocal

public @Nullable javafx.scene.transform.Transform getCachedWorldToLocal()

Specified by:

getCachedWorldToLocal in interface TransformCachingFigure

setCachedWorldToLocal

public void setCachedWorldToLocal(@Nullable javafx.scene.transform.Transform newValue)

Specified by:

setCachedWorldToLocal in interface TransformCachingFigure

getCachedParentToWorld

public @Nullable javafx.scene.transform.Transform getCachedParentToWorld()

Specified by:

getCachedParentToWorld in interface TransformCachingFigure

setCachedParentToWorld

public void setCachedParentToWorld(@Nullable javafx.scene.transform.Transform newValue)

Specified by:

setCachedParentToWorld in interface TransformCachingFigure

updateCss

public void updateCss(RenderContext ctx)

Description copied from interface: Figure

Updates the stylesheet cache of this figure depending on its property values and on the and the property values of its ancestors.

This figure does not keep track of changes that require CSS updates. Use a DrawingModel to manage CSS updates.

Specified by:

updateCss in interface Figure

Parameters:

ctx - the render context

onPropertyChanged

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

Overrides of this method must call super!

Overrides:

onPropertyChanged in class AbstractStyleablePropertyBean

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)

getStyledNonNull

public <T> @NonNull T getStyledNonNull(@NonNull NonNullMapAccessor<T> key)

Specified by:

getStyledNonNull in interface StyleablePropertyBean