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.AttributedCharacterIteratorAttributedCharacterSpanIterator 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.- Version:
- $Id: AttributedCharacterSpanIterator.java 1733416 2016-03-03 07:07:13Z gadams $
-
-
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.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.charsetIndex(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:
getAllAttributeKeysin 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:
getAttributein interfacejava.text.AttributedCharacterIterator
-
getAttributes
public java.util.Map getAttributes()
Returns a map with the attributes defined on the current character.- Specified by:
getAttributesin 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:
getRunLimitin 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:
getRunLimitin 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:
getRunLimitin 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:
getRunStartin 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:
getRunStartin 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:
getRunStartin 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:
clonein interfacejava.text.CharacterIterator- Overrides:
clonein 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:
currentin interfacejava.text.CharacterIterator
-
first
public 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
public int getBeginIndex()
Get the start index of the text.
Specified by: java.text.CharacterIterator.- Specified by:
getBeginIndexin interfacejava.text.CharacterIterator
-
getEndIndex
public int getEndIndex()
Get the end index of the text.
Specified by: java.text.CharacterIterator.- Specified by:
getEndIndexin interfacejava.text.CharacterIterator
-
getIndex
public int getIndex()
Get the current index.
Specified by: java.text.CharacterIterator.- Specified by:
getIndexin 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:
lastin interfacejava.text.CharacterIterator
-
next
public 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
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:
previousin interfacejava.text.CharacterIterator
-
setIndex
public 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.
-
-