Class: 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 accessible. 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.

Authors:
@author Timothy Prinzing

Inheritance

Superclass tree: Implements:

Methods

  • Segmenttop

    public Segment()
    Creates a new segment.
    Related Links:
    Google Code Search
    Stack Overflow

  • Segmenttop

    public Segment(char[] array, int offset, int count)
    Creates a new segment referring to an existing array.
    Parameters:
    @param array the array to refer to
    @param offset the offset into the array
    @param count the number of characters
    Related Links:
    Google Code Search
    Stack Overflow

  • charAttop

    public char charAt(int index)
    Returns the char value at the specified index. An index ranges from zero to length() - 1. The first char value of the sequence is at index zero, the next at index one, and so on, as for array indexing.

    If the char value specified by the index is a surrogate, the surrogate value is returned.

    Parameters:
    @param index the index of the char value to be returned
    Return:
    @return the specified char value
    Since:
    @since 1.6
    Specified by:
    charAt from CharSequence
    Related Links:
    Google Code Search
    Stack Overflow

  • clonetop

    public Object clone()
    Creates a shallow copy.
    Return:
    @return the copy
    Specified by:
    clone from CharacterIterator
    Override hierarchy:
    clone from Object
    Related Links:
    Google Code Search
    Stack Overflow

  • currenttop

    public char current()
    Gets the character at the current position (as returned by getIndex()).
    Return:
    @return the character at the current position or DONE if the current position is off the end of the text.
    See:
    @see javax.swing.text.Segment.getIndex()
    Since:
    @since 1.3
    Specified by:
    current from CharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • firsttop

    public char first()
    Sets the position to getBeginIndex() and returns the character at that position.
    Return:
    @return the first character in the text, or DONE if the text is empty
    See:
    @see javax.swing.text.Segment.getBeginIndex()
    Since:
    @since 1.3
    Specified by:
    first from CharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • getBeginIndextop

    public int getBeginIndex()
    Returns the start index of the text.
    Return:
    @return the index at which the text begins.
    Since:
    @since 1.3
    Specified by:
    getBeginIndex from CharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • getEndIndextop

    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.
    Return:
    @return the index after the last character in the text
    Since:
    @since 1.3
    Specified by:
    getEndIndex from CharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • getIndextop

    public int getIndex()
    Returns the current index.
    Return:
    @return the current index.
    Since:
    @since 1.3
    Specified by:
    getIndex from CharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • isPartialReturntop

    public boolean isPartialReturn()
    Flag to indicate that partial returns are valid.
    Return:
    @return whether or not partial returns are valid.
    Since:
    @since 1.4
    Related Links:
    Google Code Search
    Stack Overflow

  • lasttop

    public char last()
    Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty) and returns the character at that position.
    Return:
    @return the last character in the text, or DONE if the text is empty
    See:
    @see javax.swing.text.Segment.getEndIndex()
    Since:
    @since 1.3
    Specified by:
    last from CharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • lengthtop

    public int length()
    Returns the length of this character sequence. The length is the number of 16-bit chars in the sequence.
    Return:
    @return the number of chars in this sequence
    Since:
    @since 1.6
    Specified by:
    length from CharSequence
    Related Links:
    Google Code Search
    Stack Overflow

  • nexttop

    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.
    Return:
    @return the character at the new position or DONE if the new position is off the end of the text range.
    Since:
    @since 1.3
    Specified by:
    next from CharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • previoustop

    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.
    Return:
    @return the character at the new position or DONE if the current position is equal to getBeginIndex().
    Since:
    @since 1.3
    Specified by:
    previous from CharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • setIndextop

    public char setIndex(int position)
    Sets the position to the specified position in the text and returns that character.
    Parameters:
    @param position the position within the text. Valid values range from getBeginIndex() to getEndIndex(). An IllegalArgumentException is thrown if an invalid value is supplied.
    Return:
    @return the character at the specified position or DONE if the specified position is equal to getEndIndex()
    Since:
    @since 1.3
    Specified by:
    setIndex from CharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • setPartialReturntop

    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.
    Parameters:
    @param p whether or not partial returns are valid.
    Since:
    @since 1.4
    Related Links:
    Google Code Search
    Stack Overflow

  • subSequencetop

    public CharSequence subSequence(int start, int end)
    Returns a new CharSequence that is a subsequence of this sequence. The subsequence starts with the char value at the specified index and ends with the char value at index end - 1. The length (in chars) of the returned sequence is end - start, so if start == end then an empty sequence is returned.
    Parameters:
    @param start the start index, inclusive
    @param end the end index, exclusive
    Return:
    @return the specified subsequence
    Since:
    @since 1.6
    Specified by:
    subSequence from CharSequence
    Related Links:
    Google Code Search
    Stack Overflow

  • toStringtop

    public String toString()
    Converts a segment into a String.
    Return:
    @return the string
    Specified by:
    toString from CharSequence
    Override hierarchy:
    toString from Object
    Related Links:
    Google Code Search
    Stack Overflow

Fields

  • array

    public char[] array
    This is the array containing the text of interest. This array should never be modified; it is available only for efficiency.

  • count

    public int count
    This is the number of array elements that make up the text of interest.

  • offset

    public int offset
    This is the offset into the array that the desired text begins.

  • partialReturn

    private boolean partialReturn

  • pos

    private int pos