javax.swing.text
Class Segment

java.lang.Object
  |
  +--javax.swing.text.Segment

All Implemented Interfaces:

java.text.CharacterIterator, Cloneable

Direct Known Subclasses:

javax.swing.text.TextLayoutStrategy.AttributedSegment, javax.swing.text.SegmentCache.CachedSegment, javax.swing.text.JTextComponent.AccessibleJTextComponent.IndexedSegment

public class Segment

extends Object

implements Cloneable, java.text.CharacterIterator

Safe:

Field Summary

char[]	array Suppressed: This is the array containing the text of interest.
int	count Suppressed: This is the number of array elements that make up the text of interest.
int	offset Suppressed: This is the offset into the array that the desired text begins.
private boolean	partialReturn
private int	pos

Constructor Summary

Segment()
Enabled: Creates a new segment.

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

Method Summary

Object	clone() Suppressed: Creates a shallow copy.
char	current() Enabled: Gets the character at the current position (as returned by getIndex()).
char	first() Enabled: Sets the position to getBeginIndex() and returns the character at that position.
int	getBeginIndex() Enabled: Returns the start index of the text.
int	getEndIndex() Enabled: Returns the end index of the text.
int	getIndex() Enabled: Returns the current index.
boolean	isPartialReturn() Enabled: Flag to indicate that partial returns are valid.
char	last() Enabled: Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty) and returns the character at that position.
char	next() Enabled: Increments the iterator's index by one and returns the character at the new index.
char	previous() Enabled: Decrements the iterator's index by one and returns the character at the new index.
char	setIndex(int position) Enabled: Sets the position to the specified position in the text and returns that character.
void	setPartialReturn(boolean p) Enabled: Flag to indicate that partial returns are valid.
String	toString() Suppressed: Converts a segment into a String.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

array

public char[] array

Suppressed: This is the array containing the text of interest. This array should never be modified; it is available only for efficiency.

offset

public int offset

Suppressed: This is the offset into the array that the desired text begins.

count

public int count

Suppressed: This is the number of array elements that make up the text of interest.

partialReturn

private boolean partialReturn

pos

private int pos

Constructor Detail

Segment

public Segment()

Enabled: Creates a new segment.

Segment

public Segment(char[] array,
               int offset,
               int count)

Enabled: 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

setPartialReturn

public void setPartialReturn(boolean p)

Enabled: 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.

Since:

1.4

isPartialReturn

public boolean isPartialReturn()

Enabled: Flag to indicate that partial returns are valid.

Returns:

whether or not partial returns are valid.

Since:

1.4

toString

public String toString()

Suppressed: Converts a segment into a String.

Overrides:

toString in class Object

Returns:

the string

first

public char first()

Enabled: 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

See Also:

getBeginIndex()

last

public char last()

Enabled: 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

See Also:

getEndIndex()

current

public char current()

Enabled: 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.

See Also:

getIndex()

next

public char next()

Enabled: 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()

Enabled: 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)

Enabled: 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()

getBeginIndex

public int getBeginIndex()

Enabled: Returns the start index of the text.

Returns:

the index at which the text begins.

getEndIndex

public int getEndIndex()

Enabled: 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()

Enabled: Returns the current index.

Returns:

the current index.

clone

public Object clone()

Suppressed: Creates a shallow copy.

Overrides:

clone in class Object

Returns:

the copy

See Also:

java.lang.Cloneable