javax.ide.wizard

Interface Wizard

public interface Wizard

The Wizard interface is used to implement Document creation wizards based dialogs. When a user completes the steps in a wizard, a new document is generally added to the current project.

It is up to the individual IDEs to determine where users access these wizards.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	invoke(Context context) Invokes the object, usually called by the IDE from the button that launches the wizard.
boolean	isAvailable(Context context) Called when the availability of the wizard must be determined.

Method Detail

invoke

boolean invoke(Context context)

Invokes the object, usually called by the IDE from the button that launches the wizard.

Parameters:

context - the context of the invocation.

Returns:

true if the invocation was successful, false if it failed, or was aborted.

See Also:

Context

isAvailable

boolean isAvailable(Context context)

Called when the availability of the wizard must be determined. IDE can use the returned value to control the sensitivity of the GUI component that launces this wizard.

Parameters:

context - The Context to use when invoking this Wizard.

Returns:

true if the wizard can be invoked, or false otherwise.