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 Details

  • Method Details

    • registerTool

      void registerTool(QuPathViewer viewer)
      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

      void deregisterTool(QuPathViewer viewer)
      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

      default String getName()
      Get the name of the tool
      Returns:

    • nameProperty

      ReadOnlyStringProperty nameProperty()
      Property giving the name of the tool
      Returns:
      See Also:

    • iconProperty

      ReadOnlyObjectProperty<Node> iconProperty()
      Property giving the icon that should be used for the tool
      Returns:
      See Also:

    • getIcon

      default Node getIcon()
      Get the icon of the tool.
      Returns: