Package org.apache.batik.gvt.text
Interface GVTAttributedCharacterIterator
-
- All Superinterfaces:
java.text.AttributedCharacterIterator,java.text.CharacterIterator,java.lang.Cloneable
- All Known Implementing Classes:
GVTACIImpl
public interface GVTAttributedCharacterIterator extends java.text.AttributedCharacterIteratorGVTAttributedCharacterIterator 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.- Version:
- $Id: GVTAttributedCharacterIterator.java 1802297 2017-07-18 13:58:12Z ssteiner $
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interfaceGVTAttributedCharacterIterator.AttributeFilterInterface for helper class which mutates the attributes of an AttributedCharacterIterator.static classGVTAttributedCharacterIterator.TextAttributeAttribute keys that identify SVG text attributes.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.Objectclone()Create a copy of this iteratorcharcurrent()Get the character at the current position (as returned by getIndex()).charfirst()Sets the position to getBeginIndex().java.util.SetgetAllAttributeKeys()Get the keys of all attributes defined on the iterator's text range.java.lang.ObjectgetAttribute(java.text.AttributedCharacterIterator.Attribute attribute)Get the value of the named attribute for the current character.java.util.MapgetAttributes()Returns a map with the attributes defined on the current character.intgetBeginIndex()Get the start index of the text.intgetEndIndex()Get the end index of the text.intgetIndex()Get the current index.intgetRunLimit()Get the index of the first character following the run with respect to all attributes containing the current character.intgetRunLimit(java.text.AttributedCharacterIterator.Attribute attribute)Get the index of the first character following the run with respect to the given attribute containing the current character.intgetRunLimit(java.util.Set attributes)Get the index of the first character following the run with respect to the given attributes containing the current character.intgetRunStart()Get the index of the first character of the run with respect to all attributes containing the current character.intgetRunStart(java.text.AttributedCharacterIterator.Attribute attribute)Get the index of the first character of the run with respect to the given attribute containing the current character.intgetRunStart(java.util.Set attributes)Get the index of the first character of the run with respect to the given attributes containing the current character.charlast()Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty) and returns the character at that position.charnext()Increments the iterator's index by one, returning the next character.charprevious()Decrements the iterator's index by one and returns the character at the new index.voidsetAttributeArray(GVTAttributedCharacterIterator.TextAttribute attr, java.lang.Object[] attValues, int beginIndex, int endIndex)Sets values of a per-character attribute associated with the content string.charsetIndex(int position)Sets the position to the specified position in the text.voidsetString(java.lang.String s)Sets this iterator's contents to an unattributed copy of String s.voidsetString(java.text.AttributedString s)Assigns this iterator's contents to be equivalent to AttributedString s.
-
-
-
Method Detail
-
setString
void setString(java.lang.String s)
Sets this iterator's contents to an unattributed copy of String s.
-
setString
void setString(java.text.AttributedString s)
Assigns this iterator's contents to be equivalent to AttributedString s.
-
setAttributeArray
void setAttributeArray(GVTAttributedCharacterIterator.TextAttribute attr, java.lang.Object[] attValues, int beginIndex, int endIndex)
Sets values of a per-character attribute associated with the content string. Characters frombeginIndextoendIndex(zero-offset) are assigned values for attribute keyattrfrom the arrayattValues.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
java.util.Set getAllAttributeKeys()
Get the keys of all attributes defined on the iterator's text range.- Specified by:
getAllAttributeKeysin interfacejava.text.AttributedCharacterIterator
-
getAttribute
java.lang.Object getAttribute(java.text.AttributedCharacterIterator.Attribute attribute)
Get the value of the named attribute for the current character.- Specified by:
getAttributein interfacejava.text.AttributedCharacterIterator
-
getAttributes
java.util.Map getAttributes()
Returns a map with the attributes defined on the current character.- Specified by:
getAttributesin interfacejava.text.AttributedCharacterIterator
-
getRunLimit
int getRunLimit()
Get the index of the first character following the run with respect to all attributes containing the current character.- Specified by:
getRunLimitin interfacejava.text.AttributedCharacterIterator
-
getRunLimit
int getRunLimit(java.text.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:
getRunLimitin interfacejava.text.AttributedCharacterIterator
-
getRunLimit
int getRunLimit(java.util.Set attributes)
Get the index of the first character following the run with respect to the given attributes containing the current character.- Specified by:
getRunLimitin interfacejava.text.AttributedCharacterIterator
-
getRunStart
int getRunStart()
Get the index of the first character of the run with respect to all attributes containing the current character.- Specified by:
getRunStartin interfacejava.text.AttributedCharacterIterator
-
getRunStart
int getRunStart(java.text.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:
getRunStartin interfacejava.text.AttributedCharacterIterator- Parameters:
attribute- The attribute for whose appearance the first offset is requested.
-
getRunStart
int getRunStart(java.util.Set attributes)
Get the index of the first character of the run with respect to the given attributes containing the current character.- Specified by:
getRunStartin interfacejava.text.AttributedCharacterIterator- Parameters:
attributes- the Set of attributes which begins at the returned index.
-
clone
java.lang.Object clone()
Create a copy of this iterator- Specified by:
clonein interfacejava.text.CharacterIterator
-
current
char current()
Get the character at the current position (as returned by getIndex()).
Specified by: java.text.CharacterIterator.- Specified by:
currentin interfacejava.text.CharacterIterator
-
first
char first()
Sets the position to getBeginIndex().- Specified by:
firstin interfacejava.text.CharacterIterator- Returns:
- the character at the start index of the text.
Specified by: java.text.CharacterIterator.
-
getBeginIndex
int getBeginIndex()
Get the start index of the text.
Specified by: java.text.CharacterIterator.- Specified by:
getBeginIndexin interfacejava.text.CharacterIterator
-
getEndIndex
int getEndIndex()
Get the end index of the text.
Specified by: java.text.CharacterIterator.- Specified by:
getEndIndexin interfacejava.text.CharacterIterator
-
getIndex
int getIndex()
Get the current index.
Specified by: java.text.CharacterIterator.- Specified by:
getIndexin interfacejava.text.CharacterIterator
-
last
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:
lastin interfacejava.text.CharacterIterator
-
next
char next()
Increments the iterator's index by one, returning the next character.- Specified by:
nextin interfacejava.text.CharacterIterator- Returns:
- the character at the new index.
Specified by: java.text.CharacterIterator.
-
previous
char previous()
Decrements the iterator's index by one and returns the character at the new index.
Specified by: java.text.CharacterIterator.- Specified by:
previousin interfacejava.text.CharacterIterator
-
setIndex
char setIndex(int position)
Sets the position to the specified position in the text.- Specified by:
setIndexin interfacejava.text.CharacterIterator- Parameters:
position- The new (current) index into the text.- Returns:
- the character at new index position.
Specified by: java.text.CharacterIterator.
-
-