oracle.ide.addin
Interface Addin

All Superinterfaces:

Module

All Known Subinterfaces:

EditorAddin, Extension, FlatEditorAddin, VCSExtension

All Known Implementing Classes:

AbstractAuditAddin, AbstractFlatEditorAddin, oracle.jdeveloper.wizard.common.BaliWizard, CopyTranslator, DocumentRecognizer, GalleryManager, JCompiler, JLibraryManager, JProjectStructureController, JspLibraryAddin, NavigatorExtension, Ojc, VCSAbstractExtension

public interface Addin

extends Module

The Addin interface is one of the interfaces extension writers use to add functionality to the IDE.

In general, you implement this interface in order to register the menu item(s) that users can invoke to access the new functionality.

The initalize() method is called during IDE startup. It is in this method where your menu registration should take place. Note that lengthy, extension specific, initialization should not be done from within the intialize() method for it will slow down the IDE startup speed.

In order for the IDE to know about your Addin implementation you need to package your classes in a jar file as explained in the file jdev\lib\ext\README.txt.

Method Summary

boolean	canShutdown() This method is invoked by the AddinManager before the IDE terminates.
float	ideVersion() This method is called to determine the ide version number for which this Addin was implemented.
void	initialize() Invoked by the AddinManager after the instance of the Addin is instantiated.
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.

Method Detail

initialize

public void initialize()

Invoked by the AddinManager after the instance of the Addin is instantiated. When invoked, The Addin should register and menu items, and actions required for use during this classes lifecycle. Addin authors should take care to ensure that any extraneous initialization is not preformed on this method, and any startup code that can be delayed until a later time is delayed, as the Addin's are synchronously initialized during the startup of the IDE, and each Addin has the potential to negatively impact the startup time of the product.

Specified by:

initialize in interface Module

See Also:

AddinManager

shutdown

public void shutdown()

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.

version

public float version()

This method is called to determine the Addin version number.

Returns:

the version number.

ideVersion

public float ideVersion()

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

Returns:

the ide version number.

canShutdown

public boolean canShutdown()

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.