com.quadrique.jbuildingblocks.gui
Class Wizard

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      com.quadrique.jbuildingblocks.gui.Dlg
                          com.quadrique.jbuildingblocks.gui.Wizard

All Implemented Interfaces:

ButtonAreaListener, ComponentListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants

public class Wizard
extends Dlg

This class implements a dialog wizard

Author:

Hervé Rivere

See Also:

Dlg, Serialized Form

Nested Class Summary

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

Dialog.ModalExclusionType, Dialog.ModalityType

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

Component.BaselineResizeBehavior

Field Summary

static int	WIZARD_BACK constants
static int	WIZARD_CANCEL
static int	WIZARD_FINISH
static int	WIZARD_HELP
static int	WIZARD_NEXT

Fields inherited from class com.quadrique.jbuildingblocks.gui.Dlg

RETURN_VALUE_IS_DLG_WINDOW_CLOSED

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

Wizard(Component zParentComponent, String zTitle, String zIconName)
constructor

Method Summary

void	addPage(WizardPage zPage)
void	enableBackButton(boolean zIsEnabled)
void	enableButtons(boolean zBackIsEnabled, boolean zNextIsEnabled, boolean zFinishIsEnabled) to enable/disable the buttons in one shot
void	enableFinishButton(boolean zIsEnabled)
void	enableNextButton(boolean zIsEnabled)
void	finishWizard() to terminate and releaseConnection the wizard
int	getNbOfPages()
void	setCancelButtonVisible(boolean zIsVisible)
void	setFinishButtonVisible(boolean zIsVisible)
void	setHelpButtonVisible(boolean zIsVisible)
void	setLeftComponent(JComponent zComponent) use this method to set your own left component (as opposed to a plain icon)
void	setNextButtonVisible(boolean zIsVisible)
void	setPreviousButtonVisible(boolean zIsVisible)

Methods inherited from class com.quadrique.jbuildingblocks.gui.Dlg

addButton, addButton, addCenterComponent, addEmptySpaceInButtonArea, addHelpButton, buttonSelected, closeDialog, componentHidden, componentMoved, componentResized, componentShown, getButtonArea, getDialog, getReturnValue, setButtonAreaIsVisible, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened

Methods inherited from class javax.swing.JDialog

getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setModalityType, setResizable, setTitle, setUndecorated, setVisible, 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, 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, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, 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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

WIZARD_BACK

public static final int WIZARD_BACK

constants

See Also:

Constant Field Values

WIZARD_NEXT

public static final int WIZARD_NEXT

See Also:

Constant Field Values

WIZARD_FINISH

public static final int WIZARD_FINISH

See Also:

Constant Field Values

WIZARD_CANCEL

public static final int WIZARD_CANCEL

See Also:

Constant Field Values

WIZARD_HELP

public static final int WIZARD_HELP

See Also:

Constant Field Values

Constructor Detail

Wizard

public Wizard(Component zParentComponent,
              String zTitle,
              String zIconName)

constructor

Parameters:

zParentComponent - the parent component i.e. the wizard will be centered above that component

zTitle - the title of the wizard window

zIconName - the icon to use for the wizard

See Also:

Dlg

Method Detail

addPage

public void addPage(WizardPage zPage)
             throws Exception

Parameters:

zPage - a WizardPage instance

Throws:

Exception - if an exception occurs

enableBackButton

public void enableBackButton(boolean zIsEnabled)

Parameters:

zIsEnabled - true if the "Back" button is to be enabled

enableNextButton

public void enableNextButton(boolean zIsEnabled)

Parameters:

zIsEnabled - true if the "Next" button is to be enabled

enableFinishButton

public void enableFinishButton(boolean zIsEnabled)

Parameters:

zIsEnabled - true if the "Finish" button is to be enabled

enableButtons

public void enableButtons(boolean zBackIsEnabled,
                          boolean zNextIsEnabled,
                          boolean zFinishIsEnabled)

to enable/disable the buttons in one shot

Parameters:

zBackIsEnabled - true if the "Back" button is to be enabled

zNextIsEnabled - true if the "Next" button is to be enabled

zFinishIsEnabled - true if the "Finish" button is to be enabled

setLeftComponent

public void setLeftComponent(JComponent zComponent)

use this method to set your own left component (as opposed to a plain icon)

Parameters:

zComponent - the component

getNbOfPages

public int getNbOfPages()

Returns:

the current number of pages in this wizard

finishWizard

public void finishWizard()

to terminate and releaseConnection the wizard

setHelpButtonVisible

public void setHelpButtonVisible(boolean zIsVisible)

Parameters:

zIsVisible -

setCancelButtonVisible

public void setCancelButtonVisible(boolean zIsVisible)

Parameters:

zIsVisible -

setFinishButtonVisible

public void setFinishButtonVisible(boolean zIsVisible)

Parameters:

zIsVisible -

setNextButtonVisible

public void setNextButtonVisible(boolean zIsVisible)

Parameters:

zIsVisible -

setPreviousButtonVisible

public void setPreviousButtonVisible(boolean zIsVisible)

Parameters:

zIsVisible -