oracle.ide.editor
Interface FlatEditorAddin

All Superinterfaces:

Addin, EditorAddin, Module

All Known Implementing Classes:

AbstractFlatEditorAddin

public interface FlatEditorAddin

extends EditorAddin

Method Summary

java.lang.Object	getAttribute(java.lang.Object key) This method is currently unused.
float	getEditorWeight(Element element) This method is called by the EditorManager when a FlatEditorAddin is registered with EditorManager.registerDynamic(FlatEditorAddin) and a new file is opened.
boolean	isDuplicable() An EditorAddin should return true if its editor allows duplication.
boolean	restoreAtStartup() Determines if the document must be reloaded at startup.

Methods inherited from interface oracle.ide.editor.EditorAddin

getEditorClass, getMenuSpecification, isDefault

Methods inherited from interface oracle.ide.addin.Addin

canShutdown, ideVersion, initialize, shutdown, version

Method Detail

getEditorWeight

public float getEditorWeight(Element element)

This method is called by the EditorManager when a FlatEditorAddin is registered with EditorManager.registerDynamic(FlatEditorAddin) 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:

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.

getAttribute

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

This method is currently unused.

Parameters:

key - one of the ATTRIBUTE_ constants.

Returns:

null