|
JavaTM 2 Platform Std. Ed. v1.3.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.swing.text.Segment
A segment of a character array representing a fragment of text. It should be treated as immutable even though the array is directly accessable. This gives fast access to fragments of text without the overhead of copying around characters. This is effectively an unprotected String.
The Segment implements the java.text.CharacterIterator interface to support use with the i18n support without copying text into a string.
Field Summary | |
char[] |
array
This is the array containing the text of interest. |
int |
count
This is the number of array elements that make up the text of interest. |
int |
offset
This is the offset into the array that the desired text begins. |
Fields inherited from interface java.text.CharacterIterator |
DONE |
Constructor Summary | |
Segment()
Creates a new segment. |
|
Segment(char[] array,
int offset,
int count)
Creates a new segment referring to an existing array. |
Method Summary | |
Object |
clone()
Creates a shallow copy. |
char |
current()
Gets the character at the current position (as returned by getIndex()). |
char |
first()
Sets the position to getBeginIndex() and returns the character at that position. |
int |
getBeginIndex()
Returns the start index of the text. |
int |
getEndIndex()
Returns the end index of the text. |
int |
getIndex()
Returns the current index. |
char |
last()
Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty) and returns the character at that position. |
char |
next()
Increments the iterator's index by one and returns the character at the new index. |
char |
previous()
Decrements the iterator's index by one and returns the character at the new index. |
char |
setIndex(int position)
Sets the position to the specified position in the text and returns that character. |
String |
toString()
Converts a segment into a String. |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public char[] array
public int offset
public int count
Constructor Detail |
public Segment()
public Segment(char[] array, int offset, int count)
array
- the array to refer tooffset
- the offset into the arraycount
- the number of charactersMethod Detail |
public String toString()
toString
in class Object
public char first()
first
in interface CharacterIterator
getBeginIndex()
public char last()
last
in interface CharacterIterator
getEndIndex()
public char current()
current
in interface CharacterIterator
getIndex()
public char next()
next
in interface CharacterIterator
public char previous()
previous
in interface CharacterIterator
public char setIndex(int position)
setIndex
in interface CharacterIterator
position
- the position within the text. Valid values range from
getBeginIndex() to getEndIndex(). An IllegalArgumentException is thrown
if an invalid value is supplied.public int getBeginIndex()
getBeginIndex
in interface CharacterIterator
public int getEndIndex()
getEndIndex
in interface CharacterIterator
public int getIndex()
getIndex
in interface CharacterIterator
public Object clone()
clone
in interface CharacterIterator
clone
in class Object
|
JavaTM 2 Platform Std. Ed. v1.3.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2001 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.