com.portal.app.comp

Class PWizard

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.portal.app.comp.PWizard

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

PValidatingWizard

public class PWizard
extends JPanel

An Portal-aware wizard framework hosted in a dialog. An optional navigator is provided as a means of randomly moving between pages of the wizard.

See Also:

Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CANCEL The property issued for cancelling the wizard
static int	CANCEL_OPTION Return value if Cancel is chosen
protected static String	FINISH The property issued when finishing wizard processing
static int	FINISH_OPTION Return value if Finish is chosen
protected static String	HELP The property issued for showing help
protected static String	PAGE_SWITCH The property issued when a page changes

Fields inherited from class javax.swing.JComponent

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

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
PWizard() Create an instance of the wizard with no owner that is modeless and which contains a navigator
PWizard(JFrame owner, boolean modal, boolean useNavigator) Creates an instance of the wizard with the specified owner that is optionally modeless and which optionally contains a navigator

Method Summary

Modifier and Type	Method and Description
void	addButtonPanelElement(Component comp, int gap) Inserts an element into the wizard button panel just to the left of the "Back" button.
protected void	addCancelListener(PropertyChangeListener p) Registers the given listener so that it receives a CANCEL PropertyChangeEvent event when a cancel has occurred
protected void	addCancelVetoableListener(VetoableChangeListener v) Registers the given listener so that it receives a CANCEL VetoableChangeEvent before a cancel occurs
protected void	addFinishListener(PropertyChangeListener p) Registers the given listener so that it receives a FINISH PropertyChangeEvent event when a finish has occurred
protected void	addFinishVetoableListener(VetoableChangeListener v) Registers the given listener so that it receives a FINISH VetoableChangeEvent before a finish occurs
protected void	addHelpListener(PropertyChangeListener p) Registers the given listener so that it receives a HELP PropertyChangeEvent event when a cancel has occurred
void	addNotify()
void	addPage(Component page) Adds a page to the wizard
protected void	addPageSwitchListener(PropertyChangeListener p) Registers the given listener so that it receives a PAGE_SWITCH PropertyChangeEvent event when a page switch has occurred.
protected void	addPageSwitchVetoableListener(VetoableChangeListener v) Registers the given listener so that it receives a PAGE_SWITCH VetoableChangeEvent before a page switch occurs.
Component	getPageAt(int i) For the given index, retrieves the associated page
int	getPageCount() Returns the total number of pages in the wizard
Component	getVisiblePage() Retrieves the currently visible page
int	getVisiblePageIndex() Retrieves the index of the currently visible page
JDialog	getWizardDialog() Returns the wizard dialog
int	pageToIndex(Component c) For the given page, retrieves the associated index.
void	processBack() Moves to the previous page in the wizard.
void	processCancel() Cancels wizard processing.
void	processFinish() Finishes wizard processing.
void	processHelp(ActionEvent e) Displays wizard help.
void	processNext() Moves to the next visible page in the wizard.
protected void	removeCancelCommand() Removes the visual cancel command (button) from the wizard
protected void	removeCancelListener(PropertyChangeListener p) Removes the PropertyChangeListener for the CANCEL property
protected void	removeCancelVetoableListener(VetoableChangeListener v) Removes the VetoableChangeListener for the CANCEL property
protected void	removeFinishCommand() Removes the visual cancel command (button) from the wizard
protected void	removeFinishListener(PropertyChangeListener p) Removes the PropertyChangeListener for the FINISH property
protected void	removeFinishVetoableListener(VetoableChangeListener v) Removes the VetoableChangeListener for the FINISH property
protected void	removeHelpCommand() Removes the visual help command (button) from the wizard
protected void	removeHelpListener(PropertyChangeListener p) Removes the PropertyChangeListener for the HELP property
void	removeNotify()
protected void	removePageSwitchListener(PropertyChangeListener p) Removes the PropertyChangeListener for the PAGE_SWITCH property.
protected void	removePageSwitchVetoableListener(VetoableChangeListener v) Removes the VetoableChangeListener for the PAGE_SWITCH property
void	setFinishButtonEnabled(boolean b) Gives the user control over the finish button
void	setPageEnabled(Component p, boolean b) Enables or disables the passed-in page and its navigator button if the navigator is present.
void	setVisible(boolean b) Shows or hides the wizard dialog.
void	setVisiblePage(int index) Switches to the page at the specified index.
int	showWizard() Shows the dialog containing the wizard panel.
void	showWizardPage(int index, boolean force) Switches the wizard to the page having the passed-in index.
void	showWizardPage(String page, boolean force) Switches the wizard to the passed-in page.
void	updateWizardControls() Updates the wizard controls

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, 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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, 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, setLayout, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

