Package qupath.lib.gui.viewer.tools

Class ExtendedPathTool

java.lang.Object

qupath.lib.gui.viewer.tools.ExtendedPathTool

All Implemented Interfaces:

PathTool

public class ExtendedPathTool
extends Object
implements PathTool

Property Summary

Properties

Type	Property	Description
ReadOnlyObjectProperty<Node>	icon	Property giving the icon that should be used for the tool
ReadOnlyStringProperty	name	Property giving the name of the tool

Method Summary

Modifier and Type	Method	Description
void	deregisterTool(QuPathViewer viewer)	Deregister the tool from the viewer.
ObservableList<PathTool>	getAvailableTools()
ReadOnlyObjectProperty<Node>	iconProperty()	Property giving the icon that should be used for the tool
ReadOnlyStringProperty	nameProperty()	Property giving the name of the tool
void	registerTool(QuPathViewer viewer)	Register the tool on the viewer.
ObjectProperty<PathTool>	selectedTool()

Methods inherited from class java.lang.Object

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

Methods inherited from interface qupath.lib.gui.viewer.tools.PathTool

getIcon, getName

Property Details

name

public ReadOnlyStringProperty nameProperty

Specified by:

nameProperty in interface PathTool

Returns:

See Also:

• nameProperty()

icon

public ReadOnlyObjectProperty<Node> iconProperty

Specified by:

iconProperty in interface PathTool

Returns:

See Also:

• iconProperty()

Method Details

getAvailableTools

public ObservableList<PathTool> getAvailableTools()

selectedTool

public ObjectProperty<PathTool> selectedTool()

registerTool

public void registerTool(QuPathViewer viewer)

Description copied from interface: PathTool

Register the tool on the viewer. This typically means adding a mouse listener. A tool should only be registered on one viewer at a time, and only one tool should be registered per viewer.

Specified by:

registerTool in interface PathTool

Parameters:

viewer - the viewer for which this tool should be registered

deregisterTool

public void deregisterTool(QuPathViewer viewer)

Description copied from interface: PathTool

Deregister the tool from the viewer. It is essential that tools clean up properly and do not impact other tools that may be registered for the viewer later.

Specified by:

deregisterTool in interface PathTool

Parameters:

viewer - the viewer from which this tool should be deregistered

nameProperty

public ReadOnlyStringProperty nameProperty()

Description copied from interface: PathTool

Property giving the name of the tool

Specified by:

nameProperty in interface PathTool

Returns:

the name property

iconProperty

public ReadOnlyObjectProperty<Node> iconProperty()

Description copied from interface: PathTool

Property giving the icon that should be used for the tool

Specified by:

iconProperty in interface PathTool

Returns:

the icon property