oracle.jdeveloper.cm.dt.addin
Class AbstractConnectionEditorAddin

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

All Implemented Interfaces:

Addin, EditorAddin

public abstract class AbstractConnectionEditorAddin

extends java.lang.Object

implements EditorAddin

The AbstractConnectionEditorAddin can be used as a base class for new EditorAddin implementations that work with a DatabaseEditorNode.

The SQL*Worksheet is an example of an editor based on AbstractConnectionEditorAddin

Constructor Summary

AbstractConnectionEditorAddin()

Method Summary

boolean	canShutdown() This method is invoked by the AddinManager before the IDE terminates.
abstract java.lang.Class	getEditorClass() Gets the fully qualified class name of the Editor being registered.
MenuSpec	getMenuSpecification() Gets the menu specification of this Addin.
protected abstract java.lang.Class	getNodeClass()
protected abstract java.lang.String	getNodeProtocol()
protected Wizard	getWizard() Retreives the Wizard instance that should be registered.
float	ideVersion() This method is called to determine the ide version number for which this Addin was implemented.
void	initialize() By default, AbstractConnectionEditorAddin registers itself with the EditorManager on DatabaseEditorNode instances.
boolean	isDefault() true if this should be treated as a default for its supported element types.
void	shutdown() This method is invoked by the AddinManager when the IDE terminates.
float	version() This method is called to determine the Addin version number.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractConnectionEditorAddin

public AbstractConnectionEditorAddin()

Method Detail

initialize

public void initialize()

By default, AbstractConnectionEditorAddin registers itself with the EditorManager on DatabaseEditorNode instances.

Specified by:

initialize in interface Addin

See Also:

EditorManager.register(oracle.ide.editor.EditorAddin, java.lang.Class[]), DatabaseEditorNode

shutdown

public void shutdown()

Description copied from interface: Addin

This method is invoked by the AddinManager when the IDE terminates. Any non java resources (file handles, database connections, etc) which are still being held by this Addin should be released by this method immediately. This method is not guaranteed to be called, but on normal terminations of the IDE, this method will be invoked.

Specified by:

shutdown in interface Addin

version

public float version()

Description copied from interface: Addin

This method is called to determine the Addin version number.

Specified by:

version in interface Addin

Returns:

the version number.

ideVersion

public float ideVersion()

Description copied from interface: Addin

This method is called to determine the ide version number for which this Addin was implemented.

Specified by:

ideVersion in interface Addin

Returns:

the ide version number.

canShutdown

public boolean canShutdown()

Description copied from interface: Addin

This method is invoked by the AddinManager before the IDE terminates. Addins should NOT use this method to release resources. They should only use this method to give users the opportunity to cancel the exit process if there is some process started by this addin still running. Implementations should return false to cancel the shutdown process.

Specified by:

canShutdown in interface Addin

isDefault

public boolean isDefault()

Description copied from interface: EditorAddin

true if this should be treated as a default for its supported element types. Default status might be considered during such actions as double clicking on an Element from the NavigatorWindow (i.e. open the default Editor).

Specified by:

isDefault in interface EditorAddin

Returns:

true if this Addin should be treated as a default.

getMenuSpecification

public final MenuSpec getMenuSpecification()

Description copied from interface: EditorAddin

Gets the menu specification of this Addin. This specification may be used to add a menu item to the main menu bar and/or to any context menu popped up in a NavigatorWindow.

Specified by:

getMenuSpecification in interface EditorAddin

Returns:

a menu specification.

getEditorClass

public abstract java.lang.Class getEditorClass()

Description copied from interface: EditorAddin

Gets the fully qualified class name of the Editor being registered.

Specified by:

getEditorClass in interface EditorAddin

Returns:

the Editor's class name

getWizard

protected Wizard getWizard()

Retreives the Wizard instance that should be registered.

Returns:

the Wizard instance, or null if this addin is not registering a Wizard on the Tools menu.

getNodeClass

protected abstract java.lang.Class getNodeClass()

getNodeProtocol

protected abstract java.lang.String getNodeProtocol()