Module org.jpo
Package org.jpo.gui.swing

Class PictureFrame

java.lang.Object
org.jpo.gui.swing.PictureFrame
public class PictureFrame extends Object
Class that manages the frame and display of the Picture. Where the Picture Viewer is concerned with which node to show, the PictureFrame handles all aspects of showing the picture.

  • Constructor Details

    • PictureFrame

      public PictureFrame()
      Constructor. Initialises the GUI widgets.

  • Method Details

    • getPictureController

      public OverlayedPictureController getPictureController()
      Provides direct access to the panel that shows the picture.
      Returns:
      the Picture Controller

    • getPictureViewerNavBar

      public PictureViewerNavBar getPictureViewerNavBar()
      Provides direct access to the navButtonPanel
      Returns:
      the navButtonPanel

    • getFocussableDescriptionField

      public Component getFocussableDescriptionField()
      Returns the Component of the Description Text Area so that others can attach a FocusListener to it.
      Returns:
      Component of the Description Text Area

    • getDescription

      public String getDescription()
      Returns the description that the user could have modified
      Returns:
      the description

    • setDescription

      public void setDescription(String newDescription)
      Sets the description to the supplied string.
      Parameters:
      newDescription - The new description to be shown

    • switchWindowMode

      public void switchWindowMode(ResizableJFrame.WindowSize newMode)
      The location and size of the Window can be changed by a call to this method
      Parameters:
      newMode - new mode

    • getRid

      public void getRid()
      Gets rid of the frame.

    • getResizableJFrame

      public ResizableJFrame getResizableJFrame()
      Returns the resizeable frame object
      Returns:
      the frame object

    • setProgressBarVisible

      public void setProgressBarVisible(boolean visible)
      Passes the parameter to the setVisible method of the ProgressBar
      Parameters:
      visible - true if visible, false if not.

    • setProgressBarValue

      public void setProgressBarValue(int value)
      Passes the parameter to the setValue method of the ProgressBar
      Parameters:
      value - the progress bar value

    • cycleInfoDisplay

      public void cycleInfoDisplay()
      moves the info display to the next panel and requests focus into the window

    • showError

      public void showError(String errorMessage)

    • hideError

      public void hideError()