com.xmlmind.guiutil

Class Wizard

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

com.xmlmind.guiutil.Wizard

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants

public abstract class Wizard
extends JDialog
implements ActionListener

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Wizard.Screen
static class	Wizard.Status

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

JDialog.AccessibleJDialog

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

Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType

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

Window.AccessibleAWTWindow, Window.Type

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 Component	parentComponent
protected static int	STYLE_COMPACT
protected static int	STYLE_HELP_BUTTON

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

Constructors

Modifier	Constructor and Description
protected	Wizard(Component parentComponent)
protected	Wizard(Component parentComponent, String title)
protected	Wizard(Component parentComponent, String title, int style)

Method Summary

Modifier and Type	Method and Description
protected abstract void	abortTask()
void	actionPerformed(ActionEvent event)
protected abstract void	addAllScreens()
protected boolean	addScreen(int index, Wizard.Screen screen)
protected boolean	addScreen(Wizard.Screen screen)
void	backButtonClicked()
void	cancelButtonClicked()
protected abstract void	closingWizard(Wizard.Status status)
protected Wizard.Screen[]	getAllScreens()
Color	getHeaderBackground()
Icon	getHeaderDefaultIcon()
String	getHeaderDefaultTitle()
Font	getHeaderFont()
Color	getHeaderForeground()
protected Wizard.Screen	getScreen(int index)
protected int	getScreenCount()
void	helpButtonClicked()
protected int	indexOfScreen(Wizard.Screen screen)
protected void	initialize(int style)
protected static JComponent	multiLineText(String text)
protected static JComponent	multiLineText(String text, Font font, Color foreground, Color background)
void	nextButtonClicked()
protected abstract String	performButtonText()
protected abstract Wizard.Status	performTask()
protected Wizard.Screen	removeScreen(int index)
protected boolean	removeScreen(Wizard.Screen screen)
void	setHeaderBackground(Color background)
void	setHeaderDefaultIcon(Icon icon)
void	setHeaderDefaultTitle(String title)
void	setHeaderFont(Font font)
void	setHeaderForeground(Color foreground)
protected abstract void	showingScreen(int current, int previous)
Wizard.Status	start()
protected abstract int	whichNextScreen(int current)

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, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, 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, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, 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, 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, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, 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

STYLE_COMPACT

protected static final int STYLE_COMPACT

See Also:

Constant Field Values

STYLE_HELP_BUTTON

protected static final int STYLE_HELP_BUTTON

See Also:

Constant Field Values

parentComponent

protected Component parentComponent

Constructor Detail

Wizard

protected Wizard(Component parentComponent,
                 String title)

Wizard

protected Wizard(Component parentComponent,
                 String title,
                 int style)

Wizard

protected Wizard(Component parentComponent)

Method Detail

initialize

protected void initialize(int style)

actionPerformed

public void actionPerformed(ActionEvent event)

Specified by:

actionPerformed in interface ActionListener

helpButtonClicked

public void helpButtonClicked()

backButtonClicked

public void backButtonClicked()

nextButtonClicked

public void nextButtonClicked()

cancelButtonClicked

public void cancelButtonClicked()

addScreen

protected boolean addScreen(Wizard.Screen screen)

addScreen

protected boolean addScreen(int index,
                            Wizard.Screen screen)

removeScreen

protected boolean removeScreen(Wizard.Screen screen)

indexOfScreen

protected int indexOfScreen(Wizard.Screen screen)

removeScreen

protected Wizard.Screen removeScreen(int index)

getAllScreens

protected Wizard.Screen[] getAllScreens()

getScreenCount

protected int getScreenCount()

getScreen

protected Wizard.Screen getScreen(int index)

setHeaderDefaultIcon

public void setHeaderDefaultIcon(Icon icon)

getHeaderDefaultIcon

public Icon getHeaderDefaultIcon()

setHeaderDefaultTitle

public void setHeaderDefaultTitle(String title)

getHeaderDefaultTitle

public String getHeaderDefaultTitle()

setHeaderFont

public void setHeaderFont(Font font)

getHeaderFont

public Font getHeaderFont()

setHeaderForeground

public void setHeaderForeground(Color foreground)

getHeaderForeground

public Color getHeaderForeground()

setHeaderBackground

public void setHeaderBackground(Color background)

getHeaderBackground

public Color getHeaderBackground()

multiLineText

protected static final JComponent multiLineText(String text)

multiLineText

protected static final JComponent multiLineText(String text,
                                                Font font,
                                                Color foreground,
                                                Color background)

addAllScreens

protected abstract void addAllScreens()

whichNextScreen

protected abstract int whichNextScreen(int current)

showingScreen

protected abstract void showingScreen(int current,
                                      int previous)

performButtonText

protected abstract String performButtonText()

performTask

protected abstract Wizard.Status performTask()

abortTask

protected abstract void abortTask()

closingWizard

protected abstract void closingWizard(Wizard.Status status)

start

public Wizard.Status start()