Package PamView

Class PamControlledGUISwing

java.lang.Object
PamController.PamControlledUnitGUI
PamView.PamControlledGUISwing
Direct Known Subclasses:
CTSwingGUI, WrapperControlledGUISwing
public class PamControlledGUISwing extends PamControlledUnitGUI
Provides Swing GUI components for a PAMControlledUnit.
Author:
Jamie Macaulay

  • Constructor Details

    • PamControlledGUISwing

      public PamControlledGUISwing()

  • Method Details

    • getTabPanel

      public PamTabPanel getTabPanel()
      Gets a reference to a panel to be added to a view
      Returns:
      reference to a PamTabPanel object
      See Also:

    • setSidePanel

      public void setSidePanel(PamSidePanel sidePanel)
      Sets the side panel for the PamControlledUnit Side panels are shown down the left hand side of the main Pamguard GUI and are always visible, irrespective of which tab is being viewed on the main tabbed display.

      Side panels are generally used to display summary information for the PamControlledUnit or to provide quick access controls.

      Parameters:
      sidePanel - Reference to a PamSidePanel object
      See Also:

    • setTabPanel

      public void setTabPanel(PamTabPanel tabPanel)
      Sets the tab panel for the PamControlledUnit. A tab panel may contain graphics or tables to display information of any type.
      Parameters:
      tabPanel -

    • getFrameNumber

      public int getFrameNumber()
      Get the number of the frame that side and tab panels for this module should sit on.
      Returns:
      frame number.

    • setFrameNumber

      public void setFrameNumber(int frameNumber)

    • getSidePanel

      public PamSidePanel getSidePanel()
      Gets a reference to a small panel to be displayed along the left hand edge of the main tab panel. Side panels should be small since they are always visible and any space they take will be taken from the main tab panel.

      It is possible for a PamControlled unit to have a side panel without having a pamTabPanel.

      Returns:
      a pamSidePanel object.
      See Also:

    • getToolbarComponent

      public Component getToolbarComponent()
      Sets the toolbar component which will be incorporated into the top toolbar whenever this controlled unit's display is selected in the main tab panel
      Returns:
      An AWT component to include in the toolbar.

    • createDetectionMenu

      public JMenuItem createDetectionMenu(Frame parentFrame)
      Create a JMenu object containing MenuItems associated with PamProcesses
      Parameters:
      parentFrame - The owner frame of the menu
      Returns:
      reference to a JMenu which can be added to an existing menu or menu bar

      Note that if multiple views are to use the same menu, then they should each create a new menu (by setting Create to true) the first time they call this method.

    • createDisplayMenu

      public JMenuItem createDisplayMenu(Frame parentFrame)
      Create a JMenu object containing MenuItems associated with the view
      Returns:
      reference to a JMenu which can be added to an existing menu or menu bar

      Note that if multiple views are to use the same menu, then they should each create a new menu (by setting Create to true) the first time they call this method.

    • createHelpMenu

      public JMenuItem createHelpMenu(Frame parentFrame)

    • createFileMenu

      public JMenuItem createFileMenu(JFrame parentFrame)
      Parameters:
      parentFrame - parent frame for the menu
      Returns:
      the file menu item

    • getPamView

      public PamView getPamView()

    • getTabClipCopier

      public ClipboardCopier getTabClipCopier()

    • getGuiFrame

      public Frame getGuiFrame()
      Get the main frame for the GUI. In some cases the view may not have been created, so go straight to the main one.
      Returns:
      frame.

    • getGUIFlag

      public int getGUIFlag()
      Description copied from class: PamControlledUnitGUI
      Get the flag type for the GUI e.g. PAMGuiManager.SWING;
      Specified by:
      getGUIFlag in class PamControlledUnitGUI
      Returns:
      flag descibing the type of GUI.