org.apache.batik.gvt.text

Class BidiAttributedCharacterIterator

public class BidiAttributedCharacterIterator extends Object implements AttributedCharacterIterator

An attributed character iterator that does the reordering of the characters for bidirectional text. It reorders the characters so they are in visual order. It also assigns a BIDI_LEVEL attribute to each character which can be used to split the reordered ACI into text runs based on direction. ie. characters in a text run will all have the same bidi level.
Constructor Summary
protected BidiAttributedCharacterIterator(AttributedCharacterIterator reorderedACI, FontRenderContext frc, int chunkStart, int[] newCharOrder)
BidiAttributedCharacterIterator(AttributedCharacterIterator aci, FontRenderContext frc, int chunkStart)
Constructs a character iterator that represents the visual display order of characters within bidirectional text.
Method Summary
Objectclone()
Creates a copy of this iterator.
charcurrent()
Gets the character at the current position (as returned by getIndex()).
charfirst()
Sets the position to getBeginIndex() and returns the character at that position.
SetgetAllAttributeKeys()
Get the keys of all attributes defined on the iterator's text range.
ObjectgetAttribute(Attribute attribute)
Get the value of the named attribute for the current character.
MapgetAttributes()
Returns a map with the attributes defined on the current character.
intgetBeginIndex()
Returns the start index of the text.
int[]getCharMap()
intgetEndIndex()
Returns the end index of the text.
intgetIndex()
Returns the current index.
intgetRunLimit()
Get the index of the first character following the run with respect to all attributes containing the current character.
intgetRunLimit(Attribute attribute)
Get the index of the first character following the run with respect to the given attribute containing the current character.
intgetRunLimit(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(Attribute attribute)
Get the index of the first character of the run with respect to the given attribute containing the current character.
intgetRunStart(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.
static intmirrorChar(int c)
charnext()
Increments the iterator's index by one and returns the character at the new index.
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 and returns that character.

Constructor Detail

BidiAttributedCharacterIterator

protected BidiAttributedCharacterIterator(AttributedCharacterIterator reorderedACI, FontRenderContext frc, int chunkStart, int[] newCharOrder)

BidiAttributedCharacterIterator

public BidiAttributedCharacterIterator(AttributedCharacterIterator aci, FontRenderContext frc, int chunkStart)
Constructs a character iterator that represents the visual display order of characters within bidirectional text.

Parameters: aci The character iterator containing the characters in logical order. frc The current font render context

Method Detail

clone

public Object clone()
Creates a copy of this iterator.

current

public char current()
Gets the character at the current position (as returned by getIndex()).

first

public char first()
Sets the position to getBeginIndex() and returns the character at that position.

getAllAttributeKeys

public Set getAllAttributeKeys()
Get the keys of all attributes defined on the iterator's text range.

getAttribute

public Object getAttribute(Attribute attribute)
Get the value of the named attribute for the current character.

getAttributes

public Map getAttributes()
Returns a map with the attributes defined on the current character.

getBeginIndex

public int getBeginIndex()
Returns the start index of the text.

getCharMap

public int[] getCharMap()

getEndIndex

public int getEndIndex()
Returns the end index of the text.

getIndex

public int getIndex()
Returns the current index.

getRunLimit

public int getRunLimit()
Get the index of the first character following the run with respect to all attributes containing the current character.

getRunLimit

public int getRunLimit(Attribute attribute)
Get the index of the first character following the run with respect to the given attribute containing the current character.

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.

getRunStart

public int getRunStart()
Get the index of the first character of the run with respect to all attributes containing the current character.

getRunStart

public int getRunStart(Attribute attribute)
Get the index of the first character of the run with respect to the given attribute containing the current character.

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.

Parameters: attributes the Set of attributes which begins at the returned index.

last

public char last()
Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty) and returns the character at that position.

mirrorChar

public static int mirrorChar(int c)

Parameters: c the character to 'mirror'

Returns: either the 'mirror'-character for c or c itself

next

public char next()
Increments the iterator's index by one and returns the character at the new index.

previous

public char previous()
Decrements the iterator's index by one and returns the character at the new index.

setIndex

public char setIndex(int position)
Sets the position to the specified position in the text and returns that character.
Copyright B) 2007 Apache Software Foundation. All Rights Reserved.