Module org.jhotdraw8.draw

Package org.jhotdraw8.draw

Interface DrawingEditor

All Known Implementing Classes:

AbstractDrawingEditor, SimpleDrawingEditor

public interface DrawingEditor

The DrawingEditor can be used to edit multiple DrawingViews with a single Tool.

The DrawingEditor invokes activate() and deactivate() methods on the Tool if it becomes the active tool or loses this status.

Author:

Werner Randelshofer

Property Summary

Properties

Type	Property	Description
@NonNull javafx.beans.property.ObjectProperty<DrawingView>	activeDrawingView	The currently active drawing view.
@NonNull javafx.beans.property.ObjectProperty<Tool>	activeTool	The currently active tool.
@NonNull javafx.beans.property.ObjectProperty<HandleType>	anchorHandleType	The handle type used for marking the anchor of a selection.
@NonNull javafx.beans.property.ObjectProperty<Tool>	defaultTool	The default tool.
@NonNull javafx.beans.property.ReadOnlySetProperty<DrawingView>	drawingViews	The drawing views associated with this editor.
NonNullObjectProperty<CssColor>	handleColor	Holds the color of the handles.
javafx.beans.property.DoubleProperty	handleSize	Holds the size (width and height) of a handle.
javafx.beans.property.DoubleProperty	handleStrokeWidth	Holds the stroke width of a handle.
@NonNull NonNullObjectProperty<HandleType>	handleType	The handle type for single selection.
@NonNull javafx.beans.property.ObjectProperty<String>	helpText	Holds the curent help text associated with this drawing view.
@NonNull javafx.beans.property.ObjectProperty<HandleType>	leadHandleType	The handle type used for marking the lead of a selection.
@NonNull NonNullObjectProperty<HandleType>	multiHandleType	The handle type for multiple selection.
javafx.beans.property.DoubleProperty	tolerance	Holds the tolerance for finding figures.
@NonNull NonNullObjectProperty<FXUndoManager>	undoManager	The undo manager is responsible for providing undo/redo functionality.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTIVE_DRAWING_VIEW_PROPERTY	The name of the activeDrawingView property.
static final String	ACTIVE_TOOL_PROPERTY	The name of the activeTool property.
static final String	DEFAULT_TOOL_PROPERTY	The name of the defaultTool property.
static final String	DRAWING_VIEWS_PROPERTY	The name of the drawingViews property.
static final String	HANDLE_COLOR_PROPERTY
static final String	HANDLE_SIZE_PROPERTY
static final String	HANDLE_STROKE_WDITH_PROPERTY
static final String	HANDLE_TYPE_PROPERTY	The name of the handle type property for single selection.
static final String	HELP_TEXT_PROPERTY	The name of the helpText property.
static final String	MULTI_HANDLE_TYPE_PROPERTY	The name of the handle type property for multiple selection.
static final String	TOLERANCE_PROPERTY
static final String	UNDO_MANAGER_PROPERTY	The name of the undoManager property.

Method Summary

Modifier and Type	Method	Description
@NonNull javafx.beans.property.ObjectProperty<DrawingView>	activeDrawingViewProperty()	The currently active drawing view.
@NonNull javafx.beans.property.ObjectProperty<Tool>	activeToolProperty()	The currently active tool.
default void	addDrawingView(DrawingView drawingView)	Adds a drawing view to this editor.
@NonNull javafx.beans.property.ObjectProperty<HandleType>	anchorHandleTypeProperty()	The handle type used for marking the anchor of a selection.
@NonNull javafx.beans.property.ObjectProperty<Tool>	defaultToolProperty()	The default tool.
@NonNull javafx.beans.property.ReadOnlySetProperty<DrawingView>	drawingViewsProperty()	The drawing views associated with this editor.
default @Nullable DrawingView	getActiveDrawingView()	Gets the active drawing view.
default @Nullable Tool	getActiveTool()	Gets the active tool.
default @Nullable HandleType	getAnchorHandleType()	Gets the value of the anchorHandleType property.
default @Nullable Tool	getDefaultTool()	Gets the default tool.
default javafx.collections.ObservableSet<DrawingView>	getDrawingViews()	Gets the drawing views.
default CssColor	getHandleColor()	Gets the value of the handleColor property.
default double	getHandleSize()	Gets the value of the handleSize property.
default double	getHandleStrokeWidth()	Gets the value of the handleStrokeWidth property.
default @Nullable HandleType	getHandleType()	Gets the value of the handleType property.
default String	getHelpText()	Gets the value of the helpText property.
default @Nullable HandleType	getLeadHandleType()	Gets the value of the leadHandleType property.
default @Nullable HandleType	getMultiHandleType()	Gets the value of the multiHandleType property.
default double	getTolerance()	Tolerance (radius) in view coordinates.
default @NonNull FXUndoManager	getUndoManager()	Gets the value of the undoManager property.
NonNullObjectProperty<CssColor>	handleColorProperty()	Holds the color of the handles.
javafx.beans.property.DoubleProperty	handleSizeProperty()	Holds the size (width and height) of a handle.
javafx.beans.property.DoubleProperty	handleStrokeWidthProperty()	Holds the stroke width of a handle.
@NonNull NonNullObjectProperty<HandleType>	handleTypeProperty()	The handle type for single selection.
@NonNull javafx.beans.property.ObjectProperty<String>	helpTextProperty()	Holds the curent help text associated with this drawing view.
@NonNull javafx.beans.property.ObjectProperty<HandleType>	leadHandleTypeProperty()	The handle type used for marking the lead of a selection.
@NonNull NonNullObjectProperty<HandleType>	multiHandleTypeProperty()	The handle type for multiple selection.
default void	recreateHandles()
default void	removeDrawingView(DrawingView drawingView)	Removes a drawing view to this editor.
default void	setActiveDrawingView(@Nullable DrawingView drawingView)	Sets the active drawing view.
default void	setActiveTool(@Nullable Tool tool)	Sets the active tool.
default void	setAnchorHandleType(@Nullable HandleType newValue)	Sets the value of the anchorHandleType property.
default void	setDefaultTool(@Nullable Tool tool)	Sets the default tool.
default void	setHandleColor(CssColor newValue)	Sets the value of the handleColor property.
default void	setHandleSize(double newValue)	Sets the value of the handleSize property.
default void	setHandleStrokeWidth(double newValue)	Sets the value of the handleStrokeWidth property.
default void	setHandleType(@Nullable HandleType newValue)	Sets the value of the handleType property.
default void	setHelpText(String newValue)	Sets the value of the helpText property.
default void	setLeadHandleType(@Nullable HandleType newValue)	Sets the value of the leadHandleType property.
default void	setMultiHandleType(@Nullable HandleType newValue)	Sets the value of the multiHandleType property.
default void	setTolerance(double newValue)	Sets the value of the tolerance property.
default void	setUndoManager(@NonNull FXUndoManager newValue)	Sets the value of the undoManager property.
javafx.beans.property.DoubleProperty	toleranceProperty()	Holds the tolerance for finding figures.
@NonNull NonNullObjectProperty<FXUndoManager>	undoManagerProperty()	The undo manager is responsible for providing undo/redo functionality.

Property Details

drawingViews

@NonNull javafx.beans.property.ReadOnlySetProperty<DrawingView> drawingViewsProperty

The drawing views associated with this editor.

See Also:

• getDrawingViews()
• drawingViewsProperty()

activeDrawingView

@NonNull javafx.beans.property.ObjectProperty<DrawingView> activeDrawingViewProperty

The currently active drawing view.

See Also:

• getActiveDrawingView()
• setActiveDrawingView(DrawingView)
• activeDrawingViewProperty()

activeTool

@NonNull javafx.beans.property.ObjectProperty<Tool> activeToolProperty

The currently active tool.

See Also:

• getActiveTool()
• setActiveTool(Tool)
• activeToolProperty()

defaultTool

@NonNull javafx.beans.property.ObjectProperty<Tool> defaultToolProperty

The default tool. When the value is not null, the default tool is made the active tool whenever another tool fires ToolEvent.TOOL_DONE.

See Also:

• getDefaultTool()
• setDefaultTool(Tool)
• defaultToolProperty()

helpText

@NonNull javafx.beans.property.ObjectProperty<String> helpTextProperty

Holds the curent help text associated with this drawing view.

See Also:

• getHelpText()
• setHelpText(String)
• helpTextProperty()

handleSize

javafx.beans.property.DoubleProperty handleSizeProperty

Holds the size (width and height) of a handle.

See Also:

• getHandleSize()
• setHandleSize(double)
• handleSizeProperty()

tolerance

javafx.beans.property.DoubleProperty toleranceProperty

Holds the tolerance for finding figures.

See Also:

• getTolerance()
• setTolerance(double)
• toleranceProperty()

handleStrokeWidth

javafx.beans.property.DoubleProperty handleStrokeWidthProperty

Holds the stroke width of a handle.

See Also:

• getHandleStrokeWidth()
• setHandleStrokeWidth(double)
• handleStrokeWidthProperty()

