Package userDisplayFX

Interface UserDisplayNodeFX

All Known Implementing Classes:
DataMapPaneFX, DetectionGroupDisplayFX, SwingDisplayNodeFX, TDControlFX
public interface UserDisplayNodeFX
Any display which sits inside PAMGuard must be an instance of UserDisplayNodeFX.
Author:
Jamie Macaulay

  • Method Details

    • getUserDisplayControl

      UserDisplayControlFX getUserDisplayControl()
      Get a display controller associated with the display. Note that a display does not need a controller so this can return null.
      Returns:
      the associated control for the display.

    • getName

      String getName()
      The name of display. Used for default tabs etc.
      Returns:
      the name of the display

    • getNode

      javafx.scene.layout.Region getNode()
      Get the node to add to the display.
      Returns:
      The FX node to add to the display

    • openNode

      void openNode()
      Called when the component is first displayed.

    • isStaticDisplay

      boolean isStaticDisplay()
      Check whether a pane is static. If the pane is static then it cannot be removed from PAMGuard, it cannot be resized and no other user display can be added to the tab. This is rarely used.
      Returns:
      true if the pane cannot be removed from the view.

    • isResizeableDisplay

      boolean isResizeableDisplay()
      Check whether a display can be resized within PAMGuard.
      Returns:
      true of the pane can be resized.

    • isMinorDisplay

      boolean isMinorDisplay()
      Only used for automatic resizing. Minor displays are automatically made smaller
      Returns:
      true if a minor display.

    • requestNodeSettingsPane

      boolean requestNodeSettingsPane()
      Called when node settings pane is requested from another program. Note that the design of displays is such that settings are shown in the display itself, usually with a sliding pane or something similar revealed. Hence, this function should not be used to grab a pane to put in a dialog.
      Returns:
      true if the pane can show settings.

    • closeNode

      void closeNode()
      Called when the node is removed from the display.

    • notifyModelChanged

      void notifyModelChanged(int changeType)
      Pick up model changed notifications from a parent user display.
      Parameters:
      changeType -

    • getDisplayParams

      UserDisplayNodeParams getDisplayParams()
      Get the display provider params.
      Returns:
      display params.

    • setFrameHolder

      void setFrameHolder(PamInternalPane internalFrame)
      Called whenever the display is added to a frame.
      Parameters:
      internalFrame - - the internal frame.