com.metamatrix.toolbox.ui.widget
Class ConfigurationPanel

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.ConfigurationPanel

All Implemented Interfaces:

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

Direct Known Subclasses:

TableOptionPanel

public class ConfigurationPanel
extends DialogPanel
implements ButtonConstants

This class is intended to be used everywhere within the application that a configuration panel needs to be displayed. It provides for a navigation button bar at the bottom of the panel, a set of tabbed panels in the center, and a default set of "accept", "cancel", and "apply" buttons within the navigation bar.

Since:

2.0

Version:

2.0

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

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

ConfigurationPanel()
Creates a ConfigurationPanel with no tabs.

ConfigurationPanel(java.awt.Component content)
Creates a ConfigurationPanel with no tabs.

ConfigurationPanel(java.util.List tabNames)
Creates a ConfigurationPanel with one tab for each element in the specified List, named using the element's toString value.

ConfigurationPanel(java.util.List tabNames, java.util.List tabContents)

Method Summary

void	addApplyActionListener(java.awt.event.ActionListener listener) Adds the specified listener to the lists of ActionListeners registered to both the accept and apply buttons.
protected ButtonWidget	createApplyButton() Creates an apply button with a default label (as determined by the ToolboxStandards class).
protected java.awt.Container	createDefaultTab(java.lang.String name)
ButtonWidget	getApplyButton()
protected void	initializeConfigurationPanel()
void	removeApplyActionListener(java.awt.event.ActionListener listener) Removes the specified listener from the lists of ActionListeners registered to both the accept and apply buttons.

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, createAcceptButton, createCancelButton, 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, windowAdded

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

Constructor Detail

ConfigurationPanel

public ConfigurationPanel()

Creates a ConfigurationPanel with no tabs.

Since:

2.0

ConfigurationPanel

public ConfigurationPanel(java.awt.Component content)

Creates a ConfigurationPanel with no tabs.

Since:

2.0

ConfigurationPanel

public ConfigurationPanel(java.util.List tabNames)

Creates a ConfigurationPanel with one tab for each element in the specified List, named using the element's toString value.

Since:

2.0

ConfigurationPanel

public ConfigurationPanel(java.util.List tabNames,
                          java.util.List tabContents)

Since:

2.0

Method Detail

addApplyActionListener

public void addApplyActionListener(java.awt.event.ActionListener listener)

Adds the specified listener to the lists of ActionListeners registered to both the accept and apply buttons.

Parameters:

listener - The ActionListener to be added

Since:

2.0

createApplyButton

protected ButtonWidget createApplyButton()

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

Returns:

The apply button

Since:

2.0

createDefaultTab

protected java.awt.Container createDefaultTab(java.lang.String name)

Since:

2.0

getApplyButton

public ButtonWidget getApplyButton()

Returns:

The apply button

Since:

2.0

initializeConfigurationPanel

protected void initializeConfigurationPanel()

Since:

2.0

removeApplyActionListener

public void removeApplyActionListener(java.awt.event.ActionListener listener)

Removes the specified listener from the lists of ActionListeners registered to both the accept and apply buttons.

Parameters:

listener - The ActionListener to be removed

Since:

2.0