oracle.jdevimpl.uieditor
Class UIEditorAddin

java.lang.Object
  oracle.jdevimpl.uieditor.UIEditorAddin

All Implemented Interfaces:

Addin, EditorAddin

public final class UIEditorAddin

extends java.lang.Object

implements EditorAddin

The UIEditorAddin registers the UIEditor with the EditorManager as being capable of editing Elements of type JavaSourceNode.

See Also:

oracle.ide.EditorManager, JavaSourceNode, oracle.jdeveloper.uieditor.UIEditor

Field Summary

static java.lang.String

ORACLE_LAYOUT_PACKAGE

Constructor Summary

UIEditorAddin()
Constructor.

Method Summary

boolean	canShutdown() This method is called by the IDE to confirm that the ide can shutdown.
static java.util.List	getAssistedLayouts()
java.lang.Class	getEditorClass() Get the class of the Editor class being registered.
static LayoutAssistant	getLayoutAssistant(java.lang.String name)
MenuSpec	getMenuSpecification() Get a MenuSpec describing the JMenuItem to be added to the View | Open Viewer As...
float	ideVersion() This method is called to determine the ide version number for which this Addin was implemented.
void	initialize() Register the UIEditor with the EditorManager as being able to edit Elements of type JavaSourceNode.
boolean	isDefault() Determines if the editor registered by this addin should be registered as the default Editor for its supported 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

Field Detail

ORACLE_LAYOUT_PACKAGE

public static final java.lang.String ORACLE_LAYOUT_PACKAGE

See Also:

Constant Field Values

Constructor Detail

UIEditorAddin

public UIEditorAddin()

Constructor.

Method Detail

initialize

public void initialize()

Register the UIEditor with the EditorManager as being able to edit Elements of type JavaSourceNode.

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()

Determines if the editor registered by this addin should be registered as the default Editor for its supported types.

Specified by:

isDefault in interface EditorAddin

Returns:

true if the Editor is the default editor.

getEditorClass

public java.lang.Class getEditorClass()

Get the class of the Editor class being registered.

Specified by:

getEditorClass in interface EditorAddin

Returns:

The Editor's class name

getMenuSpecification

public MenuSpec getMenuSpecification()

Get a MenuSpec describing the JMenuItem to be added to the View | Open Viewer As... submenu.

Specified by:

getMenuSpecification in interface EditorAddin

Returns:

A MenuSpec describing the Editor being registered.

getAssistedLayouts

public static java.util.List getAssistedLayouts()

getLayoutAssistant

public static LayoutAssistant getLayoutAssistant(java.lang.String name)