# com.bea.ide.ui.wizard
DefaultWizard Class

public abstract class DefaultWizard
extends `Object`
implements `IWizard`

Hierarchy
  `Object`
  `DefaultWizard`

All Implemented Interfaces
  `IWizard`

## Nested Class Summary

`public static class` | `DefaultWizard.WizardStepFocusTraversalPolicy`

## Field Summary

`protected int` | `_iCurStep` Index into the internal wizard array indicating the current wizard
`protected int` | `_lastDir` integer value (either DIRECTION_FORWARD or DIRECTION_BACKWARD) indicating the last method called (getNextStep, getPreviousStep)
`protected static int` | `DIRECTION_BACKWARD` int
`protected static int` | `DIRECTION_FORWARD` int

## Constructor Summary

DefaultWizard(`String` sWizTitle, `String` sWizDescription, `String` sFinishText) Constructor that provides a title, description and customized finish button text for the wizard
DefaultWizard(`String` sWizTitle, `String` sWizDescription) Constructor that provides a title and description for the wizard.
DefaultWizard(`String` sWizTitle) Constructor that provides a title for the wizard.

## Method Summary

`protected `IWizardContext`` | `getContext`() Accessor to obtain the wizard context object set by the WizardDialog
`public `String`` | `getFinishText`() A Default implementation of the `IWizard.getFinishText()``` method.
`public `IWizardStep`` | `getNextStep`() Returns the next step in the wizard by looking at _iCurStep+1 in the array of wizard steps initialized during `DefaultWizard.initialize(IWizardContext)```.
`public `IWizardStep`` | `getPreviousStep`() Returns the previous step in the wizard by looking at _iCurStep-1 in the array of wizard steps initialized during `DefaultWizard.initialize(IWizardContext)```.
`public `String`` | `getWizardDescription`() A Default implementation of the `IWizard.getWizardDescription()``` method.
`protected abstract `IWizardStep`[]` | `getWizardSteps`() Get the wizard steps for this wizard.
`public `String`` | `getWizardTitle`() A Default implementation of the `IWizard.getWizardTitle()``` method.
`public void` | `initialize`(`IWizardContext` wc) A default implementation of the initialize() method.
`public boolean` | `onCancel`() A Default implementation of the `IWizard.onCancel()``` method.
`public void` | `onDispose`() A Default implementation of the `IWizard.onDispose()``` method.

Methods from class `java.lang.`Object``
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods from interface `com.bea.ide.ui.wizard.`IWizard``
``getFinishText`, `getNextStep`, `getPreviousStep`, `getWizardDescription`, `getWizardTitle`, `initialize`, `isFinishEnabled`, `onCancel`, `onDispose`, `onFinish``

## Field Detail

### _iCurStep

    protected int _iCurStep

  Index into the internal wizard array indicating the current wizard

### _lastDir

    protected int _lastDir

  integer value (either DIRECTION_FORWARD or DIRECTION_BACKWARD) indicating the last method called (getNextStep, getPreviousStep)

### DIRECTION_BACKWARD

    protected static int DIRECTION_BACKWARD

### DIRECTION_FORWARD

    protected static int DIRECTION_FORWARD

## Constructor Detail

### DefaultWizard

    protected DefaultWizard(String sWizTitle,
                            String sWizDescription,
                            String sFinishText)

  Constructor that provides a title, description and customized finish button text for the wizard

### DefaultWizard

    protected DefaultWizard(String sWizTitle,
                            String sWizDescription)

  Constructor that provides a title and description for the wizard. This wizard will have a default finish button appropriate for the locale.

### DefaultWizard

    protected DefaultWizard(String sWizTitle)

  Constructor that provides a title for the wizard. This wizard will have an empty description and a default finish button appropriate for the locale.

## Method Detail

### getContext() Method

    protected IWizardContext getContext()

Accessor to obtain the wizard context object set by the WizardDialog

### getFinishText() Method

    public String getFinishText()

A Default implementation of the `IWizard.getFinishText()``` method. Returns the finish string provided in the constructor, or the default finish string if none was specified.

#### Returns

String containing the text for the finish button

### getNextStep() Method

    public IWizardStep getNextStep()

Returns the next step in the wizard by looking at _iCurStep+1 in the array of wizard steps initialized during `DefaultWizard.initialize(IWizardContext)```. If there are no more steps, returns null. This has the side effect of setting _iCurStep to the new index.

#### Returns

next step in the wizard

### getPreviousStep() Method

    public IWizardStep getPreviousStep()

Returns the previous step in the wizard by looking at _iCurStep-1 in the array of wizard steps initialized during `DefaultWizard.initialize(IWizardContext)```. If there are no previous steps, returns null. This has the side effect of setting _iCurStep to the new index.

#### Returns

previous step in the wizard

### getWizardDescription() Method

    public String getWizardDescription()

A Default implementation of the `IWizard.getWizardDescription()``` method. Returns the description provided in the constructor.

#### Returns

String containing the description of the wizard

### getWizardSteps() Method

    protected abstract IWizardStep[] getWizardSteps()

Get the wizard steps for this wizard. Derived classes should implement this method to return the array of steps that this wizard defines.

### getWizardTitle() Method

    public String getWizardTitle()

A Default implementation of the `IWizard.getWizardTitle()``` method. Returns the title provided in the constructor.

#### Returns

String containing the title of the wizard

### initialize(IWizardContext) Method

    public void initialize(IWizardContext wc)

A default implementation of the initialize() method. Sets the wizard context, initializes the internal array of wizard steps by calling the `DefaultWizard.getWizardSteps()``` method and initializes the current step to -1

#### Parameters

wc
  The wizard context provided by the dialog. This should be used to refresh the status of buttons in the dialog when appropriate.

### onCancel() Method

    public boolean onCancel()

A Default implementation of the `IWizard.onCancel()``` method. Simply returns true.

#### Returns

boolean value indicating whether the cancel is accepted

### onDispose() Method

    public void onDispose()

A Default implementation of the `IWizard.onDispose()``` method. Does nothing.