|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.2.0) E17493-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.ide.editor.EditorAddin
public abstract class EditorAddin
This class is used to declare an Editor
with the EditorManager
.
Field Summary | |
---|---|
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 | |
---|---|
EditorAddin() |
Method Summary | |
---|---|
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. |
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 |
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 |
---|
public static final java.lang.String ATTRIBUTE_NO_RECENT_FILE
ATTRIBUTE_RESTORABLE
.Boolean.FALSE
if you do not want to be added to the 'recent files dialog'.
public static final java.lang.String ATTRIBUTE_RESTORABLE
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.
Constructor Detail |
---|
public EditorAddin()
Method Detail |
---|
public abstract java.lang.Class getEditorClass()
public boolean isDefault()
public abstract MenuSpec getMenuSpecification()
public float getEditorWeight(Element element)
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.
Float.NaN
if it does not want to be exposed.element
-public boolean isDuplicable()
public boolean restoreAtStartup()
public java.lang.Object getAttribute(java.lang.Object key)
key
- one of the ATTRIBUTE_ constants.public boolean isMultifile()
public void initialize()
Addin
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.initialize
in interface Addin
AddinManager
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.2.0) E17493-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |