Package dk.gtz.graphedit.tool

Interface ITool

All Known Implementing Classes:
AbstractBaseTool, ClipboardTool, EdgeCreateTool, EdgeDeleteTool, LintInspectorTool, MassDeleteTool, SelectTool, UnifiedModellingTool, VertexCreateTool, VertexDeleteTool, VertexDragMoveTool, ViewTool
public interface ITool
Interface for implementing graph editing tools. Tools are automatically instantiated and can be selected in the model editor toolbar

  • Method Details

    • getTooltip

      Optional<String> getTooltip()
      Get a multiline tooltip string that briefly describes this tool
      Returns:
      a (possibly) multiline string

    • getGraphic

      javafx.scene.Node getGraphic()
      Get the graphical representation for the tool selection button. Typically just a FontIcon, but can be anything
      Returns:
      a javafx node that will be displayed inside the tool selector button

    • getHelpDescription

      String getHelpDescription()
      Get a multiline string that describe the tool and how to use it
      Returns:
      a (possibly) multiline string

    • onViewportMouseEvent

      void onViewportMouseEvent(ViewportMouseEvent e)
      Event handler for the case where the model editor viewport has been interacted with with the mouse
      Parameters:
      e - The event that happened

    • onKeyEvent

      void onKeyEvent(ViewportKeyEvent e)
      Event handler for the case where the model editor viewport has been interacted with with the keyboard
      Parameters:
      e - The event that happened

    • onVertexMouseEvent

      void onVertexMouseEvent(VertexMouseEvent e)
      Event handler for the case where a vertex has been interacted with with the mouse
      Parameters:
      e - The event that happened

    • onEdgeMouseEvent

      void onEdgeMouseEvent(EdgeMouseEvent e)
      Event handler for the case where an edge has been interacted with with the mouse
      Parameters:
      e - The event that happened