## About Wizards

See Also

Wizards are defined by the

The Wizard API lets you create wizard panels that have steps, graphics, left side-bar text, and a user panel on the right. The Wizard wizard in the IDE helps you by creating several of the basic Java source files, containing sample code, for you.

Depending on the selections you make in the Wizard Type panel in the New Wizard wizard, the IDE creates the following Java source files for you:

- Registration Type: Custom
  Wizard Step Sequence: Static

  Created files:

  - `SampleAction.java`
  - `VisualPanel.java` (for each wizard step)
  - `WizardPanel.java` (for each wizard step)

  These files are ideal for uncomplicated wizards that progress sequentially from panel to panel without divergences or reversals. A menu item or toolbar button invokes the wizard and subsequent steps are generally linear and forward-directed. For example, the Update Center wizard does not allow you to skip steps. It does not branch off or change direction based on choices made by the user.

- Registration Type: Custom
  Wizard Step Sequence: Dynamic

  Created files:

  - `WizardIterator.java`
  - `VisualPanel.java` (for each wizard step)
  - `WizardPanel.java` (for each wizard step)
  These files are for wizards that provide more flexibility to the user. A
  class guides progress from one panel to the next. The developer has a lot more freedom in coding the wizard, but has a more complex task since there are many more possibilities to consider. Even though the Custom/Simple wizard type can also be extended to provide support for panel skipping and reversals, the Custom/Dynamic type was made for this purpose. For example, the Add Server Instance wizard offers different panels depending on the type of server that the user wants to register.

- Registration Type: New File

  Created files:

  - `WizardIterator.java`
  - `VisualPanel.java` (for each wizard step)
  - `WizardPanel.java` (for each wizard step)
  - `.HTML` file (for the description area in the New File wizard)

  These files are for wizards that are used to create new files. This wizard is registered in the New File wizard via the `layer.xml` file. All the necessary entries in the `layer.xml` file are created for you by the Wizard wizard. In addition, when you make this choice, the Wizard wizard creates a

  The iterator lets you provide the direction and sequence of the wizard. The New File wizard can be as simple or as complex as your needs dictate. An HTML file is created by the Wizard wizard so that you can provide a description for your new wizard in the New File wizard.

  See Also
    About NetBeans Platform and Module Development
    About the NetBeans Platform

  Legal Notices