Module org.jhotdraw8.draw

Package org.jhotdraw8.draw.tool

Class SelectionTool

java.lang.Object

org.jhotdraw8.application.AbstractDisableable

org.jhotdraw8.draw.tool.AbstractTool

org.jhotdraw8.draw.tool.SelectionTool

All Implemented Interfaces:

Tool, PropertyBean, Disableable

public class SelectionTool
extends AbstractTool

A tool to select and manipulate figures.

A selection tool is in one of three states:

1. area selection
2. figure dragging
3. handle manipulation

The different states are handled by different tracker objects: the SimpleSelectAreaTracker, the SimpleDragTracker and the SimpleHandleTracker.

A Figure can be selected by clicking at it. Holding the alt key or the ctrl key down, selects the Figure behind it.

Holding down the shift key on mouse pressed, enforces the area selection function.

Author:

Werner Randelshofer

Property Summary

Properties

Type	Property	Description
@NonNull javafx.beans.property.BooleanProperty	selectBehindEnabled

Properties inherited from class org.jhotdraw8.draw.tool.AbstractTool

drawingEditor, drawingView, focused

Properties inherited from class org.jhotdraw8.application.AbstractDisableable

disabled

Properties inherited from interface org.jhotdraw8.fxbase.control.Disableable

disabled

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID
static final String	SELECT_BEHIND_ENABLED

Fields inherited from class org.jhotdraw8.draw.tool.AbstractTool

drawPane, eventPane, node, undoHelper

Fields inherited from class org.jhotdraw8.application.AbstractDisableable

disabled, disablers

Fields inherited from interface org.jhotdraw8.fxbase.control.Disableable

DISABLED_PROPERTY

Fields inherited from interface org.jhotdraw8.draw.tool.Tool

ACCELERATOR_KEY, DRAWING_EDITOR_PROPERTY, DRAWING_VIEW_PROPERTY, LABEL, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON, STYLE_CLASS_KEY

Constructor Summary

Constructors

Constructor	Description
SelectionTool()
SelectionTool(String name, Resources rsrc)
SelectionTool(String name, HandleType handleType, Resources rsrc)
SelectionTool(String name, HandleType handleType, HandleType anchorHandleType, HandleType leadHandleType, Resources rsrc)

Method Summary

Modifier and Type	Method	Description
void	activate(@NonNull DrawingEditor editor)	This implementation sets the help text on the drawing view.
protected DragTracker	getDragTracker(Figure f, DrawingView dv)	Method to get a DragTracker which handles user interaction for dragging the specified figure.
protected HandleTracker	getHandleTracker(Handle handle)	Method to get a HandleTracker which handles user interaction for the specified handle.
@NonNull String	getHelpText()	Returns a localized help text for this tool.
protected SelectAreaTracker	getSelectAreaTracker()	Method to get a SelectAreaTracker which handles user interaction for selecting an area on the drawing.
boolean	isSelectBehindEnabled()	Gets the value of the selectBehindEnabled property.
protected void	onKeyPressed(@NonNull javafx.scene.input.KeyEvent event, @NonNull DrawingView view)
protected void	onKeyReleased(@NonNull javafx.scene.input.KeyEvent event, @NonNull DrawingView view)
protected void	onKeyTyped(@NonNull javafx.scene.input.KeyEvent event, @NonNull DrawingView view)
protected void	onMouseClicked(@NonNull javafx.scene.input.MouseEvent event, @NonNull DrawingView dv)
protected void	onMouseDragged(@NonNull javafx.scene.input.MouseEvent event, @NonNull DrawingView dv)
protected void	onMouseMoved(@NonNull javafx.scene.input.MouseEvent event, @NonNull DrawingView view)
protected void	onMousePressed(@NonNull javafx.scene.input.MouseEvent event, @NonNull DrawingView view)
protected void	onMouseReleased(@NonNull javafx.scene.input.MouseEvent event, @NonNull DrawingView dv)
protected void	onZoom(@NonNull javafx.scene.input.ZoomEvent event, @NonNull DrawingView dv)
protected void	onZoomStarted(@NonNull javafx.scene.input.ZoomEvent event, @NonNull DrawingView dv)
@NonNull javafx.beans.property.BooleanProperty	selectBehindEnabledProperty()
void	setDragTracker(DragTracker newValue)	Method to set a DragTracker.
void	setHandleTracker(HandleTracker newValue)	Method to set a HandleTracker.
void	setSelectAreaTracker(SelectAreaTracker newValue)	Method to set a SelectAreaTracker.
protected void	stopEditing()

Methods inherited from class org.jhotdraw8.draw.tool.AbstractTool

addToolListener, applyResources, deactivate, drawingEditorProperty, drawingViewProperty, editCopy, editCut, editDelete, editDuplicate, editPaste, fire, fireToolDone, fireToolStarted, focusedProperty, forwardUndoableEdit, getNode, getProperties, onMouseEntered, onMouseExited, onZoomFinished, removeToolListener, requestFocus

Methods inherited from class org.jhotdraw8.application.AbstractDisableable

disabledProperty, disablers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jhotdraw8.fxbase.control.Disableable

addDisabler, disabledProperty, disablers, isDisabled, removeDisabler

