org.jdesktop.swingx
Class JXErrorDialog

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Dialog
                  extended by javax.swing.JDialog
                      extended by org.jdesktop.swingx.JXErrorDialog
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class JXErrorDialog
extends javax.swing.JDialog

Common Error Dialog, suitable for representing information about errors and exceptions happened in application. The common usage of the JXErrorDialog is to show collected data about the incident and probably ask customer for a feedback. The data about the incident consists from the title which will be displayed in the dialog header, short description of the problem that will be immediately seen after dialog is became visible, full description of the problem which will be visible after user clicks "Details" button and Throwable that contains stack trace and another usable information that may be displayed in the dialog.

To ask user for feedback extend abstract class ErrorReporter and set your reporter using setReporter method. Report button will be added to the dialog automatically.
See MailErrorReporter documentation for the example of error reporting usage.

For example, to show simple JXErrorDialog call
JXErrorDialog.showDialog(null, "Application Error", "The application encountered the unexpected error, please contact developers")

Author:
Richard Bair, Alexander Zuev
See Also:
Serialized Form

Nested Class Summary
 class JXErrorDialog.ReportAction
          Action for report button
 
Nested classes/interfaces inherited from class javax.swing.JDialog
javax.swing.JDialog.AccessibleJDialog
 
Nested classes/interfaces inherited from class java.awt.Dialog
java.awt.Dialog.AccessibleAWTDialog
 
Nested classes/interfaces inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.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 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
JXErrorDialog(java.awt.Dialog owner)
          Create a new ErrorDialog with the given Dialog as the owner
JXErrorDialog(java.awt.Frame owner)
          Create a new ErrorDialog with the given Frame as the owner
 
Method Summary
static ErrorReporter getReporter()
          Returns the current reporting engine that will be used to report a problem if user clicks on 'Report' button or null if no reporting engine set.
static void setReporter(ErrorReporter rep)
          Set reporting engine which will handle error reporting if user clicks 'report' button.
static void showDialog(java.awt.Component owner, IncidentInfo info)
          Show the error dialog.
static void showDialog(java.awt.Component owner, java.lang.String title, java.lang.String errorMessage, java.lang.String details)
          Show the error dialog.
static void showDialog(java.awt.Component owner, java.lang.String title, java.lang.String errorMessage, java.lang.Throwable e)
          Constructs and shows the error dialog for the given exception.
static void showDialog(java.awt.Component owner, java.lang.String title, java.lang.Throwable e)
          Constructs and shows the error dialog for the given exception.
 
Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Dialog
addNotify, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, toBack, 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, removeNotify, 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, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JXErrorDialog

public JXErrorDialog(java.awt.Frame owner)
Create a new ErrorDialog with the given Frame as the owner

Parameters:
owner - Owner of this error dialog.

JXErrorDialog

public JXErrorDialog(java.awt.Dialog owner)
Create a new ErrorDialog with the given Dialog as the owner

Parameters:
owner - Owner of this error dialog.
Method Detail

showDialog

public static void showDialog(java.awt.Component owner,
                              java.lang.String title,
                              java.lang.Throwable e)
Constructs and shows the error dialog for the given exception. The exceptions message will be the errorMessage, and the stacktrace will be the details.

Parameters:
owner - Owner of this error dialog. Determines the Window in which the dialog is displayed; if the owner has no Window, a default Frame is used
title - Title of the error dialog
e - Exception that contains information about the error cause and stack trace

showDialog

public static void showDialog(java.awt.Component owner,
                              java.lang.String title,
                              java.lang.String errorMessage,
                              java.lang.Throwable e)
Constructs and shows the error dialog for the given exception. The exceptions message is specified, and the stacktrace will be the details.

Parameters:
owner - Owner of this error dialog. Determines the Window in which the dialog is displayed; if the owner has no Window, a default Frame is used
title - Title of the error dialog
errorMessage - Message for the error dialog
e - Exception that contains information about the error cause and stack trace

showDialog

public static void showDialog(java.awt.Component owner,
                              java.lang.String title,
                              java.lang.String errorMessage,
                              java.lang.String details)
Show the error dialog.

Parameters:
owner - Owner of this error dialog. Determines the Window in which the dialog is displayed; if the owner has no Window, a default Frame is used
title - Title of the error dialog
errorMessage - Message for the error dialog
details - Details to be shown in the detail section of the dialog. This can be null if you do not want to display the details section of the dialog.

showDialog

public static void showDialog(java.awt.Component owner,
                              IncidentInfo info)
Show the error dialog.

Parameters:
owner - Owner of this error dialog. Determines the Window in which the dialog is displayed; if the owner has no Window, a default Frame is used
info - IncidentInfo that incorporates all the information about the error

getReporter

public static ErrorReporter getReporter()
Returns the current reporting engine that will be used to report a problem if user clicks on 'Report' button or null if no reporting engine set.

Returns:
reporting engine

setReporter

public static void setReporter(ErrorReporter rep)
Set reporting engine which will handle error reporting if user clicks 'report' button.

Parameters:
rep - ErrorReporter to be used or null to turn reporting facility off.


Copyright © 2005 Sun Microsystems All Rights Reserved.