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
class Segment

java.lang.Object extended by javax.swing.text.Segment
All Implemented Interfaces:
CharSequence, Cloneable, CharacterIterator

Most common way to construct:

Segment text = new Segment();

Based on 77 examples


public class Segment
extends Object
implements Cloneable, CharacterIterator, CharSequence

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.


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.
 
Constructor Summary

          Creates a new segment.
Segment(char[] array, int offset, int count)

          Creates a new segment referring to an existing array.
 
Method Summary
 char
charAt(int index)

          
 Object

          Creates a shallow copy.
 char

          Gets the character at the current position (as returned by getIndex()).
 char

          Sets the position to getBeginIndex() and returns the character at that position.
 int

          Returns the start index of the text.
 int

          Returns the end index of the text.
 int

          Returns the current index.
 boolean

          Flag to indicate that partial returns are valid.
 char

          Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty) and returns the character at that position.
 int

          
 char

          Increments the iterator's index by one and returns the character at the new index.
 char

          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.
 void
setPartialReturn(boolean p)

          Flag to indicate that partial returns are valid.
 CharSequence
subSequence(int start, int end)

          
 String

          Converts a segment into a String.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

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.
Constructor Detail

Segment

public Segment()
Creates a new segment.


Segment

public Segment(char[] array,
               int offset,
               int count)
Creates a new segment referring to an existing array.

Parameters:
array - the array to refer to
offset - the offset into the array
count - the number of characters
Method Detail

charAt

public char charAt(int index)
{@inheritDoc}

Parameters:
index

clone

public Object clone()
Creates a shallow copy.

Overrides:
clone in class Object
Returns:
the copy

current

public char current()
Gets the character at the current position (as returned by getIndex()).

Returns:
the character at the current position or DONE if the current position is off the end of the text.

first

public char first()
Sets the position to getBeginIndex() and returns the character at that position.

Returns:
the first character in the text, or DONE if the text is empty

getBeginIndex

public int getBeginIndex()
Returns the start index of the text.

Returns:
the index at which the text begins.

getEndIndex

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.

Returns:
the index after the last character in the text

getIndex

public int getIndex()
Returns the current index.

Returns:
the current index.

isPartialReturn

public boolean isPartialReturn()
Flag to indicate that partial returns are valid.

Returns:
whether or not partial returns are valid.

last

public char last()
Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty) and returns the character at that position.

Returns:
the last character in the text, or DONE if the text is empty

length

public int length()
{@inheritDoc}


next

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.

Returns:
the character at the new position or DONE if the new position is off the end of the text range.

previous

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.

Returns:
the character at the new position or DONE if the current position is equal to getBeginIndex().

setIndex

public char setIndex(int position)
Sets the position to the specified position in the text and returns that character.

Parameters:
position - the position within the text. Valid values range from getBeginIndex() to getEndIndex(). An IllegalArgumentException is thrown if an invalid value is supplied.
Returns:
the character at the specified position or DONE if the specified position is equal to getEndIndex()

setPartialReturn

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:
p - whether or not partial returns are valid.

subSequence

public CharSequence subSequence(int start,
                                int end)
{@inheritDoc}

Parameters:
start
end

toString

public String toString()
Converts a segment into a String.

Overrides:
toString in class Object
Returns:
the string


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:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.