org.apache.batik.gvt.font
Interface GVTGlyphVector

All Known Implementing Classes:

MultiGlyphVector, AWTGVTGlyphVector, SVGGVTGlyphVector

public interface GVTGlyphVector

An interface for all GVT GlyphVector classes.

Method Summary

void	draw(java.awt.Graphics2D graphics2D, java.text.AttributedCharacterIterator aci) Draws the glyph vector.
java.awt.geom.Rectangle2D	getBounds2D(java.text.AttributedCharacterIterator aci) Returns a tight bounds on the GylphVector including stroking.
int	getCharacterCount(int startGlyphIndex, int endGlyphIndex) Returns the number of chars represented by the glyphs within the specified range.
GVTFont	getFont() Returns the Font associated with this GlyphVector.
java.awt.font.FontRenderContext	getFontRenderContext() Returns the FontRenderContext associated with this GlyphVector.
java.awt.geom.Rectangle2D	getGeometricBounds() Returns the visual bounds of this GlyphVector The visual bounds is the tightest rectangle enclosing all non-background pixels in the rendered representation of this GlyphVector.
int	getGlyphCode(int glyphIndex) Returns the glyphcode of the specified glyph.
int[]	getGlyphCodes(int beginGlyphIndex, int numEntries, int[] codeReturn) Returns an array of glyphcodes for the specified glyphs.
java.awt.font.GlyphJustificationInfo	getGlyphJustificationInfo(int glyphIndex) Returns the justification information for the glyph at the specified index into this GlyphVector.
java.awt.Shape	getGlyphLogicalBounds(int glyphIndex) Returns the logical bounds of the specified glyph within this GlyphVector.
GVTGlyphMetrics	getGlyphMetrics(int glyphIndex) Returns the metrics of the glyph at the specified index into this GlyphVector.
java.awt.Shape	getGlyphOutline(int glyphIndex) Returns a Shape whose interior corresponds to the visual representation of the specified glyph within this GlyphVector.
java.awt.geom.Point2D	getGlyphPosition(int glyphIndex) Returns the position of the specified glyph within this GlyphVector.
float[]	getGlyphPositions(int beginGlyphIndex, int numEntries, float[] positionReturn) Returns an array of glyph positions for the specified glyphs
java.awt.geom.AffineTransform	getGlyphTransform(int glyphIndex) Gets the transform of the specified glyph within this GlyphVector.
java.awt.Shape	getGlyphVisualBounds(int glyphIndex) Returns the visual bounds of the specified glyph within the GlyphVector.
java.awt.geom.Rectangle2D	getLogicalBounds() Returns the logical bounds of this GlyphVector.
int	getNumGlyphs() Returns the number of glyphs in this GlyphVector.
java.awt.Shape	getOutline() Returns a Shape whose interior corresponds to the visual representation of this GlyphVector.
java.awt.Shape	getOutline(float x, float y) Returns a Shape whose interior corresponds to the visual representation of this GlyphVector, offset to x, y.
boolean	isGlyphVisible(int glyphIndex) Returns true if specified glyph will be drawn.
void	performDefaultLayout() Assigns default positions to each glyph in this GlyphVector.
void	setGlyphPosition(int glyphIndex, java.awt.geom.Point2D newPos) Sets the position of the specified glyph within this GlyphVector.
void	setGlyphTransform(int glyphIndex, java.awt.geom.AffineTransform newTX) Sets the transform of the specified glyph within this GlyphVector.
void	setGlyphVisible(int glyphIndex, boolean visible) Tells the glyph vector whether or not to draw the specified glyph.

Method Detail

getFont

public GVTFont getFont()

Returns the Font associated with this GlyphVector.

getFontRenderContext

public java.awt.font.FontRenderContext getFontRenderContext()

Returns the FontRenderContext associated with this GlyphVector.

getGlyphCode

public int getGlyphCode(int glyphIndex)

Returns the glyphcode of the specified glyph.

getGlyphCodes

public int[] getGlyphCodes(int beginGlyphIndex,
                           int numEntries,
                           int[] codeReturn)

