Package org.apache.batik.gvt.text
Class AttributedCharacterSpanIterator
- java.lang.Object
-
- org.apache.batik.gvt.text.AttributedCharacterSpanIterator
-
- All Implemented Interfaces:
java.lang.Cloneable
,java.text.AttributedCharacterIterator
,java.text.CharacterIterator
public class AttributedCharacterSpanIterator extends java.lang.Object implements java.text.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
Constructors Constructor Description AttributedCharacterSpanIterator(java.text.AttributedCharacterIterator aci, int start, int stop)
Construct a AttributedCharacterSpanIterator from a subinterval of an existing AttributedCharacterIterator.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
Create a copy of this iteratorchar
current()
Get the character at the current position (as returned by getIndex()).char
first()
Sets the position to getBeginIndex().java.util.Set
getAllAttributeKeys()
Get the keys of all attributes defined on the iterator's text range.java.lang.Object
getAttribute(java.text.AttributedCharacterIterator.Attribute attribute)
Get the value of the named attribute for the current character.java.util.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(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.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.int
getRunStart()
Get the index of the first character of the run with respect to all attributes containing the current character.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.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.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(java.text.AttributedCharacterIterator aci, int start, int stop)
Construct a AttributedCharacterSpanIterator from a subinterval of an existing AttributedCharacterIterator.- Parameters:
aci
- The source AttributedCharacterIteratorstart
- the first index of the subintervalstop
- the index of the first character after the subinterval
-
-
Method Detail
-
getAllAttributeKeys
public java.util.Set getAllAttributeKeys()
Get the keys of all attributes defined on the iterator's text range.- Specified by:
getAllAttributeKeys
in interfacejava.text.AttributedCharacterIterator
-
getAttribute
public java.lang.Object getAttribute(java.text.AttributedCharacterIterator.Attribute attribute)
Get the value of the named attribute for the current character.- Specified by:
getAttribute
in interfacejava.text.AttributedCharacterIterator
-
getAttributes
public java.util.Map getAttributes()
Returns a map with the attributes defined on the current character.- Specified by:
getAttributes
in interfacejava.text.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 interfacejava.text.AttributedCharacterIterator
-
getRunLimit
public 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:
getRunLimit
in interfacejava.text.AttributedCharacterIterator
-
getRunLimit
public 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:
getRunLimit
in interfacejava.text.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 interfacejava.text.AttributedCharacterIterator
-
getRunStart
public 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:
getRunStart
in interfacejava.text.AttributedCharacterIterator
- Parameters:
attribute
- The attribute for whose appearance the first offset is requested.
-
getRunStart
public 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:
getRunStart
in interfacejava.text.AttributedCharacterIterator
- Parameters:
attributes
- the Set of attributes which begins at the returned index.
-
clone
public java.lang.Object clone()
Create a copy of this iterator- Specified by:
clone
in interfacejava.text.CharacterIterator
- Overrides:
clone
in classjava.lang.Object
-
current
public char current()
Get the character at the current position (as returned by getIndex()).
Specified by: java.text.CharacterIterator.- Specified by:
current
in interfacejava.text.CharacterIterator
-
first
public char first()
Sets the position to getBeginIndex().- Specified by:
first
in interfacejava.text.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 interfacejava.text.CharacterIterator
-
getEndIndex
public int getEndIndex()
Get the end index of the text.
Specified by: java.text.CharacterIterator.- Specified by:
getEndIndex
in interfacejava.text.CharacterIterator
-
getIndex
public int getIndex()
Get the current index.
Specified by: java.text.CharacterIterator.- Specified by:
getIndex
in interfacejava.text.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 interfacejava.text.CharacterIterator
-
next
public char next()
Increments the iterator's index by one, returning the next character.- Specified by:
next
in interfacejava.text.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 interfacejava.text.CharacterIterator
-
setIndex
public char setIndex(int position)
Sets the position to the specified position in the text.- Specified by:
setIndex
in interfacejava.text.CharacterIterator
- Parameters:
position
- The new (current) index into the text.- Returns:
- the character at new index position.
Specified by: java.text.CharacterIterator.
-
-