org.apache.batik.gvt.text

Class AttributedCharacterSpanIterator

public class AttributedCharacterSpanIterator extends Object implements AttributedCharacterIterator

AttributedCharacterSpanIterator Used to provide ACI functionality to a "substring" of an AttributedString. In this way a TextLayout can be created which only uses a substring of AttributedString.

Constructor Summary
	AttributedCharacterSpanIterator(AttributedCharacterIterator aci, int start, int stop) Construct a AttributedCharacterSpanIterator from a subinterval of an existing AttributedCharacterIterator.

Method Summary
Object	clone() Create a copy of this iterator
char	current() Get the character at the current position (as returned by getIndex()).
char	first() Sets the position to getBeginIndex().
Set	getAllAttributeKeys() Get the keys of all attributes defined on the iterator's text range.
Object	getAttribute(Attribute attribute) Get the value of the named attribute for the current character.
Map	getAttributes() Returns a map with the attributes defined on the current character.
int	getBeginIndex() Get the start index of the text.
int	getEndIndex() Get the end index of the text.
int	getIndex() Get the current index.
int	getRunLimit() Get the index of the first character following the run with respect to all attributes containing the current character.
int	getRunLimit(Attribute attribute) Get the index of the first character following the run with respect to the given attribute containing the current character.
int	getRunLimit(Set attributes) Get the index of the first character following the run with respect to the given attributes containing the current character.
int	getRunStart() Get the index of the first character of the run with respect to all attributes containing the current character.
int	getRunStart(Attribute attribute) Get the index of the first character of the run with respect to the given attribute containing the current character.
int	getRunStart(Set attributes) Get the index of the first character of the run with respect to the given attributes containing the current character.
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, returning the next character.
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.

Constructor Detail

AttributedCharacterSpanIterator

public AttributedCharacterSpanIterator(AttributedCharacterIterator aci, int start, int stop)

Construct a AttributedCharacterSpanIterator from a subinterval of an existing AttributedCharacterIterator.

Parameters: aci The source AttributedCharacterIterator start the first index of the subinterval stop the index of the first character after the subinterval

Method Detail

clone

public Object clone()

Create a copy of this iterator

current

public char current()

Get the character at the current position (as returned by getIndex()).
Specified by: java.text.CharacterIterator.

first

public char first()

Sets the position to getBeginIndex().

Returns: the character at the start index of the text.
Specified by: java.text.CharacterIterator.

getAllAttributeKeys

public Set getAllAttributeKeys()

Get the keys of all attributes defined on the iterator's text range.

getAttribute

public Object getAttribute(Attribute attribute)

Get the value of the named attribute for the current character.

getAttributes

public Map getAttributes()

Returns a map with the attributes defined on the current character.

getBeginIndex

public int getBeginIndex()

Get the start index of the text.
Specified by: java.text.CharacterIterator.

getEndIndex

public int getEndIndex()

Get the end index of the text.
Specified by: java.text.CharacterIterator.

getIndex

public int getIndex()

Get the current index.
Specified by: java.text.CharacterIterator.

getRunLimit

public int getRunLimit()

Get the index of the first character following the run with respect to all attributes containing the current character.

getRunLimit

public int getRunLimit(Attribute attribute)

Get the index of the first character following the run with respect to the given attribute containing the current character.

getRunLimit

public int getRunLimit(Set attributes)

Get the index of the first character following the run with respect to the given attributes containing the current character.

getRunStart

public int getRunStart()

Get the index of the first character of the run with respect to all attributes containing the current character.

getRunStart

public int getRunStart(Attribute attribute)

Get the index of the first character of the run with respect to the given attribute containing the current character.

Parameters: attribute The attribute for whose appearance the first offset is requested.

getRunStart

public int getRunStart(Set attributes)

Get the index of the first character of the run with respect to the given attributes containing the current character.

Parameters: attributes the Set of attributes which begins at the returned index.

last

public char last()

Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty) and returns the character at that position.
Specified by: java.text.CharacterIterator.

public char next()

Increments the iterator's index by one, returning the next character.

Returns: the character at the new index.
Specified by: java.text.CharacterIterator.

public char previous()

Decrements the iterator's index by one and returns the character at the new index.
Specified by: java.text.CharacterIterator.

setIndex

public char setIndex(int position)

Sets the position to the specified position in the text.

Parameters: position The new (current) index into the text.

Returns: the character at new index position.
Specified by: java.text.CharacterIterator.