This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
javax.swing.text
interface Position
public interface Position
Represents a location within a document. It is intended to abstract away
implementation details of the document and enable specification of
positions within the document that are capable of tracking of change as
the document is edited.
A {@code Position} object points at a location between two characters.
As the surrounding content is altered, the {@code Position} object
adjusts its offset automatically to reflect the changes. If content is
inserted or removed before the {@code Position} object's location, then the
{@code Position} increments or decrements its offset, respectively,
so as to point to the same location. If a portion of the document is removed
that contains a {@code Position}'s offset, then the {@code Position}'s
offset becomes that of the beginning of the removed region. For example, if
a {@code Position} has an offset of 5 and the region 2-10 is removed, then
the {@code Position}'s offset becomes 2.
{@code Position} with an offset of 0 is a special case. It never changes its
offset while document content is altered.
|
Nested Class Summary |
static class |
A typesafe enumeration to indicate bias to a position
in the model. |
| Method Summary |
int |
Fetches the current offset within the document.
|
getOffset
public int getOffset()
-
Fetches the current offset within the document.
- Returns:
- the offset >= 0
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
This page displays the
Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.