oracle.ide.gallery
Class AbstractGalleryWizard

java.lang.Object
  oracle.ide.gallery.AbstractGalleryWizard

All Implemented Interfaces:

Displayable, GalleryWizard, Invokable, Wizard

Direct Known Subclasses:

oracle.jdeveloper.wizard.common.BaliWizard

public abstract class AbstractGalleryWizard

extends java.lang.Object

implements GalleryWizard

Constructor Summary

AbstractGalleryWizard()

Method Summary

java.lang.String	getLongLabel() Returns a long label that can be displayed to the user.
java.lang.String	getMenuLabel() Provides the menu label used by this Wizard.
MenuSpec	getMenuSpecification() Provides the menu specification used by this Wizard.
java.lang.String	getName() Provides the human readable name of this Wizard.
java.lang.String	getToolTipText() Returns the tool tip text to show when the mouse pointer pauses over a UI component that represents this Displayable.
java.lang.String	toString() Provides a String representation of this Wizard.

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.ide.addin.Wizard

getIcon, isAvailable

Methods inherited from interface oracle.ide.addin.Invokable

invoke

Methods inherited from interface oracle.ide.model.Displayable

getIcon, getShortLabel

Constructor Detail

AbstractGalleryWizard

public AbstractGalleryWizard()

Method Detail

getName

public java.lang.String getName()

Description copied from interface: Wizard

Provides the human readable name of this Wizard. The format of this string can be whatever makes the most sense to the Wizard developer; no conventions enforced by the Addin API.

Specified by:

getName in interface Wizard

getMenuLabel

public java.lang.String getMenuLabel()

Description copied from interface: Wizard

Provides the menu label used by this Wizard. The menu label returned by this method is added to the "Wizards" menu and used to invoke this Wizard. If this Wizard is not invokable from the "Wizards" menu, return null.

Specified by:

getMenuLabel in interface Wizard

Returns:

The name of the menu label, or null if no label is desired.

getMenuSpecification

public MenuSpec getMenuSpecification()

Description copied from interface: Wizard

Provides the menu specification used by this Wizard. The menu specifiaction returned by this method is added to the "Tools" menu and used to invoke this Wizard.

If this Wizard is not invokable from the "Tools" menu, return null.

Specified by:

getMenuSpecification in interface Wizard

Returns:

The menu specification, or null if no label is required.

getLongLabel

public java.lang.String getLongLabel()

Description copied from interface: Displayable

Returns a long label that can be displayed to the user. Generally, the value of the returned String is considered translatable and should therefore be placed in an appropriate resource file. The long label differs from the short label essentially on length. Usually the long label will only be shown on-demand and in places where horizontal space is more available. Examples are the status bar and tooltips.

Specified by:

getLongLabel in interface Displayable

Returns:

a long descriptive label of the Displayable that can be shown to the user.

getToolTipText

public java.lang.String getToolTipText()

Description copied from interface: Displayable

Returns the tool tip text to show when the mouse pointer pauses over a UI component that represents this Displayable. In many cases it may be appropriate for this method to return the same value as Displayable.getLongLabel().

Specified by:

getToolTipText in interface Displayable

Returns:

the tooltip to show when the mouse pointer pauses over a UI component that represents this Displayable.

toString

public java.lang.String toString()

Description copied from interface: Wizard

Provides a String representation of this Wizard. In general this should be the same as Wizard.getName().

Specified by:

toString in interface Wizard