oracle.jdeveloper.wizard.common
Class BaliWizard

java.lang.Object
  oracle.ide.wizard.Wizard
      oracle.jdeveloper.wizard.common.BaliWizard

Direct Known Subclasses:

AbstractBuilder

public abstract class BaliWizard
extends Wizard

The AbstractOnePageWizard is an abstract base class using the Bali JEWTDialog.

Children should:

Override buildPanel

Define a constructor that chains to super() and sets the value of wizName.

Override buildState to create a state object (if so desired).

Field Summary

protected oracle.bali.ewt.dialog.JEWTDialog	_dlg
protected javax.swing.Icon	largeIcon Deprecated. since 11.0 override getIcon() instead.
protected BaliWizardState	state
protected java.lang.String	wizName

Constructor Summary

BaliWizard()
Constructor.

Method Summary

protected oracle.bali.ewt.dialog.JEWTDialog	buildDialog(Context context, BaliWizardState state) Create and fill in JEWTDialog instances.
protected abstract BaliWizardPanel	buildPanel(Context context, BaliWizardState state) The returned Panel should be a JPanel that implements the BaliWizardPanel interface.
protected BaliWizardState	buildState(Context context) Create a new state object.
protected void	cancel()
void	commitAndFinish() Commits the changes and closes the dialog.
protected void	displayErrorMessage(java.lang.String title, java.lang.String msg, java.lang.String helpID)
protected void	finish()
protected java.lang.String	getDialogTitle()
protected java.lang.String	getHeaderDescription()
protected java.awt.Image	getHeaderImage()
protected java.lang.String	getHeaderTitle()
javax.swing.Icon	getIcon() Gets the Icon to use in the Object Gallery.
java.lang.String	getShortLabel() Gets the name of the Wizard; the code can be inherited, as it returns the abstracted variable wizName.
boolean	invoke(Context context) Invokes the wizard.
boolean	isAvailable(Context context) Called when the sensitivity of the menu item that opens this wizard must be determined.

Methods inherited from class oracle.ide.wizard.Wizard

getLegacyParams, getLongLabel, getMenuSpecification, getToolTipText, setLegacyParams, toString

Methods inherited from class java.lang.Object

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

Field Detail

_dlg

protected oracle.bali.ewt.dialog.JEWTDialog _dlg

largeIcon

protected javax.swing.Icon largeIcon

Deprecated. since 11.0 override getIcon() instead.

state

protected BaliWizardState state

wizName

protected java.lang.String wizName

Constructor Detail

BaliWizard

public BaliWizard()

Constructor. Constructs an instance of this class.

Method Detail

buildState

protected BaliWizardState buildState(Context context)

Create a new state object.

Parameters:

context - The Context describing the conditions of the call.

Returns:

A BaliWizardState object to be manipulated by the wizard.

See Also:

oracle.ide.addin.Context

buildDialog

protected oracle.bali.ewt.dialog.JEWTDialog buildDialog(Context context,
                                                        BaliWizardState state)

Create and fill in JEWTDialog instances.

Important note: All panels must implement the BaliWizardPanel interface in order for this BaliWizard to work!

Parameters:

context - The Context describing the conditions of the call.

state - The state.

Returns:

A JEWTDialog that is ready to be run.

See Also:

oracle.ide.addin.Context, JEWTDialog

buildPanel

protected abstract BaliWizardPanel buildPanel(Context context,
                                              BaliWizardState state)

The returned Panel should be a JPanel that implements the BaliWizardPanel interface.

invoke

public boolean invoke(Context context)

Description copied from class: Wizard

Invokes the wizard.

Specified by:

invoke in class Wizard

Parameters:

context - The context of the wizard. All parameters required by the wizard must be set on the context. The wizard may also return values to the caller by setting them into the Context for the caller to retrieve.

Returns:

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

getIcon

public javax.swing.Icon getIcon()

Description copied from class: Wizard

Gets the Icon to use in the Object Gallery. If this Wizard is not accessed from the Object Gallery, the Wizard should return null.

Overrides:

getIcon in class Wizard

Returns:

The Icon to be displayed in the Object Gallery.

getShortLabel

public java.lang.String getShortLabel()

Gets the name of the Wizard; the code can be inherited, as it returns the abstracted variable wizName.

Specified by:

getShortLabel in class Wizard

Returns:

The human readable label of the Wizard.

isAvailable

public boolean isAvailable(Context context)

Description copied from class: Wizard

Called when the sensitivity of the menu item that opens this wizard must be determined.

Specified by:

isAvailable in class Wizard

Parameters:

context - The Context to use when invoking this Wizard.

Returns:

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

commitAndFinish

public void commitAndFinish()

Commits the changes and closes the dialog.

finish

protected void finish()

cancel

protected void cancel()

getHeaderImage

protected java.awt.Image getHeaderImage()

getHeaderTitle

protected java.lang.String getHeaderTitle()

getHeaderDescription

protected java.lang.String getHeaderDescription()

getDialogTitle

protected java.lang.String getDialogTitle()

displayErrorMessage

protected final void displayErrorMessage(java.lang.String title,
                                         java.lang.String msg,
                                         java.lang.String helpID)