org.eclipse.text.edits
Class TextEdit

java.lang.Object
  
org.eclipse.text.edits.TextEdit

Direct Known Subclasses:

CopyingRangeMarker, CopySourceEdit, CopyTargetEdit, DeleteEdit, InsertEdit, MoveSourceEdit, MoveTargetEdit, MultiTextEdit, RangeMarker, ReplaceEdit, UndoEdit

public abstract class TextEdit
extends 
Object

A text edit describes an elementary text manipulation operation. Edits are executed by applying them to a document (e.g. an instance of IDocument ).

Text edits form a tree. Clients can navigate the tree upwards, from child to parent, as well as downwards. Newly created edits are un-parented. New edits are added to the tree by calling one of the add methods on a parent edit.

An edit tree is well formed in the following sense:

• a parent edit covers all its children
• children don't overlap
• an edit with length 0 can't have any children

Insert edits are represented by an edit of length 0. If more than one insert edit exists at the same offset then the edits are executed in the order in which they have been added to a parent. The following code example:

    IDocument document= new Document("org");
          MultiTextEdit edit= new MultiTextEdit();
    edit.addChild(new InsertEdit(0, "www."));
    edit.addChild(new InsertEdit(0, "eclipse."));
    edit.apply(document);
 

Text edits can be executed in a mode where the edit's region is updated to reflect the edit's position in the changed document. Region updating is enabled by default or can be requested by passing UPDATE_REGIONS to the apply(IDocument, int) method. In the above example the region of the InsertEdit(0, "eclipse.") edit after executing the root edit is [3, 8]. If the region of an edit got deleted during change execution the region is set to [-1, -1] and the method isDeleted returns true.

Since:

3.0

Restriction:

This class is not intended to be subclassed by clients.

Field Summary
static int	CREATE_UNDO           Flags indicating that applying an edit tree to a document is supposed to create a corresponding undo edit.
static int	NONE           Flags indicating that neither CREATE_UNDO nor UPDATE_REGIONS is set.
static int	UPDATE_REGIONS           Flag indicating that the edit's region will be updated to reflect its position in the changed document.

 

Constructor Summary
protected	TextEdit (int offset, int length)           Create a new text edit.
protected	TextEdit ( TextEdit source)           Copy constructor

 

Method Summary
void	accept ( TextEditVisitor visitor)           Accepts the given visitor on a visit of the current edit.
protected abstract  void	accept0 ( TextEditVisitor visitor)           Accepts the given visitor on a type-specific visit of the current edit.
protected  void	acceptChildren ( TextEditVisitor visitor)           Accepts the given visitor on the edits children.
void	addChild ( TextEdit child)           Adds the given edit child to this edit.
void	addChildren ( TextEdit[] edits)           Adds all edits in edits to this edit.
UndoEdit	apply ( IDocument document)           Applies the edit tree rooted by this edit to the given document.
UndoEdit	apply ( IDocument document, int style)           Applies the edit tree rooted by this edit to the given document.
protected  boolean	canZeroLengthCover ()           Returns true if an edit with length zero can cover another edit.
protected  void	childDocumentUpdated ()           Hook method called when the document updating of a child edit has been completed.
protected  void	childRegionUpdated ()           Hook method called when the region updating of a child edit has been completed.
TextEdit	copy ()           Creates a deep copy of the edit tree rooted at this edit.
boolean	covers ( TextEdit other)           Returns true if the edit covers the given edit other.
protected abstract   TextEdit	doCopy ()           Creates and returns a copy of this edit.
boolean	equals ( Object obj)           The Edit implementation of this Object method uses object identity (==).
TextEdit[]	getChildren ()           Returns the edit's children.
int	getChildrenSize ()           Returns the size of the managed children.
static  IRegion	getCoverage ( TextEdit[] edits)           Returns the text range spawned by the given array of text edits.
int	getExclusiveEnd ()           Returns the exclusive end position of this edit.
int	getInclusiveEnd ()           Returns the inclusive end position of this edit.
int	getLength ()           Returns the length of the edit.
int	getOffset ()           Returns the offset of the edit.
TextEdit	getParent ()           Returns the edit's parent.
IRegion	getRegion ()           Returns the range that this edit is manipulating.
TextEdit	getRoot ()           Returns the root edit of the edit tree.
boolean	hasChildren ()           Returns true if this edit has children.
int	hashCode ()           The Edit implementation of this Object method calls uses Object#hashCode() to compute its hash code.
boolean	isDeleted ()           Returns whether this edit has been deleted or not.
void	moveTree (int delta)           Move all offsets in the tree by the given delta.
protected  void	postProcessCopy ( TextEditCopier copier)           This method is called on every edit of the copied tree to do some post-processing like connected an edit to a different edit in the tree.
TextEdit	removeChild (int index)           Removes the edit specified by the given index from the list of children.
boolean	removeChild ( TextEdit child)           Removes the first occurrence of the given child from the list of children.
TextEdit[]	removeChildren ()           Removes all child edits from and returns them.
String	toString ()

 

Methods inherited from class java.lang. Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

 

Field Detail

NONE

public static final int NONE

Flags indicating that neither CREATE_UNDO nor UPDATE_REGIONS is set.

See Also:

Constant Field Values

CREATE_UNDO

public static final int CREATE_UNDO

Flags indicating that applying an edit tree to a document is supposed to create a corresponding undo edit. If not specified null is returned from method apply.

See Also:

Constant Field Values

UPDATE_REGIONS

public static final int UPDATE_REGIONS

Flag indicating that the edit's region will be updated to reflect its position in the changed document. If not specified when applying an edit tree to a document the edit's region will be arbitrary. It is even not guaranteed that the tree is still well formed.

See Also:

Constant Field Values

TextEdit

protected TextEdit(int offset,
                   int length)

Create a new text edit. Parent is initialized to null and the edit doesn't have any children.

Parameters:

offset - the edit's offset

length - the edit's length

protected TextEdit(
TextEdit source)

public final 
IRegion getRegion()

public int getOffset()

public int getLength()

public final int getInclusiveEnd()

public final int getExclusiveEnd()

public final boolean isDeleted()

public final void moveTree(int delta)

public boolean covers(
TextEdit other)

protected boolean canZeroLengthCover()

public final 
TextEdit getParent()

public final 
TextEdit getRoot()

public final void addChild(
TextEdit child)
                    throws 
MalformedTreeException

public final void addChildren(
TextEdit[] edits)
                       throws 
MalformedTreeException

public final 
TextEdit removeChild(int index)

public final boolean removeChild(
TextEdit child)

public final 
TextEdit[] removeChildren()

public final boolean hasChildren()

public final 
TextEdit[] getChildren()

public final int getChildrenSize()

public static 
IRegion getCoverage(
TextEdit[] edits)

public final boolean equals(
Object obj)

public final int hashCode()

public 
String toString()

public final 
TextEdit copy()

protected abstract 
TextEdit doCopy()

protected void postProcessCopy(
TextEditCopier copier)

public final void accept(
TextEditVisitor visitor)

protected abstract void accept0(
TextEditVisitor visitor)

protected final void acceptChildren(
TextEditVisitor visitor)

public final 
UndoEdit apply(
IDocument document,
                            int style)
                     throws 
MalformedTreeException,
                            
BadLocationException

public final 
UndoEdit apply(
IDocument document)
                     throws 
MalformedTreeException,
                            
BadLocationException

protected void childDocumentUpdated()

protected void childRegionUpdated()