com.ca.commons.cbutil
Class CBErrorWin

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--javax.swing.JDialog
                                |
                                +--com.ca.commons.cbutil.CBErrorWin

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public class CBErrorWin

extends javax.swing.JDialog

Provides a small multi-line error reporting window, with an option to pull down a detailed error message.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JDialog

javax.swing.JDialog.AccessibleJDialog

Nested classes inherited from class java.awt.Dialog

java.awt.Dialog.AccessibleAWTDialog

Nested classes inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes 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

CBErrorWin(java.awt.Dialog owner, java.lang.String Msg, java.lang.Exception e)
Constructor - take a parent frame, a message, and a detailed error message (may be null).

CBErrorWin(java.awt.Frame owner, java.lang.String Msg, java.lang.Exception e)
Constructor - take a parent frame, a message, and a detailed error message (may be null).

CBErrorWin(java.awt.Frame owner, java.lang.String Msg, java.lang.String msgTitle)
Constructor - takes a parent frame, a confirmation message, and creates a short multi-line text display.

Method Summary

void	commonConstructor(java.lang.String Msg, java.lang.Exception e) This creates a short multi-line text displayed, with a 'details' button which expands the display to show the full error message as well.
void	escKeyCheck(java.awt.event.KeyEvent e) Checks if keyboard entry is an 'escape' key.
protected javax.swing.JTextArea	makeTextArea(java.lang.String text) Constructs a text area with its initial text set.

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, dispose, 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, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, 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, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, 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, 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, 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, isOpaque, 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, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, 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

CBErrorWin

public CBErrorWin(java.awt.Dialog owner,
                  java.lang.String Msg,
                  java.lang.Exception e)

Constructor - take a parent frame, a message, and a detailed error message (may be null). This creates a short multi-line text displayed, with a 'details' button which expands the display to show the full error message as well.

Parameters:

owner - the component (from which the parent Frame will be derived)

Msg - a short one line message to display to the user

e - the exception to log

CBErrorWin

public CBErrorWin(java.awt.Frame owner,
                  java.lang.String Msg,
                  java.lang.Exception e)

Constructor - take a parent frame, a message, and a detailed error message (may be null). This creates a short multi-line text displayed, with a 'details' button which expands the display to show the full error message as well.

Parameters:

owner - the component (from which the parent Frame will be derived)

Msg - a short one line message to display to the user

e - the exception to log

CBErrorWin

public CBErrorWin(java.awt.Frame owner,
                  java.lang.String Msg,
                  java.lang.String msgTitle)

Constructor - takes a parent frame, a confirmation message, and creates a short multi-line text display.

Parameters:

owner - the component (from which the parent Frame will be derived)

Msg - a short one line confirmation message to display to the user.

Method Detail

commonConstructor

public void commonConstructor(java.lang.String Msg,
                              java.lang.Exception e)

This creates a short multi-line text displayed, with a 'details' button which expands the display to show the full error message as well.

Parameters:

Msg - a short one line message to display to the user.

e - the exception to log.

makeTextArea

protected javax.swing.JTextArea makeTextArea(java.lang.String text)

Constructs a text area with its initial text set. Sets the back ground colour, disables the text area, sets the text colour to black and allows line wrapping by word.

Parameters:

text - the text to be automatically set in the text field.

Returns:

the JTextArea component.

escKeyCheck

public void escKeyCheck(java.awt.event.KeyEvent e)

Checks if keyboard entry is an 'escape' key. If so, dialog closes. Checks if keyboard entry is an 'enter' key. If so, fakes a click on the 'ok' button.

Parameters:

e - the key code to be checked ie '27' is the 'escape' key as '10' is the 'enter' key