oracle.ide.editor

Class EditorAddin

java.lang.Object

oracle.ide.editor.EditorAddin

All Implemented Interfaces:

Addin

Direct Known Subclasses:

oracle.jdevimpl.compare.BaseCompareAddin, CodeEditorAddin, FlatEditorAddin

public abstract class EditorAddin
extends java.lang.Object
implements Addin

This class is used to declare an Editor with the EditorManager.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_NO_RECENT_FILE Deprecated. since 11.1.1. Use ATTRIBUTE_RESTORABLE.
static java.lang.String	ATTRIBUTE_RESTORABLE return Boolean.FALSE if your editor is not restorable from its URL.

Constructor Summary

Constructors

Constructor and Description
EditorAddin()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getAttribute(java.lang.Object key)
abstract java.lang.Class	getEditorClass() Gets the fully qualified class name of the Editor being registered.
float	getEditorWeight(Element element) This method is called by the EditorManager when a FlatEditorAddin is registered with EditorManager.registerDynamic(EditorAddin) and a new file is opened.
float	getEditorWeight(Element element, Context context) This method is called by the EditorManager when a FlatEditorAddin is registered with EditorManager.registerDynamic(EditorAddin) and a new file is opened.
abstract MenuSpec	getMenuSpecification() Gets the menu specification of this Addin.
void	initialize() Invoked by the AddinManager after the instance of the Addin is instantiated.
boolean	isCloneable()
boolean	isDefault()
boolean	isDuplicable() An EditorAddin should return true if its editor allows duplication.
boolean	isMultifile() Asks whether the editor of this EditorAddin is based on multiple files.
boolean	restoreAtStartup() Determines if the document must be reloaded at startup.

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIBUTE_NO_RECENT_FILE

public static final java.lang.String ATTRIBUTE_NO_RECENT_FILE

Deprecated. since 11.1.1. Use ATTRIBUTE_RESTORABLE.

return Boolean.FALSE if you do not want to be added to the 'recent files dialog'.

See Also:

Constant Field Values

ATTRIBUTE_RESTORABLE

public static final java.lang.String ATTRIBUTE_RESTORABLE

return Boolean.FALSE if your editor is not restorable from its URL. By default editors on ide protocol URL documents are not restorable. For other protocols, you can use this property.

This property will prevent the editor from participating in recent file lists and navigation that reopens closed files.

An EditorAddin which doesn't provide a value for this property is assumed to return Boolean.TRUE.

Since:

11.1.1

See Also:

Constant Field Values

Constructor Detail

EditorAddin

public EditorAddin()

Method Detail

getEditorClass

public abstract java.lang.Class getEditorClass()

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

Returns:

the Editor's class name

isDefault

public boolean isDefault()

Returns:

true if your editor was statically registered and you want it to be the default editor.

getMenuSpecification

public abstract MenuSpec getMenuSpecification()

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.

Returns:

a menu specification.

getEditorWeight

public float getEditorWeight(Element element)

This method is called by the EditorManager when a FlatEditorAddin is registered with EditorManager.registerDynamic(EditorAddin) and a new file is opened.

The returned value is used to determine if an editor tab should be added and where it should be added.

• It is suggested to use values from -1.0 to +1.0
• The addin should return Float.NaN if it does not want to be exposed.
• Addins with the highest values will be positioned to the left.
• Addins with a negative value will be considered as 'secondary' editors.
• Addins registered through the static mechanism will be assigned a value starting at 0.5 and decremented by 0.01

The meaning of 'secondary' has not been clearly defined yet but it could mean that those editors would be available from a continuation button at the right of the editor tabs. In case you forgot, a float value ends with a 'F', like '0.5F'

Parameters:

element -

Returns:

A float value that indicates where to position the editor tab.

getEditorWeight

public float getEditorWeight(Element element,
                             Context context)

This method is called by the EditorManager when a FlatEditorAddin is registered with EditorManager.registerDynamic(EditorAddin) and a new file is opened.

The returned value is used to determine if an editor tab should be added and where it should be added.

• It is suggested to use values from -1.0 to +1.0
• The addin should return Float.NaN if it does not want to be exposed.
• Addins with the highest values will be positioned to the left.
• Addins with a negative value will be considered as 'secondary' editors.
• Addins registered through the static mechanism will be assigned a value starting at 0.5 and decremented by 0.01

The meaning of 'secondary' has not been clearly defined yet but it could mean that those editors would be available from a continuation button at the right of the editor tabs. In case you forgot, a float value ends with a 'F', like '0.5F' Use this method if you need context.

Parameters:

element -

context -

Returns:

A float value that indicates where to position the editor tab.

isDuplicable

public boolean isDuplicable()

An EditorAddin should return true if its editor allows duplication. It basically means that if the user splits the editor window, the editor will be shown in both windows. If the editor does not allow duplication, the default editor will be shown if the second window. If the default editor does not allow duplication either, the duplicable editor will be chosen.

Returns:

true if the editor can be duplicated.

restoreAtStartup

public boolean restoreAtStartup()

Determines if the document must be reloaded at startup. If any of the editors open on that document returns Boolean.FALSE, the document will not be restored when the user restarts the application.
NOTE: Value returned by this method should be defined in the class constructor or "hardcoded" in the method body. Return value shouldn't depend on any other value and can't be changed during the life cycle of the object (except for class constructor). Violation of this rule may result in inconsistency in the Windowing System.

Returns:

If any of the editors open on that document returns Boolean.FALSE, the document will not be restored when the user restarts the application.

getAttribute

public java.lang.Object getAttribute(java.lang.Object key)

Parameters:

key - one of the ATTRIBUTE_ constants.

Returns:

the value corresponding to the ATTRIBUTE_ constant.

isMultifile

public boolean isMultifile()

Asks whether the editor of this EditorAddin is based on multiple files. This method allows editor types that cannot handle the context of an isolated file to opt out from features providing that kind of context. Certain repository browsers behave this way.

Returns:

a verdict on whether the editor is multifile; by default, returns false.

initialize

public void initialize()

Description copied from interface: Addin

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 Addin

See Also:

AddinManager

isCloneable

public boolean isCloneable()