Package userDisplayFX

Class SwingDisplayNodeFX

java.lang.Object
userDisplayFX.SwingDisplayNodeFX
All Implemented Interfaces:
UserDisplayNodeFX
public class SwingDisplayNodeFX extends Object implements UserDisplayNodeFX
A user display which is based on a swing component.
Author:
Jamie Macaulay

  • Constructor Details

    • SwingDisplayNodeFX

      public SwingDisplayNodeFX(JComponent jComponenet, String name)

  • Method Details

    • getName

      public String getName()
      Description copied from interface: UserDisplayNodeFX
      The name of display. Used for default tabs etc.
      Specified by:
      getName in interface UserDisplayNodeFX
      Returns:
      the name of the display

    • getNode

      public javafx.scene.layout.Region getNode()
      Description copied from interface: UserDisplayNodeFX
      Get the node to add to the display.
      Specified by:
      getNode in interface UserDisplayNodeFX
      Returns:
      The FX node to add to the display

    • openNode

      public void openNode()
      Description copied from interface: UserDisplayNodeFX
      Called when the component is first displayed.
      Specified by:
      openNode in interface UserDisplayNodeFX

    • isStaticDisplay

      public boolean isStaticDisplay()
      Description copied from interface: UserDisplayNodeFX
      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.
      Specified by:
      isStaticDisplay in interface UserDisplayNodeFX
      Returns:
      true if the pane cannot be removed from the view.

    • isResizeableDisplay

      public boolean isResizeableDisplay()
      Description copied from interface: UserDisplayNodeFX
      Check whether a display can be resized within PAMGuard.
      Specified by:
      isResizeableDisplay in interface UserDisplayNodeFX
      Returns:
      true of the pane can be resized.

    • requestNodeSettingsPane

      public boolean requestNodeSettingsPane()
      Description copied from interface: UserDisplayNodeFX
      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.
      Specified by:
      requestNodeSettingsPane in interface UserDisplayNodeFX
      Returns:
      true if the pane can show settings.

    • closeNode

      public void closeNode()
      Description copied from interface: UserDisplayNodeFX
      Called when the node is removed from the display.
      Specified by:
      closeNode in interface UserDisplayNodeFX

    • notifyModelChanged

      public void notifyModelChanged(int changeType)
      Description copied from interface: UserDisplayNodeFX
      Pick up model changed notifications from a parent user display.
      Specified by:
      notifyModelChanged in interface UserDisplayNodeFX
      Parameters:
      changeType -

    • isMinorDisplay

      public boolean isMinorDisplay()
      Description copied from interface: UserDisplayNodeFX
      Only used for automatic resizing. Minor displays are automatically made smaller
      Specified by:
      isMinorDisplay in interface UserDisplayNodeFX
      Returns:
      true if a minor display.

    • getDisplayParams

      public UserDisplayNodeParams getDisplayParams()
      Description copied from interface: UserDisplayNodeFX
      Get the display provider params.
      Specified by:
      getDisplayParams in interface UserDisplayNodeFX
      Returns:
      display params.

    • setFrameHolder

      public void setFrameHolder(PamInternalPane internalFrame)
      Description copied from interface: UserDisplayNodeFX
      Called whenever the display is added to a frame.
      Specified by:
      setFrameHolder in interface UserDisplayNodeFX
      Parameters:
      internalFrame - - the internal frame.

    • getUserDisplayControl

      public UserDisplayControlFX getUserDisplayControl()
      Description copied from interface: UserDisplayNodeFX
      Get a display controller associated with the display. Note that a display does not need a controller so this can return null.
      Specified by:
      getUserDisplayControl in interface UserDisplayNodeFX
      Returns:
      the associated control for the display.