public class: Segment
All Implemented Interfaces:
CharSequence, CharacterIterator, Cloneable
Direct Known Subclasses:
IndexedSegment, IndexedSegment, AttributedSegment, CachedSegment
A segment of a character array representing a fragment
of text. It should be treated as immutable even though
the array is directly accessible. This gives fast access
to fragments of text without the overhead of copying
around characters. This is effectively an unprotected
The Segment implements the java.text.CharacterIterator
interface to support use with the i18n support without
copying text into a string.
Timothy - Prinzing
|public char ||array ||This is the array containing the text of
interest. This array should never be modified;
it is available only for efficiency. |
|public int ||offset ||This is the offset into the array that
the desired text begins. |
|public int ||count ||This is the number of array elements that
make up the text of interest. |
|Method from javax.swing.text.Segment Summary:|
charAt, clone, current, first, getBeginIndex, getEndIndex, getIndex, isPartialReturn, last, length, next, previous, setIndex, setPartialReturn, subSequence, toString|
|Methods from java.lang.Object:|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait|
|Method from javax.swing.text.Segment Detail:|
public char charAt(int index)
public Object clone()
public char current()
Gets the character at the current position (as returned by getIndex()).
public char first()
Sets the position to getBeginIndex() and returns the character at that
public int getBeginIndex()
Returns the start index of the text.
public int getEndIndex()
Returns the end index of the text. This index is the index of the first
character following the end of the text.
public int getIndex()
Returns the current index.
public boolean isPartialReturn()
Flag to indicate that partial returns are valid.
public char last()
Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty)
and returns the character at that position.
public int length()
public char next()
Increments the iterator's index by one and returns the character
at the new index. If the resulting index is greater or equal
to getEndIndex(), the current index is reset to getEndIndex() and
a value of DONE is returned.
public char previous()
Decrements the iterator's index by one and returns the character
at the new index. If the current index is getBeginIndex(), the index
remains at getBeginIndex() and a value of DONE is returned.
public char setIndex(int position)
Sets the position to the specified position in the text and returns that
public void setPartialReturn(boolean p)
Flag to indicate that partial returns are valid. If the flag is true,
an implementation of the interface method Document.getText(position,length,Segment)
should return as much text as possible without making a copy. The default
state of the flag is false which will cause Document.getText(position,length,Segment)
to provide the same return behavior it always had, which may or may not
make a copy of the text depending upon the request.
public CharSequence subSequence(int start,
public String toString()
Converts a segment into a String.