gui
Class WizardManager

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  gui.WizardManager

All Implemented Interfaces:

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

 class WizardManager
extends javax.swing.JPanel

The WizardManager extends JPanel, and acts as a controller for the containing cardlayout. The cardlayout contains WizardPanels which are JPanels (which support additional functionality for the clearing of data once the previous panel is navigated upon, the initialisation of the panel once it has first been navigated on, and the sending of the completed processed data to the main business object layer once the form has been correctly filled out.

Nested Class Summary

static class

WizardManager.ButtonAction

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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

Field Summary

private int	index
private java.awt.Dimension	size
private Wizard	wizard

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

WizardManager(Wizard wizard)
The wizard manager constructor receives the parent wizard, and assigns it to a referrence to a instance field.

Method Summary

(package private) void	doAction(WizardManager.ButtonAction action) The do action method receives a ButtonAction Enumeration type.
(package private) int	getIndex() The method gets the index.
java.awt.Dimension	getPreferredSize() The getPrefferedSize() method is overrided, and instead of returning the preferred size of the wizard manager panel; it will return the instance size dimension.
(package private) boolean	haveMorePanels() The method returns a boolean value representing whether they have more panels.
private void	next() Once the next method is called, it will grab the component out of itself from the index value and casted to a WizardPanel.
private void	previous() The previous method decrements the index, and sets the panel with the previous card.
(package private) void	registerPanel(java.lang.Object identifier, WizardPanel wizardPanel) The WizardPanel is added to the cardlayout, and casted back to a JPanel.
void	setFrameSize(java.awt.Dimension size) The size of the WizardManager is contained within a instance dimension field, which allows for the size of the wizard manager to be changed to the size of the selected WizardPanel; allowing for the scrollpane to function correctly.
(package private) void	setPanel() The setPanel() method gets the current component from the JPanel, and casts it back to a WizardPanel; then performs the additional functionality, such as, clearing the wizard panel data structures being used, and displays the panel by reinitialising the gui components.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

wizard

private Wizard wizard

index

private int index

size

private java.awt.Dimension size

Constructor Detail

WizardManager

WizardManager(Wizard wizard)

The wizard manager constructor receives the parent wizard, and assigns it to a referrence to a instance field. The referrence allows the parent JDialog to be updated with the new dialog title, and also allows for the buttons to be disabled.

Parameters:

wizard -

Method Detail

registerPanel

void registerPanel(java.lang.Object identifier,
                   WizardPanel wizardPanel)

The WizardPanel is added to the cardlayout, and casted back to a JPanel. The object can be recasted back to a WizardPanel (to allow for the use of the additional functionality defined int the WizardPanel) once the object has been retreived back at a later stage.

Parameters:

identifier -

wizardPanel -

haveMorePanels

boolean haveMorePanels()

The method returns a boolean value representing whether they have more panels.

Returns:

- boolean representation of more panels.

getIndex

int getIndex()

The method gets the index.

Returns:

- int index value of the current card.

doAction

void doAction(WizardManager.ButtonAction action)

The do action method receives a ButtonAction Enumeration type. The method is called from the annoymous action listner class added to the button (which passes in the set action command). The method does a switch test to determine what enumeration type has been selected.

Parameters:

action - - The ButtonAction enumeration type.

next

private void next()

Once the next method is called, it will grab the component out of itself from the index value and casted to a WizardPanel. It validates whether the card can be showned, and if it can it cycles to the next card, and sets the panel. Otherwise it has determined that the card is out of range, and closes the form.

previous

private void previous()

The previous method decrements the index, and sets the panel with the previous card. The setPanel method performs the added functionality to the WizardPanel; allowing the data to be cleared, and for the components to be reinitialised onto the wizard panel.

setPanel

void setPanel()

The setPanel() method gets the current component from the JPanel, and casts it back to a WizardPanel; then performs the additional functionality, such as, clearing the wizard panel data structures being used, and displays the panel by reinitialising the gui components.

setFrameSize

public void setFrameSize(java.awt.Dimension size)

The size of the WizardManager is contained within a instance dimension field, which allows for the size of the wizard manager to be changed to the size of the selected WizardPanel; allowing for the scrollpane to function correctly.

Parameters:

size -

getPreferredSize

public java.awt.Dimension getPreferredSize()

The getPrefferedSize() method is overrided, and instead of returning the preferred size of the wizard manager panel; it will return the instance size dimension.

Overrides:

getPreferredSize in class javax.swing.JComponent