Package org.eclipse.text.edits
Class TextEditGroup
java.lang.Object
org.eclipse.text.edits.TextEditGroup
- Direct Known Subclasses:
CategorizedTextEditGroup
A text edit group combines a list of
TextEdit
s
and a name into a single object. The name must be a human
readable string use to present the text edit group in the
user interface.
Clients may extend this class to add extra information to a text edit group.
- Since:
- 3.0
-
Constructor Summary
ConstructorDescriptionTextEditGroup
(String name) Creates a new text edit group with the given name.TextEditGroup
(String name, TextEdit edit) Creates a new text edit group with a name and a singleTextEdit
.TextEditGroup
(String name, TextEdit[] edits) Creates a new text edit group with the given name and array of edits. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addTextEdit
(TextEdit edit) Adds the givenTextEdit
to this group.void
Removes all text edits from this group.getName()
Returns the edit group's name.Returns the text region covered by the edits managed via this edit group.TextEdit[]
Returns an array ofTextEdit
s containing the edits managed by this group.boolean
isEmpty()
boolean
removeTextEdit
(TextEdit edit) Removes the givenTextEdit
from this group.
-
Constructor Details
-
TextEditGroup
Creates a new text edit group with the given name.- Parameters:
name
- the name of the text edit group. Must be a human readable string
-
TextEditGroup
Creates a new text edit group with a name and a singleTextEdit
.- Parameters:
name
- the name of the text edit group. Must be a human readable stringedit
- the edit to manage
-
TextEditGroup
Creates a new text edit group with the given name and array of edits.- Parameters:
name
- the name of the text edit group. Must be a human readable stringedits
- the array of edits
-
-
Method Details
-
getName
Returns the edit group's name.- Returns:
- the edit group's name
-
addTextEdit
Adds the givenTextEdit
to this group.- Parameters:
edit
- the edit to add
-
removeTextEdit
Removes the givenTextEdit
from this group.- Parameters:
edit
- the edit to remove- Returns:
true
if this group contained the specified edit.- Since:
- 3.3
-
clearTextEdits
public void clearTextEdits()Removes all text edits from this group.- Since:
- 3.3
-
isEmpty
public boolean isEmpty()- Returns:
- whether the list of managed text edits is empty or not
-
getTextEdits
Returns an array ofTextEdit
s containing the edits managed by this group.- Returns:
- the managed text edits
-
getRegion
Returns the text region covered by the edits managed via this edit group. If the group doesn't manage any editsnull
is returned.- Returns:
- the text region covered by this edit group or
null
if no edits are managed
-