oracle.jdeveloper.template.wizard
Class GalleryItemAdapter

java.lang.Object
  oracle.ide.wizard.Wizard
      oracle.jdeveloper.template.wizard.GalleryItemAdapter

public final class GalleryItemAdapter
extends Wizard

Constructor Summary

GalleryItemAdapter(AbstractTemplate template)

Method Summary

javax.swing.Icon	getIcon() Gets the Icon to use in the Object Gallery.
java.lang.String	getShortLabel() Provides the label that represents the Wizard in the Object Gallery.
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

Constructor Detail

GalleryItemAdapter

public GalleryItemAdapter(AbstractTemplate template)

Method Detail

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.

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.

getShortLabel

public java.lang.String getShortLabel()

Description copied from class: Wizard

Provides the label that represents the Wizard in the Object Gallery. The label should be a noun or noun phrase naming the item that is created by this Wizard and should omit the word "new". Examples: "Java Class", "Java Interface", "XML Document", "Database Connection".

Specified by:

getShortLabel in class Wizard

Returns:

The human readable label of the Wizard.

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.