Class HelpDialog

All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class HelpDialog
extends JDialog
A dialog used to display help text in HTML format.
Author:
Harald Barsnes
See Also:
Serialized Form
  • Constructor Details

    • HelpDialog

      public HelpDialog​(Frame parent, URL fileName, Image helpIcon, Image aboutIcon, String title)
      Creates a new HelpDialog with a JFrame as a parent.
      Parameters:
      parent - the parent frame
      fileName - the name of the help file
      helpIcon - the icon to use for the help pages
      aboutIcon - the icon to use for the about pages
      title - the title to use for the dialog
    • HelpDialog

      public HelpDialog​(Frame parent, URL fileName, Image helpIcon, Image aboutIcon, String title, int windowWidth, int windowHeightReduction)
      Creates a new HelpDialog with a JFrame as a parent.
      Parameters:
      parent - the parent frame
      fileName - the name of the help file
      helpIcon - the icon to use for the help pages
      aboutIcon - the icon to use for the about pages
      title - the title to use for the dialog
      windowWidth - the window width
      windowHeightReduction - the window height reduction
    • HelpDialog

      public HelpDialog​(Frame parent, URL fileName, String reference, Image helpIcon, Image aboutIcon, String title)
      Creates a new HelpDialog with a JFrame as a parent.
      Parameters:
      parent - the parent frame
      fileName - the name of the help file
      reference - a reference in the HTML file to scroll to, can be null
      helpIcon - the icon to use for the help pages
      aboutIcon - the icon to use for the about pages
      title - the title to use for the dialog
    • HelpDialog

      public HelpDialog​(Frame parent, URL fileName, String reference, Image helpIcon, Image aboutIcon, String title, int windowWidth, int windowHeightReduction)
      Creates a new HelpDialog with a JFrame as a parent.
      Parameters:
      parent - the parent frame
      fileName - the name of the help file
      reference - a reference in the HTML file to scroll to, can be null
      helpIcon - the icon to use for the help pages
      aboutIcon - the icon to use for the about pages
      title - the title to use for the dialog
      windowWidth - the window width
      windowHeightReduction - the window height reduction
    • HelpDialog

      public HelpDialog​(JDialog parent, URL fileName, Image helpIcon, Image aboutIcon, String title)
      Creates a new HelpDialog object with a JDialog as a parent.
      Parameters:
      parent - the parent dialog
      fileName - the name of the help file
      helpIcon - the icon to use for the help pages
      aboutIcon - the icon to use for the about pages
      title - the title to use for the dialog
    • HelpDialog

      public HelpDialog​(JDialog parent, URL fileName, Image helpIcon, Image aboutIcon, String title, int windowWidth, int windowHeightReduction)
      Creates a new HelpDialog object with a JDialog as a parent.
      Parameters:
      parent - the parent dialog
      fileName - the name of the help file
      helpIcon - the icon to use for the help pages
      aboutIcon - the icon to use for the about pages
      title - the title to use for the dialog
      windowWidth - the window width
      windowHeightReduction - the window height reduction
    • HelpDialog

      public HelpDialog​(JDialog parent, URL fileName, String reference, Image helpIcon, Image aboutIcon, String title)
      Creates a new HelpDialog with a JDialog as a parent.
      Parameters:
      parent - the parent dialog
      fileName - the name of the help file
      reference - a reference in the HTML file to scroll to, can be null
      helpIcon - the icon to use for the help pages
      aboutIcon - the icon to use for the about pages
      title - the title to use for the dialog
    • HelpDialog

      public HelpDialog​(JDialog parent, URL fileName, String reference, Image helpIcon, Image aboutIcon, String title, int windowWidth, int windowHeightReduction)
      Creates a new HelpDialog with a JDialog as a parent.
      Parameters:
      parent - the parent dialog
      fileName - the name of the help file
      reference - a reference in the HTML file to scroll to, can be null
      helpIcon - the icon to use for the help pages
      aboutIcon - the icon to use for the about pages
      title - the title to use for the dialog
      windowWidth - the window width
      windowHeightReduction - the window height reduction