jas2.util

Class ErrorBox

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

jas2.util.JASDialog

jas2.util.ErrorBox

All Implemented Interfaces:

java.awt.event.MouseListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.DocumentListener, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class ErrorBox
extends JASDialog

This class is used to show the user that an error has occurred. If the error is in the form of a Throwable (normally an Exception, but possibly an Error) then that object can be passed to the error box so that the user can be notified of the exact error. Invoke doModal() on the object to show the error.

See Also:

Throwable, Exception, Error, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Dialog

java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

Nested classes/interfaces inherited from class java.awt.Window

java.awt.Window.Type

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields inherited from class jas2.util.JASDialog

APPLY_BUTTON, CANCEL_BUTTON, HELP_BUTTON, OK_BUTTON

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
ErrorBox(javax.swing.JFrame parent, java.lang.String message) Opens an ErrorBox with no help button and no displayed Throwable.
ErrorBox(javax.swing.JFrame parent, java.lang.String message, java.lang.String helpTopic) Opens an ErrorBox that has a Help button that opens the specified topic.
ErrorBox(javax.swing.JFrame parent, java.lang.String message, java.lang.Throwable throwable) Opens an ErrorBox that displays a Throwable, but has no help button.
ErrorBox(javax.swing.JFrame parent, java.lang.String message, java.lang.Throwable throwable, java.lang.String helpTopic) Opens an ErrorBox that displays a Throwable and has a Help button that opens the specified topic.

Method Summary

Methods inherited from class jas2.util.JASDialog

changedUpdate, create, create, create, defaultPack, doModal, getContentPane, insertUpdate, mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased, pack, processEvent, removeUpdate, setApplyLabel, setApplyMnemonic, setCancelLabel, setCancelMnemonic, setContentPane, setHelpTopic, setOKLabel, setOKMnemonic, show

Methods inherited from class javax.swing.JDialog

getAccessibleContext, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, remove, repaint, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, 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, 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, paint, postEvent, 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, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, 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, getPeer, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ErrorBox

public ErrorBox(javax.swing.JFrame parent,
                java.lang.String message)

Opens an ErrorBox with no help button and no displayed Throwable.

Parameters:

parent - the parent JFrame

message - a String to display as a message

ErrorBox

public ErrorBox(javax.swing.JFrame parent,
                java.lang.String message,
                java.lang.String helpTopic)

Opens an ErrorBox that has a Help button that opens the specified topic. Help books are accessible throught static constants in the Application class.

Parameters:

parent - the parent JFrame

message - a String to display as a message

helpTopic - the help topic (as specified in the .oht topics file for the specified book)

See Also:

Application

ErrorBox

public ErrorBox(javax.swing.JFrame parent,
                java.lang.String message,
                java.lang.Throwable throwable)

Opens an ErrorBox that displays a Throwable, but has no help button. Book objects are accessible through static constants in the Application class.

Parameters:

parent - the parent JFrame

message - a String to display as a message

throwable - the Error or Exception that was generated

See Also:

Application

ErrorBox

public ErrorBox(javax.swing.JFrame parent,
                java.lang.String message,
                java.lang.Throwable throwable,
                java.lang.String helpTopic)

Opens an ErrorBox that displays a Throwable and has a Help button that opens the specified topic. Book objects are available through the Application class.

Parameters:

parent - the parent JFrame

message - a String to display as a message

throwable - the Error or Exception that was generated

helpTopic - the help topic (XML target)

See Also:

Application