Class HelpDialog
java.lang.Object
java.awt.Component
java.awt.Container
java.awt.Window
java.awt.Dialog
javax.swing.JDialog
com.compomics.util.gui.error_handlers.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
-
Nested Class Summary
Nested classes/interfaces inherited from class java.awt.Dialog
Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType
Nested classes/interfaces inherited from class java.awt.Window
Window.AccessibleAWTWindow, Window.Type
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
Field Summary
Fields inherited from class javax.swing.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
-
Constructor Summary
Constructors Constructor Description HelpDialog(Frame parent, URL fileName, Image helpIcon, Image aboutIcon, String title)
Creates a new HelpDialog with a JFrame as a parent.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.HelpDialog(Frame parent, URL fileName, String reference, Image helpIcon, Image aboutIcon, String title)
Creates a new HelpDialog with a JFrame as a parent.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.HelpDialog(JDialog parent, URL fileName, Image helpIcon, Image aboutIcon, String title)
Creates a new HelpDialog object with a JDialog as a parent.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.HelpDialog(JDialog parent, URL fileName, String reference, Image helpIcon, Image aboutIcon, String title)
Creates a new HelpDialog with a JDialog as a parent.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. -
Method Summary
Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update
Methods inherited from class java.awt.Dialog
addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
Constructor Details
-
HelpDialog
Creates a new HelpDialog with a JFrame as a parent.- Parameters:
parent
- the parent framefileName
- the name of the help filehelpIcon
- the icon to use for the help pagesaboutIcon
- the icon to use for the about pagestitle
- 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 framefileName
- the name of the help filehelpIcon
- the icon to use for the help pagesaboutIcon
- the icon to use for the about pagestitle
- the title to use for the dialogwindowWidth
- the window widthwindowHeightReduction
- 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 framefileName
- the name of the help filereference
- a reference in the HTML file to scroll to, can be nullhelpIcon
- the icon to use for the help pagesaboutIcon
- the icon to use for the about pagestitle
- 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 framefileName
- the name of the help filereference
- a reference in the HTML file to scroll to, can be nullhelpIcon
- the icon to use for the help pagesaboutIcon
- the icon to use for the about pagestitle
- the title to use for the dialogwindowWidth
- the window widthwindowHeightReduction
- the window height reduction
-
HelpDialog
Creates a new HelpDialog object with a JDialog as a parent.- Parameters:
parent
- the parent dialogfileName
- the name of the help filehelpIcon
- the icon to use for the help pagesaboutIcon
- the icon to use for the about pagestitle
- 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 dialogfileName
- the name of the help filehelpIcon
- the icon to use for the help pagesaboutIcon
- the icon to use for the about pagestitle
- the title to use for the dialogwindowWidth
- the window widthwindowHeightReduction
- 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 dialogfileName
- the name of the help filereference
- a reference in the HTML file to scroll to, can be nullhelpIcon
- the icon to use for the help pagesaboutIcon
- the icon to use for the about pagestitle
- 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 dialogfileName
- the name of the help filereference
- a reference in the HTML file to scroll to, can be nullhelpIcon
- the icon to use for the help pagesaboutIcon
- the icon to use for the about pagestitle
- the title to use for the dialogwindowWidth
- the window widthwindowHeightReduction
- the window height reduction
-