Package qupath.lib.gui

Class ToolManager

java.lang.Object

qupath.lib.gui.ToolManager

public class ToolManager
extends Object

Manage (drawing) tool selection in a QuPath UI.

Since:

v0.5.0

Property Summary

Properties

Type	Property	Description
BooleanProperty	lockSelectedTool	Property to request that the selected tool be locked.
ReadOnlyObjectProperty<PathTool>	previousSelectedTool	Property storing the previous tool that was selected.
ReadOnlyObjectProperty<PathTool>	selectedTool	Property containing the currently-selected PathTool.

Field Summary

Fields

Modifier and Type	Field	Description
final org.controlsfx.control.action.Action	BRUSH_TOOL
final org.controlsfx.control.action.Action	ELLIPSE_TOOL
final org.controlsfx.control.action.Action	LINE_TOOL
final org.controlsfx.control.action.Action	MOVE_TOOL
final org.controlsfx.control.action.Action	POINTS_TOOL
final org.controlsfx.control.action.Action	POLYGON_TOOL
final org.controlsfx.control.action.Action	POLYLINE_TOOL
final org.controlsfx.control.action.Action	RECTANGLE_TOOL
final org.controlsfx.control.action.Action	SELECTION_MODE

Method Summary

Modifier and Type	Method	Description
static ToolManager	create()	Create a new instance
PathTool	getPreviousSelectedTool()	Get the value of selectedToolProperty().
PathTool	getSelectedTool()	Get the value of selectedToolProperty().
org.controlsfx.control.action.Action	getSelectionModeAction()	Return the action associated with 'selection mode'.
org.controlsfx.control.action.Action	getToolAction(PathTool tool)	Get the action that corresponds to a specific PathTool, creating a new action if one does not already exist.
ObservableList<PathTool>	getTools()	Get a read-only list of all available tools.
boolean	installTool(PathTool tool, KeyCodeCombination accelerator)	Install a new tool for interacting with viewers.
boolean	isToolSwitchingEnabled()	Returns true if the user is able to activate another PathTool, false otherwise.
BooleanProperty	lockSelectedToolProperty()	Property to request that the selected tool be locked.
ReadOnlyObjectProperty<PathTool>	previousSelectedToolProperty()	Property storing the previous tool that was selected.
ReadOnlyObjectProperty<PathTool>	selectedToolProperty()	Property containing the currently-selected PathTool.
void	setSelectedTool(PathTool tool)	Programmatically select the active PathTool.
void	setToolSwitchingEnabled(boolean enabled)	Toggle whether the user is permitted to switch to a new active PathTool.

Methods inherited from class java.lang.Object

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

Property Details

selectedTool

public ReadOnlyObjectProperty<PathTool> selectedToolProperty

Property containing the currently-selected PathTool. If this needs to be changed, use setSelectedTool(PathTool) to ensure that isToolSwitchingEnabled() has an effect.

See Also:

• getSelectedTool()
• setSelectedTool(PathTool)
• selectedToolProperty()

lockSelectedTool

public BooleanProperty lockSelectedToolProperty

Property to request that the selected tool be locked. Calls to setSelectedTool(PathTool) are discarded until the tool is unlocked.

See Also:

• lockSelectedToolProperty()

previousSelectedTool

public ReadOnlyObjectProperty<PathTool> previousSelectedToolProperty

Property storing the previous tool that was selected. This is useful for commands that might want to quickly toggle between tools.

See Also:

• getPreviousSelectedTool()
• previousSelectedToolProperty()

Field Details

MOVE_TOOL

@ActionAccelerator("m")
@ActionConfig("Tools.move")
public final org.controlsfx.control.action.Action MOVE_TOOL

RECTANGLE_TOOL

@ActionAccelerator("r")
@ActionConfig("Tools.rectangle")
public final org.controlsfx.control.action.Action RECTANGLE_TOOL

