|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.text.Position
Positions describe text ranges of a document. Positions are adapted to changes applied to that document. The text range is specified by an offset and a length. Positions can be marked as deleted. Deleted positions are considered to no longer represent a valid text range in the managing document.
Positions attached to documents are usually updated by position updaters. Because position updaters are freely definable and because of the frequency in which they are used, the fields of a position are made publicly accessible. Clients other than position updaters are not allowed to access these public fields.
Position can not be used as keys in hash tables as they override
equals
and hashCode
as they would be value
objects.
IDocument
Field Summary | |
boolean |
isDeleted
Indicates whether the position has been deleted |
int |
length
The length of the position |
int |
offset
The offset of the position |
Constructor Summary | |
protected |
Position()
Creates a new, not initialized position. |
|
Position(int offset)
Creates a new position with the given offset and length 0. |
|
Position(int offset,
int length)
Creates a new position with the given offset and length. |
Method Summary | |
void |
delete()
Marks this position as deleted. |
boolean |
equals(Object other)
|
int |
getLength()
Returns the length of this position. |
int |
getOffset()
Returns the offset of this position. |
int |
hashCode()
|
boolean |
includes(int offset)
Checks whether the given offset is inside of this position's text range. |
boolean |
isDeleted()
Returns whether this position has been deleted or not. |
boolean |
overlapsWith(int offset,
int length)
Checks whether the intersection of the given text range and the text range represented by this position is empty or not. |
void |
setLength(int length)
Changes the length of this position to the given length. |
void |
setOffset(int offset)
Changes the offset of this position to the given offset. |
void |
undelete()
Marks this position as not deleted. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public int offset
public int length
public boolean isDeleted
Constructor Detail |
public Position(int offset)
offset
- the position offset, must be >= 0public Position(int offset, int length)
offset
- the position offset, must be >= 0length
- the position length, must be >= 0protected Position()
Method Detail |
public int hashCode()
public void delete()
public void undelete()
public boolean equals(Object other)
public int getLength()
public int getOffset()
public boolean includes(int offset)
offset
- the offset to check
true
if offset is inside of this positionpublic boolean overlapsWith(int offset, int length)
offset
- the offset of the range to checklength
- the length of the range to check
true
if intersection is not emptypublic boolean isDeleted()
true
if position has been deletedpublic void setLength(int length)
length
- the new length of this positionpublic void setOffset(int offset)
offset
- the new offset of this position
|
Eclipse Platform Release 3.0 |
||||||||||
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, 2004. All rights reserved.