Show TOC

Background documentationWizard Framework Objects Locate this document in the navigation structure

 

A custom wizard consists of the following objects:

  • Wizard: A portal component whose class extends AbstractWizard and which represents the overall wizard. The following are key wizard objects:

    • Wizard Context (IWizardContext): Holds the current state of the wizard, as well as the data model for holding data entered by the administrator when running the wizard.

    • Configurable Wizard (IConfigurableWizard): Used for configuring a wizard at startup, in setupWizard() of the AbstractWizard class.

      The configurable wizard object can be used to create the following:

      • Transition: Represents a navigation step between two panes in a wizard. A transition specifies a source and target pane, and the toolbar button that causes the navigation. You can also specify a condition, making the transition contingent on the condition being true.

        You create transitions with the IConfigurableWizard object, but do not have access to transition objects.

      • Dependency: Represents a relationship between two items in the data model, so that when the source item is changed the target item is erased.

        You create dependencies with the IConfigurableWizard object, but do not have access to dependency objects.

        For more information, see Data Model.

  • Panes (AbstractWizardPane): A set of Java classes, each of which implements AbstractWizardPane and represents one pane of the user interface.

  • Non-Visible Panes (AbstractActionState): A set of Java classes, each of which implements AbstractActionState.

    The non-visible pane is used to perform actions while navigating between two visible panes. It can also be used for the final pane, performing actions on the data provided by the administrator via the wizard.

  • Conditions (ICondition): A class that implements the ICondition interface whose isTrue() method returns a Boolean. The class is used to add a condition to transitions.

    For more information, see Step 2: Creating the Wizard Component.

Key Classes/Interfaces

Class/Interface

Description

AbstractWizard

The wizard component extends this class.

AbstractWizardPane

Each wizard pane extends this class.

AbstractActionState

Each non-visible wizard pane extends this class.

IWizardContext

Represents the current state of the wizard

IConfigurableWizard

Provides methods for configuring the wizard.

ICondition

Each transition condition extends this class.

IWizardComponent

All panes and wizard UI components implement this interface.