ELLIPSE_TOOL

@ActionAccelerator("o")
@ActionConfig("Tools.ellipse")
public final org.controlsfx.control.action.Action ELLIPSE_TOOL

POLYGON_TOOL

@ActionAccelerator("p")
@ActionConfig("Tools.polygon")
public final org.controlsfx.control.action.Action POLYGON_TOOL

POLYLINE_TOOL

@ActionAccelerator("v")
@ActionConfig("Tools.polyline")
public final org.controlsfx.control.action.Action POLYLINE_TOOL

BRUSH_TOOL

@ActionAccelerator("b")
@ActionConfig("Tools.brush")
public final org.controlsfx.control.action.Action BRUSH_TOOL

LINE_TOOL

@ActionAccelerator("l")
@ActionConfig(value="Tools.line",
              bindLocale=false)
public final org.controlsfx.control.action.Action LINE_TOOL

POINTS_TOOL

@ActionAccelerator(".")
@ActionConfig("Tools.points")
public final org.controlsfx.control.action.Action POINTS_TOOL

SELECTION_MODE

@ActionAccelerator("shift+s")
@ActionIcon(SELECTION_MODE)
@ActionConfig("Tools.selectionMode")
public final org.controlsfx.control.action.Action SELECTION_MODE

Method Details

create

public static ToolManager create()

Create a new instance

Returns:

getTools

public ObservableList<PathTool> getTools()

Get a read-only list of all available tools. If you wish to add a new one, use installTool(PathTool, KeyCodeCombination).

Returns:

selectedToolProperty

public ReadOnlyObjectProperty<PathTool> selectedToolProperty()

Property containing the currently-selected PathTool. If this needs to be changed, use setSelectedTool(PathTool) to ensure that isToolSwitchingEnabled() has an effect.

Returns:

See Also:

• getSelectedTool()
• setSelectedTool(PathTool)

lockSelectedToolProperty

public BooleanProperty lockSelectedToolProperty()

Property to request that the selected tool be locked. Calls to setSelectedTool(PathTool) are discarded until the tool is unlocked.

Returns:

installTool

public boolean installTool(PathTool tool,
 KeyCodeCombination accelerator)

Install a new tool for interacting with viewers.

Parameters:

tool - the tool to add

accelerator - an optional accelerator (may be null)

Returns:

true if the tool was added, false otherwise (e.g. if the tool had already been added)

setSelectedTool

public void setSelectedTool(PathTool tool)

Programmatically select the active PathTool. This may fail if isToolSwitchingEnabled() returns false.

Parameters:

tool -

getSelectedTool

public PathTool getSelectedTool()

Get the value of selectedToolProperty().

Returns:

getPreviousSelectedTool

public PathTool getPreviousSelectedTool()

Get the value of selectedToolProperty().

Returns:

previousSelectedToolProperty

public ReadOnlyObjectProperty<PathTool> previousSelectedToolProperty()

Property storing the previous tool that was selected. This is useful for commands that might want to quickly toggle between tools.

Returns:

See Also:

• getPreviousSelectedTool()

setToolSwitchingEnabled

public void setToolSwitchingEnabled(boolean enabled)

Toggle whether the user is permitted to switch to a new active PathTool. This can be used to lock a tool temporarily.

Parameters:

enabled -

isToolSwitchingEnabled

public boolean isToolSwitchingEnabled()

Returns true if the user is able to activate another PathTool, false otherwise.

Returns:

getToolAction

public org.controlsfx.control.action.Action getToolAction(PathTool tool)

Get the action that corresponds to a specific PathTool, creating a new action if one does not already exist.

Parameters:

tool -

Returns:

getSelectionModeAction

public org.controlsfx.control.action.Action getSelectionModeAction()

Return the action associated with 'selection mode'. This can be used to create UI components that toggle selection mode on and off.

Returns:

See Also:

• PathPrefs.selectionModeProperty()