jas.util
Class ErrorBox

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      jas.util.JASDialog
                          jas.util.ErrorBox

All Implemented Interfaces:

MouseListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, DocumentListener, RootPaneContainer, 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.

Author:

Tony Johnson, Jonas Gifford

See Also:

Throwable, Exception, Error, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JDialog

JDialog.AccessibleJDialog

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

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class jas.util.JASDialog

APPLY_BUTTON, CANCEL_BUTTON, HELP_BUTTON, OK_BUTTON

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

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

ErrorBox(JFrame parent, String message)
Opens an ErrorBox with no help button and no displayed Throwable.

ErrorBox(JFrame parent, String message, String helpTopic)
Opens an ErrorBox that has a Help button that opens the specified topic.

ErrorBox(JFrame parent, String message, Throwable throwable)
Opens an ErrorBox that displays a Throwable, but has no help button.

ErrorBox(JFrame parent, String message, Throwable throwable, String helpTopic)
Opens an ErrorBox that displays a Throwable and has a Help button that opens the specified topic.

Method Summary

protected void	enableApply(JASState state) Inherited from JASDialog; do not call.
protected void	onApply() Inherited from JASDialog; do not call.
protected void	onCancel() Inherited from JASDialog; do not call.

Methods inherited from class jas.util.JASDialog

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

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setModalityType, setResizable, setTitle, setUndecorated, setVisible, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, postEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, 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, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, 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, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, 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, isOpaque, 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, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ErrorBox

public ErrorBox(JFrame parent,
                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(JFrame parent,
                String message,
                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(JFrame parent,
                String message,
                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(JFrame parent,
                String message,
                Throwable throwable,
                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

Method Detail

enableApply

protected final void enableApply(JASState state)

Inherited from JASDialog; do not call.

Overrides:

enableApply in class JASDialog

onCancel

protected final void onCancel()

Inherited from JASDialog; do not call.

Overrides:

onCancel in class JASDialog

onApply

protected final void onApply()

Inherited from JASDialog; do not call.

Overrides:

onApply in class JASDialog