Returns an array of glyphcodes for the specified glyphs.

getGlyphJustificationInfo

public java.awt.font.GlyphJustificationInfo getGlyphJustificationInfo(int glyphIndex)

Returns the justification information for the glyph at the specified index into this GlyphVector.

getGlyphLogicalBounds

public java.awt.Shape getGlyphLogicalBounds(int glyphIndex)

Returns the logical bounds of the specified glyph within this GlyphVector. This is a good bound for hit detection and highlighting it is not tight in any sense, and in some (rare) cases may exclude parts of the glyph.

getGlyphMetrics

public GVTGlyphMetrics getGlyphMetrics(int glyphIndex)

Returns the metrics of the glyph at the specified index into this GlyphVector.

getGlyphOutline

public java.awt.Shape getGlyphOutline(int glyphIndex)

Returns a Shape whose interior corresponds to the visual representation of the specified glyph within this GlyphVector.

getGlyphPosition

public java.awt.geom.Point2D getGlyphPosition(int glyphIndex)

Returns the position of the specified glyph within this GlyphVector.

getGlyphPositions

public float[] getGlyphPositions(int beginGlyphIndex,
                                 int numEntries,
                                 float[] positionReturn)

Returns an array of glyph positions for the specified glyphs

getGlyphTransform

public java.awt.geom.AffineTransform getGlyphTransform(int glyphIndex)

Gets the transform of the specified glyph within this GlyphVector.

getGlyphVisualBounds

public java.awt.Shape getGlyphVisualBounds(int glyphIndex)

Returns the visual bounds of the specified glyph within the GlyphVector.

getLogicalBounds

public java.awt.geom.Rectangle2D getLogicalBounds()

Returns the logical bounds of this GlyphVector. This is a good bound for hit detection and highlighting it is not tight in any sense, and in some (rare) * cases may exclude parts of the glyph.

getNumGlyphs

public int getNumGlyphs()

Returns the number of glyphs in this GlyphVector.

getOutline

public java.awt.Shape getOutline()

Returns a Shape whose interior corresponds to the visual representation of this GlyphVector.

getOutline

public java.awt.Shape getOutline(float x,
                                 float y)

Returns a Shape whose interior corresponds to the visual representation of this GlyphVector, offset to x, y.

getGeometricBounds

public java.awt.geom.Rectangle2D getGeometricBounds()

Returns the visual bounds of this GlyphVector The visual bounds is the tightest rectangle enclosing all non-background pixels in the rendered representation of this GlyphVector.

getBounds2D

public java.awt.geom.Rectangle2D getBounds2D(java.text.AttributedCharacterIterator aci)

Returns a tight bounds on the GylphVector including stroking.

Parameters:

aci - Required to get painting attributes of glyphVector.

performDefaultLayout

public void performDefaultLayout()

Assigns default positions to each glyph in this GlyphVector.

setGlyphPosition

public void setGlyphPosition(int glyphIndex,
                             java.awt.geom.Point2D newPos)

Sets the position of the specified glyph within this GlyphVector.

setGlyphTransform

public void setGlyphTransform(int glyphIndex,
                              java.awt.geom.AffineTransform newTX)

Sets the transform of the specified glyph within this GlyphVector.

setGlyphVisible

public void setGlyphVisible(int glyphIndex,
                            boolean visible)

Tells the glyph vector whether or not to draw the specified glyph.

isGlyphVisible

public boolean isGlyphVisible(int glyphIndex)

Returns true if specified glyph will be drawn.

getCharacterCount

public int getCharacterCount(int startGlyphIndex,
                             int endGlyphIndex)

Returns the number of chars represented by the glyphs within the specified range.

Parameters:

startGlyphIndex - The index of the first glyph in the range.

endGlyphIndex - The index of the last glyph in the range.

Returns:

The number of chars.

draw

public void draw(java.awt.Graphics2D graphics2D,
                 java.text.AttributedCharacterIterator aci)

Draws the glyph vector.