Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.text.edits
Class TextEditGroup

java.lang.Object
  extended by 
org.eclipse.text.edits.TextEditGroup
Direct Known Subclasses:
CategorizedTextEditGroup

public class TextEditGroup
extends Object

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.

Since:
3.0

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

TextEditGroup

public TextEditGroup(
String name)
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

public TextEditGroup(
String name,
                     
TextEdit edit)
Creates a new text edit group with a name and a single TextEdit.

Parameters:
name - the name of the text edit group. Must be a human readable string
edit - the edit to manage

TextEditGroup

public TextEditGroup(
String name,
                     
TextEdit[] edits)
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 string
edits - the array of edits
Method Detail

getName

public 
String getName()
Returns the edit group's name.

Returns:
the edit group's name

addTextEdit

public void addTextEdit(
TextEdit edit)
Adds the given TextEdit to this group.

Parameters:
edit - the edit to add

removeTextEdit

public boolean removeTextEdit(
TextEdit edit)
Removes the given TextEdit 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 true if the list of managed TextEdits is empty; otherwise false is returned.

Returns:
whether the list of managed text edits is empty or not

getTextEdits

public 
TextEdit[] getTextEdits()
Returns an array of TextEdits containing the edits managed by this group.

Returns:
the managed text edits

getRegion

public 
IRegion getRegion()
Returns the text region covered by the edits managed via this edit group. If the group doesn't manage any edits null is returned.

Returns:
the text region covered by this edit group or null if no edits are managed

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire