|
Eclipse Platform Release 4.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.jface.text.link.LinkedPositionGroup
public class LinkedPositionGroup
A group of positions in multiple documents that are simultaneously modified - if one gets edited, all other positions in a group are edited the same way. All linked positions in a group have the same content.
Normally, new positions are given a sequence number which can be used by
clients, e.g. in the UI as tab stop weight. If NO_STOP is used as weight, a position will not be visited.
If NO_STOP is used for all positions, the first position in a document is taken as
the only stop as to comply with the behavior of the old linked position
infrastructure.
Clients may instantiate this class.
| Field Summary | |
|---|---|
static int |
NO_STOP
Sequence number constant declaring that a position should not be stopped by. |
| Constructor Summary | |
|---|---|
LinkedPositionGroup()
|
|
| Method Summary | |
|---|---|
void |
addPosition(LinkedPosition position)
Adds a position to this group. |
LinkedPosition[] |
getPositions()
Returns the positions contained in the receiver as an array. |
boolean |
isEmpty()
Returns whether this group contains any positions. |
boolean |
isEmtpy()
Deprecated. As of 3.1, replaced by isEmpty() |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final int NO_STOP
Sequence number constant declaring that a position should not be stopped by.
| Constructor Detail |
|---|
public LinkedPositionGroup()
| Method Detail |
|---|
public void addPosition(LinkedPosition position)
throws BadLocationException
BadLocationException is thrown.
Positions added using this method are owned by this group afterwards and may not be updated or modified thereafter.
Once a group has been added to a LinkedModeModel, it
becomes sealed and no positions may be added any more.
position - the position to add
BadLocationException - if the position is invalid or conflicts with
other positions in the group
IllegalStateException - if the group has already been added to a
modelpublic boolean isEmpty()
true if this group is empty, false otherwisepublic boolean isEmtpy()
isEmpty()
true if this group is empty, false otherwisepublic LinkedPosition[] getPositions()
|
Eclipse Platform Release 4.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2012. All rights reserved.