handleColor

NonNullObjectProperty<CssColor> handleColorProperty

Holds the color of the handles.

See Also:

• getHandleColor()
• setHandleColor(CssColor)
• handleColorProperty()

anchorHandleType

@NonNull javafx.beans.property.ObjectProperty<HandleType> anchorHandleTypeProperty

The handle type used for marking the anchor of a selection.

See Also:

• getAnchorHandleType()
• setAnchorHandleType(HandleType)
• anchorHandleTypeProperty()

leadHandleType

@NonNull javafx.beans.property.ObjectProperty<HandleType> leadHandleTypeProperty

The handle type used for marking the lead of a selection.

See Also:

• getLeadHandleType()
• setLeadHandleType(HandleType)
• leadHandleTypeProperty()

handleType

@NonNull NonNullObjectProperty<HandleType> handleTypeProperty

The handle type for single selection.

See Also:

• getHandleType()
• setHandleType(HandleType)
• handleTypeProperty()

multiHandleType

@NonNull NonNullObjectProperty<HandleType> multiHandleTypeProperty

The handle type for multiple selection.

See Also:

• getMultiHandleType()
• setMultiHandleType(HandleType)
• multiHandleTypeProperty()

undoManager

@NonNull NonNullObjectProperty<FXUndoManager> undoManagerProperty

The undo manager is responsible for providing undo/redo functionality.

See Also:

• getUndoManager()
• setUndoManager(FXUndoManager)
• undoManagerProperty()

Field Details

HELP_TEXT_PROPERTY

static final String HELP_TEXT_PROPERTY

The name of the helpText property.

See Also:

• Constant Field Values

HANDLE_TYPE_PROPERTY

static final String HANDLE_TYPE_PROPERTY

The name of the handle type property for single selection.

See Also:

• Constant Field Values

MULTI_HANDLE_TYPE_PROPERTY

static final String MULTI_HANDLE_TYPE_PROPERTY

The name of the handle type property for multiple selection.

See Also:

• Constant Field Values

HANDLE_SIZE_PROPERTY

static final String HANDLE_SIZE_PROPERTY

See Also:

• Constant Field Values

TOLERANCE_PROPERTY

static final String TOLERANCE_PROPERTY

See Also:

• Constant Field Values

HANDLE_STROKE_WDITH_PROPERTY

static final String HANDLE_STROKE_WDITH_PROPERTY

See Also:

• Constant Field Values

HANDLE_COLOR_PROPERTY

static final String HANDLE_COLOR_PROPERTY

See Also:

• Constant Field Values

DRAWING_VIEWS_PROPERTY

static final String DRAWING_VIEWS_PROPERTY

The name of the drawingViews property.

See Also:

• Constant Field Values

ACTIVE_DRAWING_VIEW_PROPERTY

static final String ACTIVE_DRAWING_VIEW_PROPERTY

The name of the activeDrawingView property.

See Also:

• Constant Field Values

ACTIVE_TOOL_PROPERTY

static final String ACTIVE_TOOL_PROPERTY

The name of the activeTool property.

See Also:

• Constant Field Values

DEFAULT_TOOL_PROPERTY

static final String DEFAULT_TOOL_PROPERTY

The name of the defaultTool property.

See Also:

• Constant Field Values

UNDO_MANAGER_PROPERTY

static final String UNDO_MANAGER_PROPERTY

The name of the undoManager property.

See Also:

• Constant Field Values

Method Details

drawingViewsProperty

@NonNull javafx.beans.property.ReadOnlySetProperty<DrawingView> drawingViewsProperty()

The drawing views associated with this editor.

Returns:

the property

See Also:

• getDrawingViews()

activeDrawingViewProperty

@NonNull javafx.beans.property.ObjectProperty<DrawingView> activeDrawingViewProperty()

The currently active drawing view.

Returns:

the property

See Also:

• getActiveDrawingView()
• setActiveDrawingView(DrawingView)

activeToolProperty

@NonNull javafx.beans.property.ObjectProperty<Tool> activeToolProperty()

The currently active tool.

Returns:

the property

See Also:

• getActiveTool()
• setActiveTool(Tool)

defaultToolProperty

@NonNull javafx.beans.property.ObjectProperty<Tool> defaultToolProperty()

The default tool. When the value is not null, the default tool is made the active tool whenever another tool fires ToolEvent.TOOL_DONE.

Returns:

the property

See Also:

• getDefaultTool()
• setDefaultTool(Tool)

addDrawingView

default void addDrawingView(DrawingView drawingView)

Adds a drawing view to this editor.

Parameters:

drawingView - the drawing view

removeDrawingView

default void removeDrawingView(DrawingView drawingView)

Removes a drawing view to this editor.

Parameters:

drawingView - the drawing view

getActiveDrawingView

default @Nullable DrawingView getActiveDrawingView()

Gets the active drawing view.

Returns:

the active drawing view or empty

getDrawingViews

default javafx.collections.ObservableSet<DrawingView> getDrawingViews()

Gets the drawing views.

Returns:

the active drawing view or empty

setActiveDrawingView

default void setActiveDrawingView(@Nullable DrawingView drawingView)

Sets the active drawing view.

Parameters:

drawingView - the drawing view or null if none is active

getActiveTool

default @Nullable Tool getActiveTool()

Gets the active tool.

Returns:

the active tool or null

setActiveTool

default void setActiveTool(@Nullable Tool tool)

Sets the active tool.

Parameters:

tool - the active tool or null if none is active

getDefaultTool

default @Nullable Tool getDefaultTool()

Gets the default tool.

Returns:

the default tool or null

setDefaultTool

default void setDefaultTool(@Nullable Tool tool)

Sets the default tool.

Parameters:

tool - the default tool or null if no default tool is desired

helpTextProperty

@NonNull javafx.beans.property.ObjectProperty<String> helpTextProperty()

Holds the curent help text associated with this drawing view.

Returns:

the help text property.

See Also:

• getHelpText()
• setHelpText(String)

getHelpText

default String getHelpText()

Gets the value of the helpText property.

Property description:

Holds the curent help text associated with this drawing view.

Returns:

the value of the helpText property

See Also:

• setHelpText(String)
• helpTextProperty()

setHelpText

default void setHelpText(String newValue)

Sets the value of the helpText property.

Property description:

Holds the curent help text associated with this drawing view.

Parameters:

newValue - the value for the helpText property

See Also:

• getHelpText()
• helpTextProperty()

handleSizeProperty

javafx.beans.property.DoubleProperty handleSizeProperty()

Holds the size (width and height) of a handle.

Returns:

size of handle

See Also:

• getHandleSize()
• setHandleSize(double)

toleranceProperty

javafx.beans.property.DoubleProperty toleranceProperty()

Holds the tolerance for finding figures.

Returns:

the tolerance property

See Also:

• getTolerance()
• setTolerance(double)

handleStrokeWidthProperty

javafx.beans.property.DoubleProperty handleStrokeWidthProperty()

Holds the stroke width of a handle.

Returns:

size of handle

See Also:

• getHandleStrokeWidth()
• setHandleStrokeWidth(double)

getHandleSize

default double getHandleSize()

Gets the value of the handleSize property.

Property description:

Holds the size (width and height) of a handle.

Returns:

the value of the handleSize property

See Also:

• setHandleSize(double)
• handleSizeProperty()

setHandleSize

default void setHandleSize(double newValue)

Sets the value of the handleSize property.

Property description:

Holds the size (width and height) of a handle.

Parameters:

newValue - the value for the handleSize property

See Also:

• getHandleSize()
• handleSizeProperty()

setTolerance

default void setTolerance(double newValue)

Sets the value of the tolerance property.

Property description:

Holds the tolerance for finding figures.

Parameters:

newValue - the value for the tolerance property

See Also:

• getTolerance()
• toleranceProperty()

handleColorProperty

NonNullObjectProperty<CssColor> handleColorProperty()

Holds the color of the handles.

Returns:

color of handle

See Also:

• getHandleColor()
• setHandleColor(CssColor)

getHandleColor

default CssColor getHandleColor()

Gets the value of the handleColor property.

Property description:

Holds the color of the handles.

Returns:

the value of the handleColor property

See Also:

• setHandleColor(CssColor)
• handleColorProperty()

setHandleColor

default void setHandleColor(CssColor newValue)

Sets the value of the handleColor property.

Property description:

Holds the color of the handles.

Parameters:

newValue - the value for the handleColor property

See Also:

• getHandleColor()
• handleColorProperty()

getHandleStrokeWidth

default double getHandleStrokeWidth()

Gets the value of the handleStrokeWidth property.

Property description:

Holds the stroke width of a handle.

Returns:

the value of the handleStrokeWidth property

See Also:

• setHandleStrokeWidth(double)
• handleStrokeWidthProperty()

setHandleStrokeWidth

default void setHandleStrokeWidth(double newValue)

Sets the value of the handleStrokeWidth property.

Property description:

Holds the stroke width of a handle.

Parameters:

newValue - the value for the handleStrokeWidth property

See Also:

• getHandleStrokeWidth()
• handleStrokeWidthProperty()

recreateHandles

default void recreateHandles()

setHandleType

default void setHandleType(@Nullable HandleType newValue)

Sets the value of the handleType property.

Property description:

The handle type for single selection.

Parameters:

newValue - the value for the handleType property

See Also:

• getHandleType()
• handleTypeProperty()

getHandleType

default @Nullable HandleType getHandleType()

Gets the value of the handleType property.

Property description:

The handle type for single selection.

Returns:

the value of the handleType property

See Also:

• setHandleType(HandleType)
• handleTypeProperty()

anchorHandleTypeProperty

@NonNull javafx.beans.property.ObjectProperty<HandleType> anchorHandleTypeProperty()

The handle type used for marking the anchor of a selection.

Returns:

the handle key

See Also:

• getAnchorHandleType()
• setAnchorHandleType(HandleType)

leadHandleTypeProperty

@NonNull javafx.beans.property.ObjectProperty<HandleType> leadHandleTypeProperty()

The handle type used for marking the lead of a selection.

Returns:

the handle key

See Also:

• getLeadHandleType()
• setLeadHandleType(HandleType)

setAnchorHandleType

default void setAnchorHandleType(@Nullable HandleType newValue)

Sets the value of the anchorHandleType property.

Property description:

The handle type used for marking the anchor of a selection.

Parameters:

newValue - the value for the anchorHandleType property

See Also:

• getAnchorHandleType()
• anchorHandleTypeProperty()

getAnchorHandleType

default @Nullable HandleType getAnchorHandleType()

Gets the value of the anchorHandleType property.

Property description:

The handle type used for marking the anchor of a selection.

Returns:

the value of the anchorHandleType property

See Also:

• setAnchorHandleType(HandleType)
• anchorHandleTypeProperty()

setLeadHandleType

default void setLeadHandleType(@Nullable HandleType newValue)

Sets the value of the leadHandleType property.

Property description:

The handle type used for marking the lead of a selection.

Parameters:

newValue - the value for the leadHandleType property

See Also:

• getLeadHandleType()
• leadHandleTypeProperty()

getLeadHandleType

default @Nullable HandleType getLeadHandleType()

Gets the value of the leadHandleType property.

Property description:

The handle type used for marking the lead of a selection.

Returns:

the value of the leadHandleType property

See Also:

• setLeadHandleType(HandleType)
• leadHandleTypeProperty()

handleTypeProperty

@NonNull NonNullObjectProperty<HandleType> handleTypeProperty()

The handle type for single selection.

Returns:

the handle key

See Also:

• getHandleType()
• setHandleType(HandleType)

getTolerance

default double getTolerance()

Tolerance (radius) in view coordinates.

Returns:

the tolerance radius

multiHandleTypeProperty

@NonNull NonNullObjectProperty<HandleType> multiHandleTypeProperty()

The handle type for multiple selection.

Returns:

the handle key

See Also:

• getMultiHandleType()
• setMultiHandleType(HandleType)

setMultiHandleType

default void setMultiHandleType(@Nullable HandleType newValue)

Sets the value of the multiHandleType property.

Property description:

The handle type for multiple selection.

Parameters:

newValue - the value for the multiHandleType property

See Also:

• getMultiHandleType()
• multiHandleTypeProperty()

getMultiHandleType

default @Nullable HandleType getMultiHandleType()

Gets the value of the multiHandleType property.

Property description:

The handle type for multiple selection.

Returns:

the value of the multiHandleType property

See Also:

• setMultiHandleType(HandleType)
• multiHandleTypeProperty()

undoManagerProperty

@NonNull NonNullObjectProperty<FXUndoManager> undoManagerProperty()

The undo manager is responsible for providing undo/redo functionality.

Returns:

the undo manager

See Also:

• getUndoManager()
• setUndoManager(FXUndoManager)

setUndoManager

default void setUndoManager(@NonNull FXUndoManager newValue)

Sets the value of the undoManager property.

Property description:

The undo manager is responsible for providing undo/redo functionality.

Parameters:

newValue - the value for the undoManager property

See Also:

• getUndoManager()
• undoManagerProperty()

getUndoManager

default @NonNull FXUndoManager getUndoManager()

Gets the value of the undoManager property.

Property description:

The undo manager is responsible for providing undo/redo functionality.

Returns:

the value of the undoManager property

See Also:

• setUndoManager(FXUndoManager)
• undoManagerProperty()