Package PamView

Class WrapperControlledGUISwing

java.lang.Object
PamController.PamControlledUnitGUI
PamView.PamControlledGUISwing
PamView.WrapperControlledGUISwing
public class WrapperControlledGUISwing extends PamControlledGUISwing
Wrapper class which returns Swing GUI functions from the soon to be deprecated functions within the PamControlledUnit class.

This is used to allow developers to call GUI functions from the PAMControlled unit using getPamGui(Swing) without requiring any alterations to the PamControlledUnit.

Author:
Jamie Macaulay

  • Constructor Details

    • WrapperControlledGUISwing

      public WrapperControlledGUISwing(PamControlledUnit pamControlledUnit)

  • Method Details

    • getTabPanel

      public PamTabPanel getTabPanel()
      Description copied from class: PamControlledGUISwing
      Gets a reference to a panel to be added to a view
      Overrides:
      getTabPanel in class PamControlledGUISwing
      Returns:
      reference to a PamTabPanel object
      See Also:

    • setSidePanel

      public void setSidePanel(PamSidePanel sidePanel)
      Description copied from class: PamControlledGUISwing
      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.

      Overrides:
      setSidePanel in class PamControlledGUISwing
      Parameters:
      sidePanel - Reference to a PamSidePanel object
      See Also:

    • setTabPanel

      public void setTabPanel(PamTabPanel tabPanel)
      Description copied from class: PamControlledGUISwing
      Sets the tab panel for the PamControlledUnit. A tab panel may contain graphics or tables to display information of any type.
      Overrides:
      setTabPanel in class PamControlledGUISwing

    • getFrameNumber

      public int getFrameNumber()
      Description copied from class: PamControlledGUISwing
      Get the number of the frame that side and tab panels for this module should sit on.
      Overrides:
      getFrameNumber in class PamControlledGUISwing
      Returns:
      frame number.

    • setFrameNumber

      public void setFrameNumber(int frameNumber)
      Overrides:
      setFrameNumber in class PamControlledGUISwing

    • getSidePanel

      public PamSidePanel getSidePanel()
      Description copied from class: PamControlledGUISwing
      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.

      Overrides:
      getSidePanel in class PamControlledGUISwing
      Returns:
      a pamSidePanel object.
      See Also:

    • getToolbarComponent

      public Component getToolbarComponent()
      Description copied from class: PamControlledGUISwing
      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
      Overrides:
      getToolbarComponent in class PamControlledGUISwing
      Returns:
      An AWT component to include in the toolbar.

    • createDetectionMenu

      public JMenuItem createDetectionMenu(Frame parentFrame)
      Description copied from class: PamControlledGUISwing
      Create a JMenu object containing MenuItems associated with PamProcesses
      Overrides:
      createDetectionMenu in class PamControlledGUISwing
      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)
      Description copied from class: PamControlledGUISwing
      Create a JMenu object containing MenuItems associated with the view
      Overrides:
      createDisplayMenu in class PamControlledGUISwing
      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)
      Overrides:
      createHelpMenu in class PamControlledGUISwing

    • createFileMenu

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

    • getPamView

      public PamView getPamView()
      Overrides:
      getPamView in class PamControlledGUISwing

    • getTabClipCopier

      public ClipboardCopier getTabClipCopier()
      Overrides:
      getTabClipCopier in class PamControlledGUISwing

    • getGuiFrame

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