|
Eclipse Platform Release 3.3 |
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||||
java.lang.Objectorg.eclipse.text.edits.TextEditGroup
A text edit group combines a list of TextEdits
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.
| Constructor Summary | |
|---|---|
TextEditGroup(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 single TextEdit. |
|
TextEditGroup(String name,
TextEdit[] edits)
Creates a new text edit group with the given name and array of edits. |
|
| Method Summary | |
|---|---|
void |
addTextEdit(TextEdit edit)
Adds the given TextEdit to this group. |
void |
clearTextEdits()
Removes all text edits from this group. |
String |
getName()
Returns the edit group's name. |
IRegion |
getRegion()
Returns the text region covered by the edits managed via this edit group. |
TextEdit[] |
getTextEdits()
Returns an array of TextEdits containing
the edits managed by this group. |
boolean |
isEmpty()
Returns true if the list of managed
TextEdits is empty; otherwise false
is returned. |
boolean |
removeTextEdit(TextEdit edit)
Removes the given TextEdit from this group. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public TextEditGroup(String name)
name - the name of the text edit group. Must be
a human readable string
public TextEditGroup(String name,
TextEdit edit)
TextEdit.
name - the name of the text edit group. Must be
a human readable stringedit - the edit to manage
public TextEditGroup(String name,
TextEdit[] edits)
name - the name of the text edit group. Must be
a human readable stringedits - the array of edits| Method Detail |
public String getName()
public void addTextEdit(TextEdit edit)
TextEdit to this group.
edit - the edit to addpublic boolean removeTextEdit(TextEdit edit)
TextEdit from this group.
edit - the edit to remove
true if this group contained the specified edit.public void clearTextEdits()
public boolean isEmpty()
true if the list of managed
TextEdits is empty; otherwise false
is returned.
public TextEdit[] getTextEdits()
TextEdits containing
the edits managed by this group.
public IRegion getRegion()
null
is returned.
null if no edits are managed
|
Eclipse Platform Release 3.3 |
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||||
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.