oracle.javatools.editor
Class EditDescriptor
java.lang.Object
|
+--oracle.javatools.editor.EditDescriptor
- public final class EditDescriptor
- extends java.lang.Object
The EditDescriptor
is used to describe an edit
operation that is undoable. It consists of an edit name that
describes the edit in human-readable (and translated) terms which
may be suitable for the "Edit->Undo" menu, and optionally a merge
property name that can be looked up to determine whether this edit
and another consecutive edit of the same type can be merged. Each
edit is assigned a unique id, or type to distinguish it from
other edits.
Currently, the merge property can only be specified by built
in edits. (It complicates editor options UI greatly to allow
arbitrary edits be mergeable.)
Constructor Summary |
EditDescriptor(java.lang.String editName)
Creates a new EditDescriptor with the given name. |
Method Summary |
boolean |
canMergeWith(EditDescriptor otherEdit)
Returns whether the edit can be merged with the other edit. |
java.lang.String |
getEditName()
Returns the name of this edit, which can be used as a
human-readable representation for the "Edit->Undo" menu. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
EditDescriptor
public EditDescriptor(java.lang.String editName)
- Creates a new
EditDescriptor
with the given name.
This name should be human-readable and translated as it may be
used by editor implementations for the "Edit->Undo" menu.
- Parameters:
editName
- the name of the edit
getEditName
public java.lang.String getEditName()
- Returns the name of this edit, which can be used as a
human-readable representation for the "Edit->Undo" menu.
- Returns:
- the name of this edit
canMergeWith
public boolean canMergeWith(EditDescriptor otherEdit)
- Returns whether the edit can be merged with the other edit.
Edits are mergeable if they are of the same type (matching
id's), and if the edit's merge property is defined with a
value of
true
.
- Parameters:
otherEdit
- the other edit to try to merge with