Java Doc for TextEdit.java in  » IDE-Eclipse » text » org » eclipse » text » edits » Java Source Code / Java DocumentationJava Source Code and Java Documentation

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 TextEdit.apply(IDocument,int) 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 TextEdit.isDeleted() isDeleted returns true.

General template for implementation on each concrete TextEdit class:

 
 boolean visitChildren= visitor.visit(this);
 if (visitChildren) {
 acceptChildren(visitor);
 }
 
 

This method must be used by the concrete implementations of accept to traverse list-values properties; it encapsulates the proper handling of on-the-fly changes to the list.

May be overridden by subclasses of MultiTextEdit .
since:
   3.1

May be overridden by subclasses of MultiTextEdit .
since:
   3.1

Implementers of this method should use the copy constructor Edit#Edit(Edit source) to initialize the edit part of the copy. Implementors aren't responsible to actually copy the children or to set the right parent.

This method should not be called from outside the framework. Please use copy to create a copy of a edit tree. a copy of this edit.
See Also:   TextEdit.copy()
See Also:   TextEdit.postProcessCopy(TextEditCopier)
See Also:   TextEditCopier

 getOffset() + getLength();
 

 getOffset() + getLength() - 1;
 
 the inclusive end position

Creating a region for a deleted edit will result in an assertion failure. the manipulated region

This default implementation does nothing
Parameters:
  copier - the copier that manages a map between original andcopied edit.
See Also:   TextEditCopier