CANCEL_OPTION

public static final int CANCEL_OPTION

Return value if Cancel is chosen

See Also:

Constant Field Values

FINISH_OPTION

public static final int FINISH_OPTION

Return value if Finish is chosen

See Also:

Constant Field Values

HELP

protected static final String HELP

The property issued for showing help

See Also:

Constant Field Values

PAGE_SWITCH

protected static final String PAGE_SWITCH

The property issued when a page changes

See Also:

Constant Field Values

CANCEL

protected static final String CANCEL

The property issued for cancelling the wizard

See Also:

Constant Field Values

FINISH

protected static final String FINISH

The property issued when finishing wizard processing

See Also:

Constant Field Values

Constructor Detail

PWizard

public PWizard()

Create an instance of the wizard with no owner that is modeless and which contains a navigator

PWizard

public PWizard(JFrame owner,
               boolean modal,
               boolean useNavigator)

Creates an instance of the wizard with the specified owner that is optionally modeless and which optionally contains a navigator

Parameters:

owner - the Frame that owns the wizard

modal - true for a modal wizard; false for one that allows others windows to be active at the same time

useNavigator - true for the wizard to contain a navigator allowing for random page selection; false otherwise

Method Detail

showWizard

public int showWizard()

Shows the dialog containing the wizard panel.

Returns:

FINISH_OPTION if exiting after the Finish button was pressed or CANCEL_OPTION if exiting after the Cancel button was pressed.

addNotify

public void addNotify()

Overrides:

addNotify in class JComponent

removeNotify

public void removeNotify()

Overrides:

removeNotify in class JComponent

getWizardDialog

public JDialog getWizardDialog()

Returns the wizard dialog

Returns:

The dialog hosting the wizard panel

setFinishButtonEnabled

public void setFinishButtonEnabled(boolean b)

Gives the user control over the finish button

Parameters:

b - Sets the enabled state of the finish button

setVisible

public void setVisible(boolean b)

Shows or hides the wizard dialog.

Overrides:

setVisible in class JComponent

Parameters:

b - If true, shows the dialog; otherwise, hides it.

removeHelpCommand

protected void removeHelpCommand()

Removes the visual help command (button) from the wizard

removeCancelCommand

protected void removeCancelCommand()

Removes the visual cancel command (button) from the wizard

removeFinishCommand

protected void removeFinishCommand()

Removes the visual cancel command (button) from the wizard

addButtonPanelElement

public void addButtonPanelElement(Component comp,
                                  int gap)

Inserts an element into the wizard button panel just to the left of the "Back" button.

Parameters:

comp - Element to add to the left of the "Back" button.

gap - Padding to separate the new element from the "Back" button.

addPage

public void addPage(Component page)

Adds a page to the wizard

Parameters:

page - Page to add to the wizard

setVisiblePage

public void setVisiblePage(int index)

Switches to the page at the specified index. If the index is out of bounds, nothing happens.

Parameters:

index - The index of the page to display.

processNext

public void processNext()

Moves to the next visible page in the wizard. Fires a vetoable change event before attempting the page change. If it's not vetoed, a property change event is fired. Local vetoable change and property change support is used. The property used is PAGE_SWITCH.

See Also:

addPageSwitchListener(java.beans.PropertyChangeListener), addPageSwitchVetoableListener(java.beans.VetoableChangeListener)

processBack

public void processBack()

Moves to the previous page in the wizard. Fires a vetoable change event before attempting the page change. If it's not vetoed, a property change event is fired. Local vetoable change and property change support is used. The property used is PAGE_SWITCH.

See Also:

addPageSwitchListener(java.beans.PropertyChangeListener), addPageSwitchVetoableListener(java.beans.VetoableChangeListener)

showWizardPage

public void showWizardPage(String page,
                           boolean force)

Switches the wizard to the passed-in page. Fires a vetoable change event before attempting the page change. If it's not vetoed, a property change event is fired. Local vetoable change and property change support is used. The property used is PAGE_SWITCH.

Parameters:

page - Name of page to switch to

force - true to force a redisplay even if the page hasn't changed; false otherwise.

See Also:

showWizardPage(int, boolean)

showWizardPage

public void showWizardPage(int index,
                           boolean force)

Switches the wizard to the page having the passed-in index. Fires a vetoable change event before attempting the page change. If it's not vetoed, a property change event is fired. Local vetoable change and property change support is used. The property used is PAGE_SWITCH.

Parameters:

index - Index of page to switch to

force - true to force a redisplay even if the page hasn't changed; false otherwise

See Also:

