Package uk.ac.starlink.topcat

Class AuxDialog

java.lang.Object
java.awt.Component
java.awt.Container
java.awt.Window
java.awt.Dialog
javax.swing.JDialog
uk.ac.starlink.topcat.AuxDialog
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants
Direct Known Subclasses:
ColumnSearchWindow, PlotStiltsDialog, StiltsDialog
public class AuxDialog extends JDialog
Application-style JDialog subclass. This parallels AuxWindow, providing similar boilerplate items but for a JDialog rather than a JFrame. It doesn't include all the capabilities of AuxWindow, since so far they are not needed, and AuxWindow probably attempts to enforce more uniformity than is really helpful. But more things can be added if required.
Since:
22 Sep 2017
Author:
Mark Taylor
See Also:

  • Constructor Details

    • AuxDialog

      public AuxDialog(String title, Window owner)
      Constructor.
      Parameters:
      title - dialog title
      owner - dialog owner window

  • Method Details

    • addHelp

      protected void addHelp(String helpID)
      Adds standard actions to this window, in the menu and toolbar. This method should generally be called by subclasses after they have added any other menus and toolbar buttons specific to their function, since the standard buttons appear as the last ones.

      An ID can be supplied to indicate the page which should be shown in the help viewer when context-sensitive help is requested. This may be null if no change in the help page should be made (for instance if there is no help specific to this window).

      Parameters:
      helpID - the ID of the help item for this window

    • placeProgressBar

      public JProgressBar placeProgressBar()
      Creates a JProgressBar and places it in the the window. It will replace any other progress bar which has been placed by an earlier call of this method.
      Returns:
      the progress bar which has been placed

    • getToolBar

      public JToolBar getToolBar()
      Returns this window's toolbar. Any client which adds a group of tools to the toolbar should add a separator after the group.
      Returns:
      the toolbar

    • getWindowMenu

      public JMenu getWindowMenu()
      Returns this window's "Window" menu.
      Returns:
      the window menu

    • getHelpMenu

      public JMenu getHelpMenu()
      Returns this window's "Help" menu.
      Returns:
      the help menu