org.vrjuggler.tweek.wizard
Class Wizard

java.lang.Object
  org.vrjuggler.tweek.wizard.AbstractWizardStep
      org.vrjuggler.tweek.wizard.WizardSequence
          org.vrjuggler.tweek.wizard.RootWizardSequence
              org.vrjuggler.tweek.wizard.Wizard

All Implemented Interfaces:

Serializable, WizardStep

public class Wizard
extends RootWizardSequence
implements Serializable

Describes collection of WizardPanes in a particular sequence with the expectation that the user will walk through them from beginning to end. A particular wizard can be serialized at design time and brought back to life when the user requests it.

A wizard contains a sequence of wizard steps which are processed linearly. Any of these steps may be another sequence of wizard steps that offshoot from the root sequence.

While to the user a wizard appears to be a linear iteration through wizard panes, a wizard is really stored as a tree. Since the choice of what wizard pane to show next could rely on choices the user made in the previous pane, it seems logical that a wizard should be implemented as a tree of wizard panes connected by the logic conditions that decide which pane to show next.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.vrjuggler.tweek.wizard.AbstractWizardStep

mName, mParent, mStepLabel, mWhiteBoard, mWizardStepListeners

Constructor Summary

Wizard()
Creates a new wizard with no steps, no name and no title.

Method Summary

String	getName() Gets the name of this wizard.
List	getRequiredClasses() Gets a list of all the custom classes this Wizard requires to run in a separate VM.
List	getRequiredResources() Gets a list of all the custom resources this Wizard requires to run in a separate VM.
WizardSequence	getSequence() Gets the sequence that makes up this wizard.
String	getTitle() Gets the title for this wizard.
WizardStepIterator	iterator() Gets the iterator that may be used to walk through this wizard.
void	setName(String name) Sets the name of this wizard.
void	setTitle(String title) Sets the title of this wizard.

Methods inherited from class org.vrjuggler.tweek.wizard.RootWizardSequence

shouldEnter

Methods inherited from class org.vrjuggler.tweek.wizard.WizardSequence

add, begin, end, get, getIndexOf, insert, remove, remove, setMap, size

Methods inherited from class org.vrjuggler.tweek.wizard.AbstractWizardStep

addWizardStepListener, fireWizardStepEvent, getMap, getParent, getStepLabel, onEntered, onEntering, onExited, onExiting, removeWizardStepListener, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

Wizard

public Wizard()

Creates a new wizard with no steps, no name and no title.

Method Detail

getName

public String getName()

Gets the name of this wizard.

Specified by:

getName in interface WizardStep

Overrides:

getName in class AbstractWizardStep

Returns:

the name

setName

public void setName(String name)

Sets the name of this wizard.

Specified by:

setName in interface WizardStep

Overrides:

setName in class AbstractWizardStep

Parameters:

name - the name

getTitle

public String getTitle()

Gets the title for this wizard.

Returns:

the title

setTitle

public void setTitle(String title)

Sets the title of this wizard.

Parameters:

title - the title

getSequence

public WizardSequence getSequence()

Gets the sequence that makes up this wizard.

iterator

public WizardStepIterator iterator()

Gets the iterator that may be used to walk through this wizard.

getRequiredClasses

public List getRequiredClasses()

Gets a list of all the custom classes this Wizard requires to run in a separate VM.

Specified by:

getRequiredClasses in interface WizardStep

Overrides:

getRequiredClasses in class AbstractWizardStep

Returns:

a list of fully-qualified class names

getRequiredResources

public List getRequiredResources()

Gets a list of all the custom resources this Wizard requires to run in a separate VM.

Specified by:

getRequiredResources in interface WizardStep

Overrides:

getRequiredResources in class AbstractWizardStep

Returns:

a list of the filenames of the resources needed. The filenames need to be the same as when they are loaded from the ClassLoader.