com.connectina.lib
Class JWizardDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      com.connectina.lib.JWizardDialog

All Implemented Interfaces:

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

public class JWizardDialog
extends javax.swing.JDialog

A wizard dialog that accomodates a sequence of pages.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JDialog.AccessibleJDialog

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

java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

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

java.awt.Window.AccessibleAWTWindow

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

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

JWizardDialog()
Creates a default wizard dialog.

JWizardDialog(javax.swing.JFrame parent)
Creates a default wizard dialog with the specified parent frame.

JWizardDialog(javax.swing.JFrame parent, boolean modal)
Creates a default wizard dialog with the specified parent frame and modality mode.

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 name) Displays the page with the specified index.
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.
void	setVisible(boolean visible) Display the wizard dialog.

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setModalityType, setResizable, setTitle, setUndecorated, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

JWizardDialog

public JWizardDialog()

Creates a default wizard dialog.

JWizardDialog

public JWizardDialog(javax.swing.JFrame parent)

Creates a default wizard dialog with the specified parent frame.

Parameters:

parent - the parent frame

JWizardDialog

public JWizardDialog(javax.swing.JFrame parent,
                     boolean modal)

Creates a default wizard dialog with the specified parent frame and modality mode.

Parameters:

parent - the parent frame

modal - the modality mode

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 name)

Displays the page with the specified index. Note that the first wizard page starts at 0.

Parameters:

name - the unique page name

getPageName

public java.lang.String getPageName()

Gets the currently displayed page name.

Returns:

a page name

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.

getState

public java.lang.String getState()

Gets the wizard state.

Returns:

the state

setVisible

public void setVisible(boolean visible)

Display the wizard dialog.

Overrides:

setVisible in class java.awt.Dialog

Parameters:

visible -