com.metamatrix.toolbox.ui.widget
Class WizardPanel

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

All Implemented Interfaces:

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

Direct Known Subclasses:

WizardInterfaceImpl

public class WizardPanel
extends DialogPanel

This class is intended to be used everywhere within the application that a wizard panel needs to be displayed. It provides the following features:

• A navigation button bar at the bottom of the dialog
• A set of methods to work with each button
• A default set of "back", "next", "finish", and "cancel" buttons within the bar
• A default implementation for the functions of the back and next buttons

. The back button will not appear when the first page is displayed, and the next button will be replaced by a finish button when the last page is displayed.

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

protected java.util.Collection

pages

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

WizardPanel()
Creates a panel with a BorderLayout and a navigation bar in the SOUTH region.

WizardPanel(java.util.Collection pages)
Creates a panel with a BorderLayout, a navigation bar in the SOUTH region, and the specified ordered list of pages, initially displaying the first in the CENTER region.

WizardPanel(java.awt.Component page)
Creates a panel with a BorderLayout, a navigation bar in the SOUTH region, and the specified initial page in the CENTER region.

Method Summary

int	addPage(java.awt.Component page) Adds the specified page to the end of the current list of pages.
void	addPage(java.awt.Component page, int index) Adds the specified page to the current list of pages at the specified index.
protected ButtonWidget	createAcceptButton() Creates an accept button with a default label (as determined by the ToolboxStandards class).
protected ButtonWidget	createBackButton() Creates a back button with the following features: A default label (as determined by the ToolboxStandards class) A default ActionListener that calls showPreviousPage():
protected ButtonWidget	createNextButton() Creates a next button with the following features: A default label (as determined by the ToolboxStandards class) A default ActionListener that calls showNextPage()
ButtonWidget	getBackButton()
java.awt.Component	getCurrentPage() Convenience method for DialogPanel.getContent().
int	getCurrentPageIndex()
ButtonWidget	getFinishButton() Convenience method for DialogPanel.getAcceptButton().
ButtonWidget	getNextButton()
int	getPageCount()
protected void	initializeWizardPanel()
int	removePage(java.awt.Component page) Remove all internal references to the specified component being removed from the navigation bar.
protected void	removePage(java.awt.Component page, int index)
java.awt.Component	removePage(int index) Removes the page at the specified index from the current list of pages.
void	showNextPage() Displays the next page.
void	showPage(java.awt.Component page) Performs the following tasks: Displays the specified page (i.e., Sets the content to that page) Add a back button to the navigation bar if not present and the page is not the first Add a next button to the navigation bar if not present and the page is not the last Add a finish button to the navigation bar if not present and the page is the last Disables the back button if present and the page is the first Remove the next button if present and the page is the last Remove the finish button if present and the page is not the last
protected void	showPage(java.awt.Component page, int index)
void	showPage(int index) Performs the following tasks: Displays the page at the specified index (i.e., Sets the content to that page) Add a back button to the navigation bar if not present and the page is not the first Add a next button to the navigation bar if not present and the page is not the last Add a finish button to the navigation bar if not present and the page is the last Disables the back button if present and the page is the first Remove the next button if present and the page is the last Remove the finish button if present and the page is not the last
void	showPreviousPage() Displays the previous page.
protected void	updateNavigationButtons() Performs logic tests to determine the enable/disable status of the Back/Next buttons
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, 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

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

pages

protected java.util.Collection pages

Constructor Detail

WizardPanel

public WizardPanel()

Creates a panel with a BorderLayout and a navigation bar in the SOUTH region.

Since:

2.0

WizardPanel

public WizardPanel(java.awt.Component page)

Creates a panel with a BorderLayout, a navigation bar in the SOUTH region, and the specified initial page in the CENTER region.

Parameters:

page - The initial page to be displayed.

Since:

2.0

WizardPanel

public WizardPanel(java.util.Collection pages)

Creates a panel with a BorderLayout, a navigation bar in the SOUTH region, and the specified ordered list of pages, initially displaying the first in the CENTER region. The pages will be traversed in order as the next button is activated.

Parameters:

pages - The pages to be displayed..

Since:

2.0

Method Detail

addPage

public int addPage(java.awt.Component page)

Adds the specified page to the end of the current list of pages.

Parameters:

page - The page to add

Since:

2.0

addPage

public void addPage(java.awt.Component page,
                    int index)

Adds the specified page to the current list of pages at the specified index.

Parameters:

page - The page to add

index - The index at which to insert the page

Since:

2.0

createAcceptButton

protected 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

Since:

2.0

createBackButton

protected ButtonWidget createBackButton()

Creates a back button with the following features:

• A default label (as determined by the ToolboxStandards class)
• A default ActionListener that calls showPreviousPage():

Returns:

The back button

Since:

2.0

createNextButton

protected ButtonWidget createNextButton()

Creates a next button with the following features:

• A default label (as determined by the ToolboxStandards class)
• A default ActionListener that calls showNextPage()

Returns:

The next button

Since:

2.0

getBackButton

public ButtonWidget getBackButton()

Returns:

The back button

Since:

2.0

getCurrentPage

public final java.awt.Component getCurrentPage()

Convenience method for DialogPanel.getContent().

Returns:

The currently displayed page

Since:

2.0

getCurrentPageIndex

public int getCurrentPageIndex()

Returns:

The index of the currently displayed page

Since:

2.0

getFinishButton

public final ButtonWidget getFinishButton()

Convenience method for DialogPanel.getAcceptButton().

Returns:

The finish button

Since:

2.0

getNextButton

public final ButtonWidget getNextButton()

Returns:

The next button

Since:

2.0

getPageCount

public int getPageCount()

Since:

2.0

initializeWizardPanel

protected void initializeWizardPanel()

Since:

2.0

removePage

public int removePage(java.awt.Component page)

Remove all internal references to the specified component being removed from the navigation bar.

Parameters:

component - The component being removed (Must not be null)

Since:

2.0

removePage

public java.awt.Component removePage(int index)

Removes the page at the specified index from the current list of pages.

Parameters:

index - The index of the page to remove

Since:

2.0

removePage

protected void removePage(java.awt.Component page,
                          int index)

Since:

2.0

showNextPage

public void showNextPage()

Displays the next page.

Since:

2.0

showPage

public void showPage(int index)

Performs the following tasks:

• Displays the page at the specified index (i.e., Sets the content to that page)
• Add a back button to the navigation bar if not present and the page is not the first
• Add a next button to the navigation bar if not present and the page is not the last
• Add a finish button to the navigation bar if not present and the page is the last
• Disables the back button if present and the page is the first
• Remove the next button if present and the page is the last
• Remove the finish button if present and the page is not the last

Parameters:

index - The index of the page to be displayed

Since:

2.0

showPage

public void showPage(java.awt.Component page)

Performs the following tasks:

• Displays the specified page (i.e., Sets the content to that page)
• Add a back button to the navigation bar if not present and the page is not the first
• Add a next button to the navigation bar if not present and the page is not the last
• Add a finish button to the navigation bar if not present and the page is the last
• Disables the back button if present and the page is the first
• Remove the next button if present and the page is the last
• Remove the finish button if present and the page is not the last

Parameters:

page - The page to be displayed

Since:

2.0

showPage

protected void showPage(java.awt.Component page,
                        int index)

Since:

2.0

showPreviousPage

public void showPreviousPage()

Displays the previous page.

Since:

2.0

updateNavigationButtons

protected void updateNavigationButtons()

Performs logic tests to determine the enable/disable status of the Back/Next buttons

Since:

2.0

windowAdded

public 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:

2.0