com.connectina.lib
Class JWizardPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.connectina.lib.JWizardPanel

All Implemented Interfaces:

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

public class JWizardPanel
extends javax.swing.JPanel

A wizard panel that accomodates a sequence of pages.

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	FINISH Indicates that the wizard can finish.
static int	FINISH_BUTTON The id of the finish button.
static java.lang.String	HOLD Indicates that the wizard should remain to the current page.
static int	NEXT_BUTTON The id of the next button.
static int	PREVIOUS_BUTTON The id of the previous button.

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 java.awt.image.ImageObserver

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

Constructor Summary

JWizardPanel()
Creates a default wizard panel.

Method Summary

void	addChangeListener(javax.swing.event.ChangeListener l) Add a listener of page changes.
void	addControlButton(javax.swing.JButton button, int index) Add a button to the bottom panel of the wizard at the specified position index.
void	addPage(WizardPage page) Adds a page in the wizard dialog.
java.lang.String	getPageName() Gets the currently displayed page name.
java.lang.String	getState() Gets the wizard state.
void	goToPage(java.lang.String pageName) Displays the page with the specified name.
void	removeChangeListener(javax.swing.event.ChangeListener l) Remove a listener of page changes.
void	setButtonImage(int button, javax.swing.ImageIcon icon) Sets the image icon of a wizard button.
void	setButtonMnemonic(int button, char c) Sets the mnemonic of a wizard button.
void	setButtonText(int button, java.lang.String text) Sets the text of a wizard button.

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, setVisible, 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, 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

PREVIOUS_BUTTON

public static final int PREVIOUS_BUTTON

The id of the previous button.

See Also:

Constant Field Values

NEXT_BUTTON

public static final int NEXT_BUTTON

The id of the next button.

See Also:

Constant Field Values

FINISH_BUTTON

public static final int FINISH_BUTTON

The id of the finish button.

See Also:

Constant Field Values

HOLD

public static final java.lang.String HOLD

Indicates that the wizard should remain to the current page.

See Also:

Constant Field Values

FINISH

public static final java.lang.String FINISH

Indicates that the wizard can finish.

See Also:

Constant Field Values

Constructor Detail

JWizardPanel

public JWizardPanel()

Creates a default wizard panel.

Method Detail

addChangeListener

public void addChangeListener(javax.swing.event.ChangeListener l)

Add a listener of page changes.

Parameters:

l - the change listener

removeChangeListener

public void removeChangeListener(javax.swing.event.ChangeListener l)

Remove a listener of page changes.

Parameters:

l - the change listener

addPage

public void addPage(WizardPage page)

Adds a page in the wizard dialog. Pages should be added before the wizard dialog is displayed.

Parameters:

page - a wizard page

setButtonText

public void setButtonText(int button,
                          java.lang.String text)

Sets the text of a wizard button. The button id should be one of PREVIOUS_BUTTON, NEXT_BUTTON or FINISH_BUTTON.

Parameters:

button - a button id

text - the text

setButtonImage

public void setButtonImage(int button,
                           javax.swing.ImageIcon icon)

Sets the image icon of a wizard button. The button id should be one of PREVIOUS_BUTTON, NEXT_BUTTON or FINISH_BUTTON.

Parameters:

button - a button id

icon - the image icon

setButtonMnemonic

public void setButtonMnemonic(int button,
                              char c)

Sets the mnemonic of a wizard button. The button id should be one of PREVIOUS_BUTTON, NEXT_BUTTON or FINISH_BUTTON.

Parameters:

button - a button id

c - the mnemonic character

goToPage

public void goToPage(java.lang.String pageName)

Displays the page with the specified name.

Parameters:

name - the page name

getPageName

public java.lang.String getPageName()

Gets the currently displayed page name.

Returns:

a page name

getState

public java.lang.String getState()

Gets the wizard state.

Returns:

the state

addControlButton

public void addControlButton(javax.swing.JButton button,
                             int index)

Add a button to the bottom panel of the wizard at the specified position index. The first button has a position index of 0. (e.g. a button added with an index 0 would appear before the previous button)

Parameters:

button - the button

index - the position index.