org.apache.batik.gvt.text
Interface GVTAttributedCharacterIterator

All Superinterfaces:

AttributedCharacterIterator, CharacterIterator, Cloneable

All Known Implementing Classes:

GVTACIImpl

public interface GVTAttributedCharacterIterator

extends AttributedCharacterIterator

GVTAttributedCharacterIterator Used to implement SVG <tspan> and <text> attributes. This implementation is designed for efficient support of per-character attributes (i.e. single character attribute spans). It supports an extended set of TextAttributes, via inner class SVGAttributedCharacterIterator.TextAttributes.

setString

public void setString(String s)

Sets this iterator's contents to an unattributed copy of String s.

setString

public void setString(AttributedString s)

Assigns this iterator's contents to be equivalent to AttributedString s.

setAttributeArray

public void setAttributeArray(GVTAttributedCharacterIterator.TextAttribute attr,
                              Object[] attValues,
                              int beginIndex,
                              int endIndex)

Sets values of a per-character attribute associated with the content string. Characters from beginIndex to endIndex (zero-offset) are assigned values for attribute key attr from the array attValues. If the length of attValues is less than character span (endIndex-beginIndex) the last value is duplicated; if attValues is longer than the character span the extra values are ignored. Note that if either beginIndex or endIndex are outside the bounds of the current character array they are clipped accordingly.

getAllAttributeKeys

public Set getAllAttributeKeys()

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

Specified by:

getAllAttributeKeys in interface AttributedCharacterIterator

getAttribute

public Object getAttribute(AttributedCharacterIterator.Attribute attribute)

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

Specified by:

getAttribute in interface AttributedCharacterIterator

getAttributes

public Map getAttributes()

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

Specified by:

getAttributes in interface AttributedCharacterIterator

getRunLimit

public int getRunLimit()

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

Specified by:

getRunLimit in interface AttributedCharacterIterator

getRunLimit

public int getRunLimit(AttributedCharacterIterator.Attribute attribute)

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

Specified by:

getRunLimit in interface AttributedCharacterIterator

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.

Specified by:

getRunLimit in interface AttributedCharacterIterator

getRunStart

public int getRunStart()

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

Specified by:

getRunStart in interface AttributedCharacterIterator

getRunStart

public int getRunStart(AttributedCharacterIterator.Attribute attribute)

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

Specified by:

getRunStart in interface AttributedCharacterIterator

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.

Specified by:

getRunStart in interface AttributedCharacterIterator

Parameters:

attributes - the Set of attributes which begins at the returned index.

clone

public Object clone()

Create a copy of this iterator

Specified by:

clone in interface CharacterIterator

current

public char current()

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

Specified by:

current in interface CharacterIterator

first

public char first()

Sets the position to getBeginIndex().

Specified by:

first in interface CharacterIterator

Returns:

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

getBeginIndex

public int getBeginIndex()

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

Specified by:

getBeginIndex in interface CharacterIterator

getEndIndex

public int getEndIndex()

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

Specified by:

getEndIndex in interface CharacterIterator

getIndex

public int getIndex()

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

Specified by:

getIndex in interface CharacterIterator

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.

Specified by:

last in interface CharacterIterator

next

public char next()

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

Specified by:

next in interface CharacterIterator

Returns:

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

previous

public char previous()

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

Specified by:

previous in interface CharacterIterator

setIndex

public char setIndex(int position)

Sets the position to the specified position in the text.

Specified by:

setIndex in interface CharacterIterator

Parameters:

position - The new (current) index into the text.

Returns:

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