oracle.jdeveloper.merge
Class BaseMergeAddin

java.lang.Object
  oracle.ide.editor.EditorAddin
      oracle.jdevimpl.compare.BaseCompareAddin
          oracle.jdeveloper.merge.BaseMergeAddin

All Implemented Interfaces:

Addin

Direct Known Subclasses:

AbstractMergeAddin

public abstract class BaseMergeAddin
extends oracle.jdevimpl.compare.BaseCompareAddin

Since:

11.1.2.0.0 (Sherman)

Field Summary

Fields inherited from class oracle.ide.editor.EditorAddin

ATTRIBUTE_NO_RECENT_FILE, ATTRIBUTE_RESTORABLE

Constructor Summary

protected	BaseMergeAddin() Constructor.
protected	BaseMergeAddin(java.lang.Class<? extends BaseMergeEditor> editorClass) Constructor.

Method Summary

java.lang.Class	getEditorClass() Gets the merge editor class associated with this merge addin.
MenuSpec	getMenuSpecification() Gets the menu specification of this Addin.
protected java.lang.Class<? extends BaseMergeEditor>	getMergeEditorClass()
boolean	isDefault()
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 class oracle.jdevimpl.compare.BaseCompareAddin

addCompareToolbarActionsToPopup, gatherCompareDynamicActions

Methods inherited from class oracle.ide.editor.EditorAddin

getAttribute, getEditorWeight, initialize, isMultifile

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseMergeAddin

protected BaseMergeAddin()

Constructor.

BaseMergeAddin

protected BaseMergeAddin(java.lang.Class<? extends BaseMergeEditor> editorClass)

Constructor.

Parameters:

editorClass - the merge editor class

Method Detail

getEditorClass

public final java.lang.Class getEditorClass()

Gets the merge editor class associated with this merge addin.

Specified by:

getEditorClass in class EditorAddin

Returns:

the addin's merge editor class.

isDefault

public final boolean isDefault()

Overrides:

isDefault in class EditorAddin

Returns:

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

isDuplicable

public final 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.

Overrides:

isDuplicable in class EditorAddin

Returns:

true if the editor can be duplicated.

restoreAtStartup

public final 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.

Overrides:

restoreAtStartup in class EditorAddin

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.

getMenuSpecification

public final 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.

Specified by:

getMenuSpecification in class EditorAddin

Returns:

a menu specification.

getMergeEditorClass

protected java.lang.Class<? extends BaseMergeEditor> getMergeEditorClass()