oracle.jdeveloper.ceditor
Class CodeEditorAddin

java.lang.Object
  oracle.jdeveloper.ceditor.CodeEditorAddin

All Implemented Interfaces:

Addin, EditorAddin

public class CodeEditorAddin

extends java.lang.Object

implements EditorAddin

The CodeEditorAddin does the work of plugging in this code editor into the IDE Addin framework.

Constructor Summary

CodeEditorAddin()
Constructs the CodeEditorAddin instance.

Method Summary

boolean	canShutdown() This method is called by the IDE to confirm that the ide can shutdown.
java.lang.Class	getEditorClass() Gets the fully qualified class name of the Editor being registered.
Navigable	getEditorNavigable() Fetches the main Editor navigable that is the parent of all other editor settings.
MenuSpec	getMenuSpecification() Gets the menu specification for the editor.
float	ideVersion() This method is called to determine the ide version number for which this Addin was implemented.
void	initialize() This method is called by the IDE to request that the feature be initialized.
boolean	isDefault() Determine if the Editor registered by this addin is the default Editor.
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

CodeEditorAddin

public CodeEditorAddin()

Constructs the CodeEditorAddin instance.

Method Detail

getEditorNavigable

public Navigable getEditorNavigable()

Fetches the main Editor navigable that is the parent of all other editor settings.

Returns:

the main editor Navigable

initialize

public void initialize()

This method is called by the IDE to request that the feature be initialized.

Specified by:

initialize in interface Addin

See Also:

AddinManager

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

canShutdown

public boolean canShutdown()

This method is called by the IDE to confirm that the ide can shutdown.

Specified by:

canShutdown 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.

isDefault

public boolean isDefault()

Determine if the Editor registered by this addin is the default Editor. The default Editor pops-up when the user double clicks on the node type associated with this Editor.

Specified by:

isDefault in interface EditorAddin

Returns:

true if the Editor is the default Editor.

getEditorClass

public java.lang.Class getEditorClass()

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

Specified by:

getEditorClass in interface EditorAddin

Returns:

the Editor's class

getMenuSpecification

public MenuSpec getMenuSpecification()

Gets the menu specification for the editor. This specification will be used to add a menu item to the View pulldown menu and to the node context menu.

Specified by:

getMenuSpecification in interface EditorAddin

Returns:

a menu specification.