Package org.apache.batik.gvt.text
Class AttributedCharacterSpanIterator
java.lang.Object
org.apache.batik.gvt.text.AttributedCharacterSpanIterator
- All Implemented Interfaces:
Cloneable
,AttributedCharacterIterator
,CharacterIterator
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.
- Version:
- $Id: AttributedCharacterSpanIterator.java 1733416 2016-03-03 07:07:13Z gadams $
-
Nested Class Summary
Nested classes/interfaces inherited from interface java.text.AttributedCharacterIterator
AttributedCharacterIterator.Attribute
-
Field Summary
FieldsFields inherited from interface java.text.CharacterIterator
DONE
-
Constructor Summary
ConstructorsConstructorDescriptionAttributedCharacterSpanIterator
(AttributedCharacterIterator aci, int start, int stop) Construct a AttributedCharacterSpanIterator from a subinterval of an existing AttributedCharacterIterator. -
Method Summary
Modifier and TypeMethodDescriptionclone()
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().Get the keys of all attributes defined on the iterator's text range.Get the value of the named attribute for the current character.Returns a map with the attributes defined on the current character.int
Get the start index of the text.int
Get the end index of the text.int
getIndex()
Get the current index.int
Get the index of the first character following the run with respect to all attributes containing the current character.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.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
Get the index of the first character of the run with respect to all attributes containing the current character.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.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.
-
Field Details
-
aci
-
begin
private int begin -
end
private int end
-
-
Constructor Details
-
AttributedCharacterSpanIterator
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 Details
-
getAllAttributeKeys
Get the keys of all attributes defined on the iterator's text range.- Specified by:
getAllAttributeKeys
in interfaceAttributedCharacterIterator
-
getAttribute
Get the value of the named attribute for the current character.- Specified by:
getAttribute
in interfaceAttributedCharacterIterator
-
getAttributes
Returns a map with the attributes defined on the current character.- Specified by:
getAttributes
in interfaceAttributedCharacterIterator
-
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 interfaceAttributedCharacterIterator
-
getRunLimit
Get the index of the first character following the run with respect to the given attribute containing the current character.- Specified by:
getRunLimit
in interfaceAttributedCharacterIterator
-
getRunLimit
Get the index of the first character following the run with respect to the given attributes containing the current character.- Specified by:
getRunLimit
in interfaceAttributedCharacterIterator
-
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 interfaceAttributedCharacterIterator
-
getRunStart
Get the index of the first character of the run with respect to the given attribute containing the current character.- Specified by:
getRunStart
in interfaceAttributedCharacterIterator
- Parameters:
attribute
- The attribute for whose appearance the first offset is requested.
-
getRunStart
Get the index of the first character of the run with respect to the given attributes containing the current character.- Specified by:
getRunStart
in interfaceAttributedCharacterIterator
- Parameters:
attributes
- the Set of attributes which begins at the returned index.
-
clone
Create a copy of this iterator- Specified by:
clone
in interfaceCharacterIterator
- Overrides:
clone
in classObject
-
current
public char current()Get the character at the current position (as returned by getIndex()).
Specified by: java.text.CharacterIterator.- Specified by:
current
in interfaceCharacterIterator
-
first
public char first()Sets the position to getBeginIndex().- Specified by:
first
in interfaceCharacterIterator
- 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 interfaceCharacterIterator
-
getEndIndex
public int getEndIndex()Get the end index of the text.
Specified by: java.text.CharacterIterator.- Specified by:
getEndIndex
in interfaceCharacterIterator
-
getIndex
public int getIndex()Get the current index.
Specified by: java.text.CharacterIterator.- Specified by:
getIndex
in interfaceCharacterIterator
-
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 interfaceCharacterIterator
-
next
public char next()Increments the iterator's index by one, returning the next character.- Specified by:
next
in interfaceCharacterIterator
- 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 interfaceCharacterIterator
-
setIndex
public char setIndex(int position) Sets the position to the specified position in the text.- Specified by:
setIndex
in interfaceCharacterIterator
- Parameters:
position
- The new (current) index into the text.- Returns:
- the character at new index position.
Specified by: java.text.CharacterIterator.
-