Package qupath.lib.gui.viewer.tools
Interface PathTool
- All Known Implementing Classes:
ExtendedPathTool
public interface PathTool
Interface defining how a toolbar tool interacts with a viewer.
- Author:
- Pete Bankhead
-
Property Summary
PropertiesTypePropertyDescriptionProperty giving the icon that should be used for the toolProperty giving the name of the tool -
Method Summary
Modifier and TypeMethodDescriptionvoidderegisterTool(QuPathViewer viewer) Deregister the tool from the viewer.default NodegetIcon()Get the icon of the tool.default StringgetName()Get the name of the toolProperty giving the icon that should be used for the toolProperty giving the name of the toolvoidregisterTool(QuPathViewer viewer) Register the tool on the viewer.
-
Property Details
-
name
ReadOnlyStringProperty namePropertyProperty giving the name of the tool- See Also:
-
icon
ReadOnlyObjectProperty<Node> iconPropertyProperty giving the icon that should be used for the tool- See Also:
-
-
Method Details
-
registerTool
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.- Parameters:
viewer- the viewer for which this tool should be registered
-
deregisterTool
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.- Parameters:
viewer- the viewer from which this tool should be deregistered
-
getName
Get the name of the tool- Returns:
-
nameProperty
ReadOnlyStringProperty nameProperty()Property giving the name of the tool- See Also:
-
iconProperty
ReadOnlyObjectProperty<Node> iconProperty()Property giving the icon that should be used for the tool- See Also:
-
getIcon
Get the icon of the tool.- Returns:
-