com.metamatrix.toolbox.ui.widget
Class MessagePanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.metamatrix.toolbox.ui.widget.DialogPanel
                      com.metamatrix.toolbox.ui.widget.MessagePanel

All Implemented Interfaces:

UIConstants, ButtonConstants, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class MessagePanel
extends DialogPanel

This class is intended to be used everywhere within the application that a message panel needs to be displayed.

Since:

Golden Gate

Version:

Golden Gate

Author:

John P. A. Verhaeg

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

static java.lang.String	BUTTON_TYPES_PROPERTY_PREFIX
static java.lang.String	CONFIRMATION_TITLE
static java.lang.String	ERROR_TITLE
static java.lang.String	NOTIFICATION_TITLE
static java.lang.String	QUESTION_TITLE
static java.lang.String	TYPE_CANCELLABLE_QUESTION
static java.lang.String	TYPE_CONFIRMATION
static java.lang.String	TYPE_ERROR
static java.lang.String	TYPE_NOTIFICATION
static java.lang.String	TYPE_QUESTION
static java.lang.String	TYPE_WARNING
static java.lang.String	WARNING_TITLE

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.metamatrix.toolbox.ui.widget.ButtonConstants

ACCEPT_BUTTON, APPLY_BUTTON, BACK_BUTTON, CANCEL_BUTTON, CONTEXT_SENSITIVE_HELP, DEFAULTS_BUTTON, DETAILS_BUTTON, EXIT_BUTTON, FINISH_BUTTON, HELP_BUTTON, LOGIN_BUTTON, NEXT_BUTTON, NO_BUTTON, OVERWRITE_BUTTON, REPLACE_BUTTON, RETRY_BUTTON, SKIP_BUTTON, YES_BUTTON

Fields inherited from interface com.metamatrix.toolbox.ui.UIConstants

DATE_FORMAT_PROPERTY, SPACER_HORIZONTAL_LENGTH_PROPERTY, WINDOW_BORDER_PROPERTY

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

MessagePanel(javax.swing.Icon icon, java.lang.String message)
Creates a message panel containing the specified icon and message.

MessagePanel(javax.swing.Icon icon, java.lang.String message, javax.swing.JComponent component)
Creates a message panel containing the specified icon and message.

MessagePanel(java.lang.String id)
Creates a message panel containing the message identified by the specified ID.

MessagePanel(java.lang.String id, javax.swing.JComponent component)
Creates a message panel containing the message identified by the specified ID.

MessagePanel(java.lang.String type, java.lang.String message)
Creates a message panel containing the specified message.

MessagePanel(java.lang.String type, java.lang.String message, javax.swing.JComponent component)
Creates a message panel containing the specified message.

Method Summary

ButtonWidget	createAcceptButton() Creates an accept button with a default label (as determined by the ToolboxStandards class).
ButtonWidget	createCancelButton() Creates an cancel button with a default label (as determined by the ToolboxStandards class).
protected ButtonWidget	createDetailButton() Creates a detail button with a default label (as determined by the ToolboxStandards class).
ButtonWidget	getDetailButton() Returns the detail button for this MessagePanel, or null.
javax.swing.Icon	getIcon() Returns the icon for this message panel, if any.
java.lang.String	getID()
java.lang.String	getType()
protected void	initializeMessagePanel() Calls initializeDialogPanel Determines the icon and buttons from the type or id Adds the icon to the WEST region Modifies existing navigation bar buttons & adds additional buttons as determined by type or id Adds a panel to the CENTER region with a layout that allows for an easily created vertical list of components with the same height Creates a LabelWidget containing the message ID, followed by a blank line, then each line of the message Adds the LabelWidget to the panel mentioned above If detail component present, adds detail toggle button to navigation bar, along with a listener to show/hide the detail component and change the button text as appropriate
boolean	isDetailAvailable() Returns whether or not a detail component is available.
protected void	setTitle(DialogWindow dlg, java.lang.String title)
protected void	windowAdded() To be overridden by subclasses, allowing you to refresh your dialog panel when the focus on the parent window is added.

Methods inherited from class com.metamatrix.toolbox.ui.widget.DialogPanel

accept, addAcceptButton, addAcceptButton, addCancelButton, addCancelButton, addHelpButton, addHelpButton, addNavigationButton, addNavigationButton, addNavigationComponent, addNavigationSpacer, addNavigationSpacer, buildNavigationBar, canAccept, canCancel, cancel, createHelpButton, createNavigationBar, equalizeNavigationButtonWidths, getAcceptButton, getAcceptButtons, getCancelButton, getContent, getContentContainer, getHelpButton, getNavigationBar, getNavigationButton, getNavigationComponent, getNavigationComponentIndex, getSelectedButton, getWindowAncestor, initializeDialogPanel, removeNavigationButton, removeNavigationComponent, removeNavigationSpacer, setCanAccept, setCanCancel, setContent, setLayout, setVisible, validateState, windowActivated

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

BUTTON_TYPES_PROPERTY_PREFIX

public static final java.lang.String BUTTON_TYPES_PROPERTY_PREFIX

See Also:

Constant Field Values

TYPE_WARNING

public static final java.lang.String TYPE_WARNING

See Also:

Constant Field Values

TYPE_NOTIFICATION

public static final java.lang.String TYPE_NOTIFICATION

See Also:

Constant Field Values

TYPE_ERROR

public static final java.lang.String TYPE_ERROR

See Also:

Constant Field Values

TYPE_CONFIRMATION

public static final java.lang.String TYPE_CONFIRMATION

See Also:

Constant Field Values

