org.progeeks.meta.swing.wizard
Class MetaWizardDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      org.progeeks.meta.swing.wizard.MetaWizardDialog

All Implemented Interfaces:

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

public class MetaWizardDialog
extends javax.swing.JDialog

A wizard dialog with a series of panels as pages that can be accessed with next/back buttons. Each page configuation can contain an evaluator that determines whether or not the wizard can move to the next page, and which page it should move to. Each page also has a text field that will appear to the left of the property panel.

Version:

$Revision: 1.8 $

Author:

Paul Speed

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

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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

static int	BUTTON_CANCEL
static int	BUTTON_FINISH
static int	BUTTON_NEXT
static int	BUTTON_PREVIOUS
static int	NOT_BUTTON_CANCEL
static int	NOT_BUTTON_FINISH
static int	NOT_BUTTON_NEXT
static int	NOT_BUTTON_PREVIOUS

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

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

MetaWizardDialog(javax.swing.JFrame owner, java.lang.String title, boolean modal)
Creates an empty MetaWizardDialog with the specified title and modality.

MetaWizardDialog(javax.swing.JFrame owner, java.lang.String title, boolean modal, FactoryRegistry factories)
Creates an empty MetaWizardPanel with the specified title and modality.

Method Summary

void	addPage(PageConfiguration page) Adds a new page to this wizard.
void	addPage(PageConfiguration page, MetaObject object) Adds a new page to this wizard and sets the specified meta-object to it.
protected javax.swing.JPanel	createButtonPanel()
protected javax.swing.JPanel	createMainPanel()
int	getCurrentPage()
FactoryRegistry	getFactoryRegistry()
MetaObject	getMetaObject(int pageIndex) Returns the current meta-object associated with the specified page.
protected org.progeeks.meta.swing.wizard.MetaWizardDialog.Page	getPage(int index) Returns the page at the specified index.
void	insertPage(PageConfiguration pageConfig, int index) Inserts a page at the specified insertion point.
void	insertPage(PageConfiguration pageConfig, MetaObject object, int index) Inserts a page at the specified insertion point and associates the specified meta-object with it.
boolean	isCanceled() Returns true if the wizard dialog was canceled.
protected void	resetButtonStates()
protected void	setButtonFlags(int flags)
void	setCurrentPage(int index)
void	setFactoryRegistry(FactoryRegistry factories)
void	setMetaObject(int pageIndex, MetaObject object) Sets a new meta-object for the specified page and updates its panel accordingly.
void	setMetaObject(MetaObject object) Sets a new meta-object and updates the pages accordingly.
protected void	setupDefaultButtonFlags() Sets the default button flags based on the current page index.
void	show()

Methods inherited from class javax.swing.JDialog

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

Methods inherited from class java.awt.Dialog

addNotify, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, toBack, 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, removeNotify, 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, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

BUTTON_PREVIOUS

public static final int BUTTON_PREVIOUS

See Also:

Constant Field Values

BUTTON_NEXT

public static final int BUTTON_NEXT

See Also:

Constant Field Values

BUTTON_FINISH

public static final int BUTTON_FINISH

See Also:

Constant Field Values

BUTTON_CANCEL

public static final int BUTTON_CANCEL

See Also:

Constant Field Values

NOT_BUTTON_PREVIOUS

public static final int NOT_BUTTON_PREVIOUS

See Also:

Constant Field Values

NOT_BUTTON_NEXT

public static final int NOT_BUTTON_NEXT

See Also:

Constant Field Values

NOT_BUTTON_FINISH

public static final int NOT_BUTTON_FINISH

See Also:

Constant Field Values

NOT_BUTTON_CANCEL

public static final int NOT_BUTTON_CANCEL

See Also:

Constant Field Values

Constructor Detail

MetaWizardDialog

public MetaWizardDialog(javax.swing.JFrame owner,
                        java.lang.String title,
                        boolean modal)

Creates an empty MetaWizardDialog with the specified title and modality.

MetaWizardDialog

public MetaWizardDialog(javax.swing.JFrame owner,
                        java.lang.String title,
                        boolean modal,
                        FactoryRegistry factories)

Creates an empty MetaWizardPanel with the specified title and modality.

Method Detail

isCanceled

public boolean isCanceled()

Returns true if the wizard dialog was canceled.

show

public void show()

Overrides:

show in class java.awt.Dialog

createMainPanel

protected javax.swing.JPanel createMainPanel()

createButtonPanel

protected javax.swing.JPanel createButtonPanel()

setFactoryRegistry

public void setFactoryRegistry(FactoryRegistry factories)

getFactoryRegistry

public FactoryRegistry getFactoryRegistry()

setMetaObject

public void setMetaObject(MetaObject object)

Sets a new meta-object and updates the pages accordingly. This will set the specified meta-object for every page.

setMetaObject

public void setMetaObject(int pageIndex,
                          MetaObject object)

Sets a new meta-object for the specified page and updates its panel accordingly.

getMetaObject

public MetaObject getMetaObject(int pageIndex)

Returns the current meta-object associated with the specified page.

addPage

public void addPage(PageConfiguration page)

Adds a new page to this wizard.

addPage

public void addPage(PageConfiguration page,
                    MetaObject object)

Adds a new page to this wizard and sets the specified meta-object to it.

insertPage

public void insertPage(PageConfiguration pageConfig,
                       int index)

Inserts a page at the specified insertion point.

insertPage

public void insertPage(PageConfiguration pageConfig,
                       MetaObject object,
                       int index)

Inserts a page at the specified insertion point and associates the specified meta-object with it.

setupDefaultButtonFlags

protected void setupDefaultButtonFlags()

Sets the default button flags based on the current page index.

setCurrentPage

public void setCurrentPage(int index)

getCurrentPage

public int getCurrentPage()

getPage

protected org.progeeks.meta.swing.wizard.MetaWizardDialog.Page getPage(int index)

Returns the page at the specified index. More of a convenience method that avoids casting.

setButtonFlags

protected void setButtonFlags(int flags)

resetButtonStates

protected void resetButtonStates()