Interface OverlayMenuItem

All Known Implementing Classes:
ClickReclassifyMenuItem, CopyDetectionPlot, CopyTDDataPlot, CSVExportOverlayMenu, ExportOverlayMenu, MLExportOverlayMenu, RExportOverlayMenu, StandardOverlayMenuItem, WavExportOverlayMenu

public interface OverlayMenuItem
Interface for menu items which are TD Display specific.
Author:
Jamie Macaulay
  • Field Summary Link icon

    Fields
    Modifier and Type
    Field
    Description
    static final int
     
    static final int
    Flag for menu items which are form Data Infos
    static final int
     
    static final int
     
  • Method Summary Link icon

    Modifier and Type
    Method
    Description
    boolean
    canBeUsed(DetectionGroupSummary foundDataUnits, int index, OverlayMark overlayMark)
    Check whether the menu item can be used within a group of data units.
    int
    Flags for general grouping menu items
    javafx.scene.control.Tooltip
     
    int
    Indicates whether menu items should be grouped together in a sub menu.
    javafx.scene.control.Control
    menuAction(DetectionGroupSummary foundDataUnits, int index, OverlayMark overlayMark)
    Returns a control which performs an action when pressed (or action occurs)
  • Field Details Link icon

  • Method Details Link icon

    • getNodeToolTip Link icon

      javafx.scene.control.Tooltip getNodeToolTip()
    • canBeUsed Link icon

      boolean canBeUsed(DetectionGroupSummary foundDataUnits, int index, OverlayMark overlayMark)
      Check whether the menu item can be used within a group of data units.
      Parameters:
      foundDataUnits - - class which holds a list of data units and metadata info.
      index - :. If the index is invalid input: '<'0 then returns whether the menu item can be used for at least one of the units in the list.
      overlayMark - - holds info on the current mark drawn on the display.
    • getFlag Link icon

      int getFlag()
      Flags for general grouping menu items
      Returns:
      integer flag which groups items
    • getSubMenuGroup Link icon

      int getSubMenuGroup()
      Indicates whether menu items should be grouped together in a sub menu. Make the same group and same flag if so.
      Returns:
      the group number. -1 for no grouping.