addPageSwitchListener(java.beans.PropertyChangeListener), addPageSwitchVetoableListener(java.beans.VetoableChangeListener)

setPageEnabled

public void setPageEnabled(Component p,
                           boolean b)

Enables or disables the passed-in page and its navigator button if the navigator is present. Does nothing if p is the currently selected page.

Parameters:

p - The page whose button is to be enabled or disabled.

b - true to attempt to enable the page and button; false to attempt to disable them.

processFinish

public void processFinish()

Finishes wizard processing. Fires a vetoable change event and if it's not vetoed, a property change event is then fired. Local vetoable change and property change support is used. The property used is FINISH.

See Also:

addFinishListener(java.beans.PropertyChangeListener), addFinishVetoableListener(java.beans.VetoableChangeListener)

processCancel

public void processCancel()

Cancels wizard processing. Fires a vetoable change event and if it's not vetoed, a property change event is then fired. Local vetoable change and property change support is used. The property used is CANCEL.

See Also:

addCancelListener(java.beans.PropertyChangeListener), addCancelVetoableListener(java.beans.VetoableChangeListener)

processHelp

public void processHelp(ActionEvent e)

Displays wizard help.

getPageCount

public int getPageCount()

Returns the total number of pages in the wizard

getPageAt

public Component getPageAt(int i)

For the given index, retrieves the associated page

Parameters:

i - The index to look up

Returns:

The component found or null if not found

pageToIndex

public int pageToIndex(Component c)

For the given page, retrieves the associated index.

Parameters:

c - The page to look up

Returns:

The index of the page found or -1 if not found

getVisiblePage

public Component getVisiblePage()

Retrieves the currently visible page

Returns:

The component found or null if not found

getVisiblePageIndex

public int getVisiblePageIndex()

Retrieves the index of the currently visible page

Returns:

The index of the currently visible page

updateWizardControls

public void updateWizardControls()

Updates the wizard controls

addPageSwitchListener

protected void addPageSwitchListener(PropertyChangeListener p)

Registers the given listener so that it receives a PAGE_SWITCH PropertyChangeEvent event when a page switch has occurred.

Parameters:

p - The listener

removePageSwitchListener

protected void removePageSwitchListener(PropertyChangeListener p)

Removes the PropertyChangeListener for the PAGE_SWITCH property.

Parameters:

p - The listener

addPageSwitchVetoableListener

protected void addPageSwitchVetoableListener(VetoableChangeListener v)

Registers the given listener so that it receives a PAGE_SWITCH VetoableChangeEvent before a page switch occurs.

Parameters:

v - The VetoableChangeListener

removePageSwitchVetoableListener

protected void removePageSwitchVetoableListener(VetoableChangeListener v)

Removes the VetoableChangeListener for the PAGE_SWITCH property

Parameters:

v - The listener

addCancelListener

protected void addCancelListener(PropertyChangeListener p)

Registers the given listener so that it receives a CANCEL PropertyChangeEvent event when a cancel has occurred

Parameters:

p - The listener

removeCancelListener

protected void removeCancelListener(PropertyChangeListener p)

Removes the PropertyChangeListener for the CANCEL property

Parameters:

p - The listener

addCancelVetoableListener

protected void addCancelVetoableListener(VetoableChangeListener v)

Registers the given listener so that it receives a CANCEL VetoableChangeEvent before a cancel occurs

Parameters:

v - The VetoableChangeListener

removeCancelVetoableListener

protected void removeCancelVetoableListener(VetoableChangeListener v)

Removes the VetoableChangeListener for the CANCEL property

Parameters:

v - The listener

addFinishListener

protected void addFinishListener(PropertyChangeListener p)

Registers the given listener so that it receives a FINISH PropertyChangeEvent event when a finish has occurred

Parameters:

p - The listener

removeFinishListener

protected void removeFinishListener(PropertyChangeListener p)

Removes the PropertyChangeListener for the FINISH property

Parameters:

p - The listener

addFinishVetoableListener

protected void addFinishVetoableListener(VetoableChangeListener v)

Registers the given listener so that it receives a FINISH VetoableChangeEvent before a finish occurs

Parameters:

v - The VetoableChangeListener

removeFinishVetoableListener

protected void removeFinishVetoableListener(VetoableChangeListener v)

Removes the VetoableChangeListener for the FINISH property

Parameters:

v - The listener

addHelpListener

protected void addHelpListener(PropertyChangeListener p)

Registers the given listener so that it receives a HELP PropertyChangeEvent event when a cancel has occurred

Parameters:

p - The listener

removeHelpListener

protected void removeHelpListener(PropertyChangeListener p)

Removes the PropertyChangeListener for the HELP property

Parameters:

p - The listener