TYPE_CANCELLABLE_QUESTION

public static final java.lang.String TYPE_CANCELLABLE_QUESTION

See Also:

Constant Field Values

TYPE_QUESTION

public static final java.lang.String TYPE_QUESTION

See Also:

Constant Field Values

CONFIRMATION_TITLE

public static final java.lang.String CONFIRMATION_TITLE

See Also:

Constant Field Values

ERROR_TITLE

public static final java.lang.String ERROR_TITLE

See Also:

Constant Field Values

NOTIFICATION_TITLE

public static final java.lang.String NOTIFICATION_TITLE

See Also:

Constant Field Values

QUESTION_TITLE

public static final java.lang.String QUESTION_TITLE

See Also:

Constant Field Values

WARNING_TITLE

public static final java.lang.String WARNING_TITLE

See Also:

Constant Field Values

Constructor Detail

MessagePanel

public MessagePanel(java.lang.String id)

Creates a message panel containing the message identified by the specified ID. The message text, icon, and buttons displayed are obtained from a resource bundle using id as a key.

Parameters:

id - The ID of the message information within the resource bundle

Since:

Golden Gate

MessagePanel

public MessagePanel(java.lang.String type,
                    java.lang.String message)

Creates a message panel containing the specified message. The message icon and buttons displayed are obtained from the ToolboxStandards using the specified message type.

Parameters:

type - The message type

message - The message text, which may include multiple lines delimited by line-feeds ('\n')

Since:

Golden Gate

MessagePanel

public MessagePanel(javax.swing.Icon icon,
                    java.lang.String message)

Creates a message panel containing the specified icon and message.

Parameters:

icon - The message icon

message - The message text, which may include multiple lines delimited by line-feeds ('\n')

Since:

Golden Gate

MessagePanel

public MessagePanel(java.lang.String id,
                    javax.swing.JComponent component)

Creates a message panel containing the message identified by the specified ID. The message text, icon, and buttons displayed are obtained from a resource bundle using id as a key. A 'detail' toggle button will also be present that displays the specified component between the current content and the navigation bar when selected.

Parameters:

id - The ID of the message information within the resource bundle

component - The detail component

Since:

Golden Gate

MessagePanel

public MessagePanel(java.lang.String type,
                    java.lang.String message,
                    javax.swing.JComponent component)

Creates a message panel containing the specified message. The message icon and buttons displayed are obtained from the ToolboxStandards using the specified message type. A 'detail' toggle button will also be present that displays the specified component between the current content and the navigation bar when selected.

Parameters:

type - The message type

message - The message text, which may include multiple lines delimited by line-feeds ('\n')

component - The detail component

Since:

Golden Gate

MessagePanel

public MessagePanel(javax.swing.Icon icon,
                    java.lang.String message,
                    javax.swing.JComponent component)

Creates a message panel containing the specified icon and message. A 'detail' toggle button will also be present that displays the specified component between the current content and the navigation bar when selected.

Parameters:

icon - The message icon

message - The message text, which may include multiple lines delimited by line-feeds ('\n')

component - The detail component

Since:

Golden Gate

Method Detail

createAcceptButton

public ButtonWidget createAcceptButton()

Description copied from class: DialogPanel

Creates an accept button with a default label (as determined by the ToolboxStandards class).

Overrides:

createAcceptButton in class DialogPanel

Returns:

The accept button

createCancelButton

public ButtonWidget createCancelButton()

Description copied from class: DialogPanel

Creates an cancel button with a default label (as determined by the ToolboxStandards class).

Overrides:

createCancelButton in class DialogPanel

Returns:

The cancel button

createDetailButton

protected ButtonWidget createDetailButton()

Creates a detail button with a default label (as determined by the ToolboxStandards class).

Returns:

The detail button

Since:

Golden Gate

getDetailButton

public ButtonWidget getDetailButton()

Returns the detail button for this MessagePanel, or null. The MessagePanel will have a detail button so long as there is a message detail available. (see @link isDetailAvailable)

Returns:

The detail button, if available, else null.

Since:

Golden Gate

getIcon

public javax.swing.Icon getIcon()

Returns the icon for this message panel, if any.

Returns:

The message icon, if available, else null.

Since:

Golden Gate

getID

public java.lang.String getID()

Returns:

The message ID, if available, else null.

Since:

Golden Gate

getType

public java.lang.String getType()

Returns:

The message type, if available, else null.

Since:

Golden Gate

initializeMessagePanel

protected void initializeMessagePanel()

• Calls initializeDialogPanel
• Determines the icon and buttons from the type or id
• Adds the icon to the WEST region
• Modifies existing navigation bar buttons & adds additional buttons as determined by type or id
• Adds a panel to the CENTER region with a layout that allows for an easily created vertical list of components with the same height
• Creates a LabelWidget containing the message ID, followed by a blank line, then each line of the message
• Adds the LabelWidget to the panel mentioned above
• If detail component present, adds detail toggle button to navigation bar, along with a listener to show/hide the detail component and change the button text as appropriate

Since:

Golden Gate

isDetailAvailable

public boolean isDetailAvailable()

Returns whether or not a detail component is available.

Returns:

True if message detail is available

Since:

Golden Gate

setTitle

protected void setTitle(DialogWindow dlg,
                        java.lang.String title)

Since:

Golden Gate

windowAdded

protected void windowAdded()

Description copied from class: DialogPanel

To be overridden by subclasses, allowing you to refresh your dialog panel when the focus on the parent window is added.

Overrides:

windowAdded in class DialogPanel

Since:

Golden Gate