javax.ide.wizard

Class WizardManager

java.lang.Object

javax.ide.Service

javax.ide.wizard.WizardManager

public class WizardManager
extends Service

The WizardManager provides the interface through which the IDE invokes Wizards.

Constructor Summary

Constructors

Constructor and Description
WizardManager()

Method Summary

Modifier and Type	Method and Description
protected Wizard	findOrCreateWizard(java.lang.String id) Find or create a wizard instance.
protected java.util.Collection	getAllWizardClasses() Get the class names of all registered wizards.
protected javax.ide.wizard.spi.WizardHook	getWizardHook() Initialize the wizard manager.
static WizardManager	getWizardManager() Get the wizard manager implementation for this IDE.
boolean	invokeWizard(Context context, java.lang.String id) Invokes a wizard with the specified execution context and parameters.

Methods inherited from class javax.ide.Service

cloneLoadedServices, getService, initialize, resetAllServices, setLoadedServices

Methods inherited from class java.lang.Object

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

Constructor Detail

WizardManager

public WizardManager()

Method Detail

invokeWizard

public boolean invokeWizard(Context context,
                            java.lang.String id)

Invokes a wizard with the specified execution context and parameters.

Parameters:

context - The execution context for the invokable.

id - The id identifying the wizard.

Returns:

true if the wizard completed successfully, otherwise false.

getWizardHook

protected final javax.ide.wizard.spi.WizardHook getWizardHook()

Initialize the wizard manager.

getAllWizardClasses

protected final java.util.Collection getAllWizardClasses()

Get the class names of all registered wizards.

Returns:

a collection of string class names of all registered wizards.

findOrCreateWizard

protected final Wizard findOrCreateWizard(java.lang.String id)

Find or create a wizard instance.

Parameters:

id - the id of the wizard to find or create.

Returns:

an existing instance of the Wizard or a new instance if none has been created.

Throws:

java.lang.IllegalArgumentException - if no such wizard is registered.

java.lang.IllegalStateException - if the wizard could not be created.

getWizardManager

public static WizardManager getWizardManager()

Get the wizard manager implementation for this IDE.

Returns:

the wizard manager implementation for this ide.