oracle.ide.cmd.buffer

Class Edit

java.lang.Object

oracle.ide.cmd.buffer.Edit

public abstract class Edit
extends java.lang.Object

The Edit class contains the method applyEdit to apply an edit (single or compound) to a document. IDE Addins can provide a class, which implements this interface, to do all the inserts and removes for a single undoable (or non-undoable) edit, and use the EditProcessor to apply the edit so that any notifications and undos are handled properly.

See Also:

EditProcessor

Constructor Summary

Constructors

Constructor and Description
Edit()

Method Summary

Modifier and Type	Method and Description
abstract void	applyEdit(TextBuffer textBuffer) Applies the edits the first time through in proper sequence.
abstract java.lang.String	getUndoName() Fetches the human-readable (translateable) name for this undo, typically displayed in the Edit->Undo menu item.
abstract boolean	isUndoable() Fetches whether this edit should be undoable or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

Edit

public Edit()

Method Detail

applyEdit

public abstract void applyEdit(TextBuffer textBuffer)

Applies the edits the first time through in proper sequence. The caller will ensure that the text buffer is locked for the duration of this call, as well as handle any UpdateMessage and undo for this edit.

Parameters:

textBuffer - the text buffer to apply the edit to, this is associated with the document passed to the EditProcessor

isUndoable

public abstract boolean isUndoable()

Fetches whether this edit should be undoable or not. If this edit is marked as non-undoable, the undo-stack for the document will be flushed as a consequence.

Returns:

whether this edit should be undoable or not

getUndoName

public abstract java.lang.String getUndoName()

Fetches the human-readable (translateable) name for this undo, typically displayed in the Edit->Undo menu item.

Parameters:

return - the undo name