Methods inherited from interface org.jhotdraw8.fxbase.beans.PropertyBean

get, getNonNull, getProperty, put, remove, set, setNonNull, valueAt

Methods inherited from interface org.jhotdraw8.draw.tool.Tool

getDrawingEditor, getDrawingView, getLabel, getName, setDrawingEditor, setDrawingView

Property Details

selectBehindEnabled

public @NonNull javafx.beans.property.BooleanProperty selectBehindEnabledProperty

See Also:

• isSelectBehindEnabled()
• selectBehindEnabledProperty()

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

SELECT_BEHIND_ENABLED

public static final String SELECT_BEHIND_ENABLED

See Also:

• Constant Field Values

Constructor Details

SelectionTool

public SelectionTool()

SelectionTool

public SelectionTool(String name,
 Resources rsrc)

SelectionTool

public SelectionTool(String name,
 HandleType handleType,
 Resources rsrc)

SelectionTool

public SelectionTool(String name,
 HandleType handleType,
 HandleType anchorHandleType,
 HandleType leadHandleType,
 Resources rsrc)

Method Details

selectBehindEnabledProperty

public @NonNull javafx.beans.property.BooleanProperty selectBehindEnabledProperty()

Returns:

the selectBehindEnabled property

See Also:

• isSelectBehindEnabled()

stopEditing

protected void stopEditing()

Overrides:

stopEditing in class AbstractTool

onMousePressed

protected void onMousePressed(@NonNull javafx.scene.input.MouseEvent event,
 @NonNull DrawingView view)

Overrides:

onMousePressed in class AbstractTool

onMouseDragged

protected void onMouseDragged(@NonNull javafx.scene.input.MouseEvent event,
 @NonNull DrawingView dv)

Overrides:

onMouseDragged in class AbstractTool

onMouseReleased

protected void onMouseReleased(@NonNull javafx.scene.input.MouseEvent event,
 @NonNull DrawingView dv)

Overrides:

onMouseReleased in class AbstractTool

onMouseClicked

protected void onMouseClicked(@NonNull javafx.scene.input.MouseEvent event,
 @NonNull DrawingView dv)

Overrides:

onMouseClicked in class AbstractTool

onMouseMoved

protected void onMouseMoved(@NonNull javafx.scene.input.MouseEvent event,
 @NonNull DrawingView view)

Overrides:

onMouseMoved in class AbstractTool

onKeyPressed

protected void onKeyPressed(@NonNull javafx.scene.input.KeyEvent event,
 @NonNull DrawingView view)

Overrides:

onKeyPressed in class AbstractTool

onKeyReleased

protected void onKeyReleased(@NonNull javafx.scene.input.KeyEvent event,
 @NonNull DrawingView view)

Overrides:

onKeyReleased in class AbstractTool

onKeyTyped

protected void onKeyTyped(@NonNull javafx.scene.input.KeyEvent event,
 @NonNull DrawingView view)

Overrides:

onKeyTyped in class AbstractTool

getHandleTracker

protected HandleTracker getHandleTracker(Handle handle)

Method to get a HandleTracker which handles user interaction for the specified handle.

Parameters:

handle - a handle

Returns:

a handle tracker

getDragTracker

protected DragTracker getDragTracker(Figure f,
 DrawingView dv)

Method to get a DragTracker which handles user interaction for dragging the specified figure.

Parameters:

f - a figure

dv - a drawing view

Returns:

a tracker

getSelectAreaTracker

protected SelectAreaTracker getSelectAreaTracker()

Method to get a SelectAreaTracker which handles user interaction for selecting an area on the drawing.

Returns:

a tracker

setHandleTracker

public void setHandleTracker(HandleTracker newValue)

Method to set a HandleTracker. If you specify null, the SelectionTool uses the DefaultHandleTracker.

Parameters:

newValue - a tracker

setSelectAreaTracker

public void setSelectAreaTracker(SelectAreaTracker newValue)

Method to set a SelectAreaTracker. If you specify null, the SelectionTool uses the DefaultSelectAreaTracker.

Parameters:

newValue - a tracker

setDragTracker

public void setDragTracker(DragTracker newValue)

Method to set a DragTracker. If you specify null, the SelectionTool uses the DefaultDragTracker.

Parameters:

newValue - a tracker

activate

public void activate(@NonNull DrawingEditor editor)

Description copied from class: AbstractTool

This implementation sets the help text on the drawing view.

Specified by:

activate in interface Tool

Overrides:

activate in class AbstractTool

Parameters:

editor - the editor

isSelectBehindEnabled

public boolean isSelectBehindEnabled()

Gets the value of the selectBehindEnabled property.

Property description:

Returns:

the value of the selectBehindEnabled property

See Also:

• selectBehindEnabledProperty()

onZoom

protected void onZoom(@NonNull javafx.scene.input.ZoomEvent event,
 @NonNull DrawingView dv)

Overrides:

onZoom in class AbstractTool

onZoomStarted

protected void onZoomStarted(@NonNull javafx.scene.input.ZoomEvent event,
 @NonNull DrawingView dv)

Overrides:

onZoomStarted in class AbstractTool

getHelpText

public @NonNull String getHelpText()

Description copied from interface: Tool

Returns a localized help text for this tool.

Returns:

the help text