org.geotools.swing.wizard

Class JWizard

Object

Component

Container

Window

Dialog

JDialog

JWizard

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

Direct Known Subclasses:

JDataStoreWizard, JParameterListWizard, JProcessWizard

public class JWizard
extends JDialog

Swing does not provide a wizard construct (boo hiss) so this is a quick dialog that can step us through a series of pages.

This code is based on Creating Wizard Dialogs with Java.

Author:

Jody, gdavis

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JWizard.Controller The controller listens to everything and updates the buttons

Nested classes/interfaces inherited from class JDialog

JDialog.AccessibleJDialog

Nested classes/interfaces inherited from class Dialog

Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType

Nested classes/interfaces inherited from class Window

Window.AccessibleAWTWindow, Window.Type

Nested classes/interfaces inherited from class Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static int	CANCEL Indicates that the 'Cancel' button was pressed to close the dialog, or the user pressed the close box in the corner of the window.
static int	ERROR Indicates that the dialog closed due to an internal error.
static int	FINISH Indicates that the 'Finish' button was pressed to close the dialog.

Fields inherited from class JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
JWizard(Dialog owner, String title)
JWizard(String title)

Method Summary

Modifier and Type	Method and Description
protected void	close(int code) Closes the dialog and sets the return code to the integer parameter.
JWizard.Controller	getController() The controller can be hooked up to your own fields or lists; it will call syncWizardButtons() which will use validate to update the buttons in response to user input.
int	getReturnCode() Retrieves the last return code set by the dialog.
Boolean	isBackEnabled()
Boolean	isCancelEnabled()
Boolean	isNextEnabled()
void	registerWizardPanel(JPage page) Registers the page with this JWizard.
void	setBackEnabled(Boolean isEnabled)
void	setCancelEnabled(Boolean isEnabled)
void	setCurrentPanel(String id) Called to display a page.
void	setFinishEnabled(Boolean isEnabled)
void	setNextEnabled(Boolean isEnabled)
int	showModalDialog() Convenience method that displays a modal wizard dialog and blocks until the dialog has completed.
void	windowClosing(WindowEvent e)

Methods inherited from class 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 Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack

Methods inherited from class 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 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 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 Object

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

Field Detail

FINISH

public static final int FINISH

Indicates that the 'Finish' button was pressed to close the dialog.

See Also:

Constant Field Values

CANCEL

public static final int CANCEL

Indicates that the 'Cancel' button was pressed to close the dialog, or the user pressed the close box in the corner of the window.

See Also:

Constant Field Values

ERROR

public static final int ERROR

Indicates that the dialog closed due to an internal error.

See Also:

Constant Field Values

Constructor Detail

JWizard

public JWizard(String title)
        throws HeadlessException

Throws:

HeadlessException

JWizard

public JWizard(Dialog owner,
               String title)
        throws HeadlessException

Throws:

HeadlessException

Method Detail

isCancelEnabled

public Boolean isCancelEnabled()

setCancelEnabled

public void setCancelEnabled(Boolean isEnabled)

isNextEnabled

public Boolean isNextEnabled()

setNextEnabled

public void setNextEnabled(Boolean isEnabled)

setFinishEnabled

public void setFinishEnabled(Boolean isEnabled)

isBackEnabled

public Boolean isBackEnabled()

setBackEnabled

public void setBackEnabled(Boolean isEnabled)

close

protected void close(int code)

Closes the dialog and sets the return code to the integer parameter.

Parameters:

code - The return code.

windowClosing

public void windowClosing(WindowEvent e)

getReturnCode

public int getReturnCode()

Retrieves the last return code set by the dialog.

Returns:

An integer that identifies how the dialog was closed. See the *_RETURN_CODE constants of this class for possible values.

showModalDialog

public int showModalDialog()

Convenience method that displays a modal wizard dialog and blocks until the dialog has completed.

Returns:

Indicates how the dialog was closed one of CANCEL, ERROR, FINISH

setCurrentPanel

public void setCurrentPanel(String id)

Called to display a page.

registerWizardPanel

public void registerWizardPanel(JPage page)

Registers the page with this JWizard. The page is stored by its identifier (so other pages can look it up). The page.setJWizard() method is also called so the page can refer to its containing wizard at runtime.

getController

public JWizard.Controller getController()

The controller can be hooked up to your own fields or lists; it will call syncWizardButtons() which will use validate to update the buttons in response to user input.

Returns:

Controller