GlyphIterator (Apache Batik Javadoc)

java.lang.Object
- org.apache.batik.extension.svg.GlyphIterator

public class GlyphIterator
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static AttributedCharacterIterator.Attribute`	`FLOW_LINE_BREAK`
`static AttributedCharacterIterator.Attribute`	`GVT_FONT`
`static AttributedCharacterIterator.Attribute`	`PREFORMATTED`
`static char`	`SOFT_HYPHEN`
`static AttributedCharacterIterator.Attribute`	`TEXT_COMPOUND_ID`
`static char`	`ZERO_WIDTH_JOINER`
`static char`	`ZERO_WIDTH_SPACE`

Constructor Summary

Constructors
Constructor and Description

GlyphIterator(AttributedCharacterIterator aci, GVTGlyphVector gv)

GlyphIterator(GlyphIterator gi)

Constructors
Constructor and Description
`GlyphIterator(AttributedCharacterIterator aci, GVTGlyphVector gv)`
`GlyphIterator(GlyphIterator gi)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addLeftShift(int idx, float chAdv)`
`GlyphIterator`	`copy()`
`GlyphIterator`	`copy(GlyphIterator gi)`
`boolean`	`done()`
`int`	`getACIIndex()`
`float`	`getAdj()`
`float`	`getAdv()`
`char`	`getChar()`
`float`	`getCharAdvance()` Get the advance associated with the current glyph
`protected float`	`getCharAdvance(int gvIdx)` Get the advance associated with any glyph
`float`	`getCharWidth()` Get the visual advance associated with the current glyph.
`protected float`	`getCharWidth(int gvIdx)` Get the visual advance associated with the current glyph.
`int`	`getGlyphIndex()`
`int`	`getLineBreaks()`
`float`	`getMaxAscent()`
`float`	`getMaxDescent()`
`float`	`getMaxFontSize()`
`Point2D`	`getOrigin()`
`boolean`	`isBreakChar()`
`boolean`	`isLastChar()`
`boolean`	`isPrinting()`
`protected boolean`	`isPrinting(char tstCH)`
`LineInfo`	`newLine(Point2D.Float loc, float lineWidth, boolean partial, Point2D.Float verticalAlignOffset)`
`void`	`nextChar()` Move iterator to the next char.
`protected void`	`updateLineMetrics(int end)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PREFORMATTED

public static final AttributedCharacterIterator.Attribute PREFORMATTED

FLOW_LINE_BREAK

public static final AttributedCharacterIterator.Attribute FLOW_LINE_BREAK

TEXT_COMPOUND_ID

public static final AttributedCharacterIterator.Attribute TEXT_COMPOUND_ID

GVT_FONT

public static final AttributedCharacterIterator.Attribute GVT_FONT

SOFT_HYPHEN
```
public static final char SOFT_HYPHEN
```
See Also:
Constant Field Values

ZERO_WIDTH_SPACE
```
public static final char ZERO_WIDTH_SPACE
```
See Also:
Constant Field Values

ZERO_WIDTH_JOINER
```
public static final char ZERO_WIDTH_JOINER
```
See Also:
Constant Field Values

Constructor Detail

GlyphIterator

public GlyphIterator(AttributedCharacterIterator aci,
             GVTGlyphVector gv)

GlyphIterator

public GlyphIterator(GlyphIterator gi)

Method Detail
- copy
```
public GlyphIterator copy()
```
- copy
```
public GlyphIterator copy(GlyphIterator gi)
```
- getGlyphIndex
```
public int getGlyphIndex()
```
  Returns:
  The index into glyph vector for current character.
- getChar
```
public char getChar()
```
  Returns:
  the current character.
- getACIIndex
```
public int getACIIndex()
```
  Returns:
  The index into Attributed Character iterator for current character.
- getAdv
```
public float getAdv()
```
  Returns:
  The current advance for the line, this is the 'visual width' of the current line.
- getOrigin
```
public Point2D getOrigin()
```
  Returns:
  The origin of the glyph vector (the point all glyphs are layed out with respect to).
- getAdj
```
public float getAdj()
```
  Returns:
  The current adjustment for the line. This is the ammount that needs to be subracted from the following line to get it back to the start of the next line.
- getMaxFontSize
```
public float getMaxFontSize()
```
- getMaxAscent
```
public float getMaxAscent()
```
- getMaxDescent
```
public float getMaxDescent()
```
- isLastChar
```
public boolean isLastChar()
```
- done
```
public boolean done()
```
- isBreakChar
```
public boolean isBreakChar()
```
- isPrinting
```
protected boolean isPrinting(char tstCH)
```
- getLineBreaks
```
public int getLineBreaks()
```
- nextChar
```
public void nextChar()
```
  Move iterator to the next char.
- addLeftShift
```
protected void addLeftShift(int idx,
                float chAdv)
```
- updateLineMetrics
```
protected void updateLineMetrics(int end)
```
- newLine
```
public LineInfo newLine(Point2D.Float loc,
               float lineWidth,
               boolean partial,
               Point2D.Float verticalAlignOffset)
```
- isPrinting
```
public boolean isPrinting()
```
- getCharAdvance
```
public float getCharAdvance()
```
  Get the advance associated with the current glyph
- getCharWidth
```
public float getCharWidth()
```
  Get the visual advance associated with the current glyph. This is the distance from the location of the glyph to the rightmost part of the glyph.
- getCharAdvance
```
protected float getCharAdvance(int gvIdx)
```
  Get the advance associated with any glyph
- getCharWidth
```
protected float getCharWidth(int gvIdx)
```
  Get the visual advance associated with the current glyph. This is the distance from the location of the glyph to the rightmost part of the glyph.

Class GlyphIterator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PREFORMATTED

FLOW_LINE_BREAK

TEXT_COMPOUND_ID

GVT_FONT

SOFT_HYPHEN

ZERO_WIDTH_SPACE

ZERO_WIDTH_JOINER

Constructor Detail

GlyphIterator

GlyphIterator

Method Detail

copy

copy

getGlyphIndex

getChar

getACIIndex

getAdv

getOrigin

getAdj

getMaxFontSize

getMaxAscent

getMaxDescent

isLastChar

done

isBreakChar

isPrinting

getLineBreaks

nextChar

addLeftShift

updateLineMetrics

newLine

isPrinting

getCharAdvance

getCharWidth

getCharAdvance

getCharWidth