baseCode.gui
Class Wizard

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      baseCode.gui.Wizard

All Implemented Interfaces:

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

public abstract class Wizard

extends javax.swing.JDialog

Copyright (c) 2004-2005 Columbia University

Version:

$Id: Wizard.java,v 1.10 2005/03/21 18:01:03 pavlidis Exp $

Author:

pavlidis, Homin Lee

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JDialog

javax.swing.JDialog.AccessibleJDialog

Nested classes inherited from class java.awt.Dialog

java.awt.Dialog.AccessibleAWTDialog

Nested classes inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected javax.swing.JButton	backButton
protected javax.swing.JPanel	BottomPanel
protected javax.swing.JPanel	BottomPanelWrap
protected javax.swing.JFrame	callingframe
protected javax.swing.JButton	cancelButton
protected javax.swing.JButton	finishButton
protected java.awt.FlowLayout	flowlayout1
protected javax.swing.JLabel	jLabelStatus
protected javax.swing.JPanel	jPanelStatus
protected javax.swing.JPanel	mainPanel
protected javax.swing.JButton	nextButton

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

Wizard(javax.swing.JFrame callingframe, int width, int height)

Method Summary

protected void	addStep(int step, WizardStep panel)
protected abstract void	backButton_actionPerformed(java.awt.event.ActionEvent e) Define what happens when the 'back' button is pressed
protected abstract void	cancelButton_actionPerformed(java.awt.event.ActionEvent e) Define what happens when the 'cancel' button is pressed.
void	clearStatus() Make the status bar empty.
protected abstract void	finishButton_actionPerformed(java.awt.event.ActionEvent e) Define what happens when the 'finish' button is pressed.
protected abstract void	nextButton_actionPerformed(java.awt.event.ActionEvent e) Define what happens when the 'next' button is pressed
void	setFinishDisabled() Disable the "finish" button, indicating the user has some steps to do yet.
void	setFinishEnabled() Enable the "finish" button, indicating the user can get out of the wizard at this stage.
void	showError(java.lang.String a) Print an error message to the status bar.
void	showStatus(java.lang.String a) Print a message to the status bar.
void	showWizard()

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, dispose, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, 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, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, 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, 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, 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, isOpaque, 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, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, 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

mainPanel

protected javax.swing.JPanel mainPanel

flowlayout1

protected java.awt.FlowLayout flowlayout1

BottomPanel

protected javax.swing.JPanel BottomPanel

BottomPanelWrap

protected javax.swing.JPanel BottomPanelWrap

jLabelStatus

protected javax.swing.JLabel jLabelStatus

jPanelStatus

protected javax.swing.JPanel jPanelStatus

nextButton

protected javax.swing.JButton nextButton

backButton

protected javax.swing.JButton backButton

cancelButton

protected javax.swing.JButton cancelButton

finishButton

protected javax.swing.JButton finishButton

callingframe

protected javax.swing.JFrame callingframe

Constructor Detail

Wizard

public Wizard(javax.swing.JFrame callingframe,
              int width,
              int height)

Method Detail

showStatus

public void showStatus(java.lang.String a)

Print a message to the status bar.

Parameters:

a -

showError

public void showError(java.lang.String a)

Print an error message to the status bar.

Parameters:

a -

clearStatus

public void clearStatus()

Make the status bar empty.

addStep

protected void addStep(int step,
                       WizardStep panel)

showWizard

public void showWizard()

nextButton_actionPerformed

protected abstract void nextButton_actionPerformed(java.awt.event.ActionEvent e)

Define what happens when the 'next' button is pressed

Parameters:

e -

backButton_actionPerformed

protected abstract void backButton_actionPerformed(java.awt.event.ActionEvent e)

Define what happens when the 'back' button is pressed

Parameters:

e -

cancelButton_actionPerformed

protected abstract void cancelButton_actionPerformed(java.awt.event.ActionEvent e)

Define what happens when the 'cancel' button is pressed.

Parameters:

e -

finishButton_actionPerformed

protected abstract void finishButton_actionPerformed(java.awt.event.ActionEvent e)

Define what happens when the 'finish' button is pressed.

Parameters:

e -

setFinishDisabled

public void setFinishDisabled()

Disable the "finish" button, indicating the user has some steps to do yet.

setFinishEnabled

public void setFinishEnabled()

Enable the "finish" button, indicating the user can get out of the wizard at this stage.