oracle.jdeveloper.cm.dt.addin
Class AbstractConnectionEditorWizard

java.lang.Object
  oracle.jdeveloper.cm.dt.addin.AbstractConnectionEditorWizard

All Implemented Interfaces:

Invokable, Wizard

public abstract class AbstractConnectionEditorWizard

extends java.lang.Object

implements Wizard

AbstractConnectionEditorWizard provides a base Wizard implementation that can be used when creating new Editors for database connections.

When invoked, AbstractConnectionEditorWizard instances will prompt the user for a connection to use. An editor will then be opened on this connection.

Constructor Summary

protected

AbstractConnectionEditorWizard(java.lang.Class editorClass, java.lang.String protocol) Creates a new instance.

Method Summary

javax.swing.Icon	getIcon() Gets the Icon to use in the Object Gallery and Navigator views.
java.lang.String	getMenuLabel() Provides the menu label used by this Wizard.
abstract MenuSpec	getMenuSpecification() Provides the menu specification used by this Wizard.
java.lang.String	getName() Provides the human readable name of this Wizard.
boolean	invoke(Context context, java.lang.String[] params) Invokes the object, usually called by the IDE.
boolean	isAvailable(Context context) Called when the sensitivity of the menu item that opens this wizard must be determined.

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.ide.addin.Wizard

toString

Constructor Detail

AbstractConnectionEditorWizard

protected AbstractConnectionEditorWizard(java.lang.Class editorClass,
                                         java.lang.String protocol)

Creates a new instance.

Parameters:

editorClass - The class of the EditorAddin associated with this wizard.

Method Detail

getName

public final 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 final 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 abstract 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.

isAvailable

public boolean isAvailable(Context context)

Description copied from interface: Wizard

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

Specified by:

isAvailable in interface Wizard

Parameters:

context - The Context to use when invoking this Wizard.

Returns:

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

getIcon

public final javax.swing.Icon getIcon()

Description copied from interface: Wizard

Gets the Icon to use in the Object Gallery and Navigator views.

Note: If this Wizard is not intended to be accessed from the ObjectGallery, the Wizard may return null.

Specified by:

getIcon in interface Wizard

Returns:

The Icon to be displayed in the ObjectGallery and Navigator.

invoke

public boolean invoke(Context context,
                      java.lang.String[] params)

Description copied from interface: Invokable

Invokes the object, usually called by the IDE.

Specified by:

invoke in interface Invokable

Parameters:

context - the context of the invocation.

params - optional arguments from the invoker

Returns:

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

See Also:

Context