org.apache.batik.gvt.font

Class AWTGVTFont

public class AWTGVTFont extends Object implements GVTFont

This is a wrapper class for a java.awt.Font instance.
Field Summary
protected FontawtFont
static floatFONT_SIZE
protected floatscale
protected floatsize
Constructor Summary
AWTGVTFont(Font font)
Creates a new AWTGVTFont that wraps the given Font.
AWTGVTFont(Font font, float scale)
Creates a new AWTGVTFont that wraps the given Font.
AWTGVTFont(Map attributes)
Creates a new AWTGVTFont with the specified attributes.
AWTGVTFont(String name, int style, int size)
Creates a new AWTGVTFont from the specified name, style and point size.
Method Summary
booleancanDisplay(char c)
Checks if this font can display the specified character.
intcanDisplayUpTo(char[] text, int start, int limit)
Indicates whether or not this font can display the characters in the specified text starting at start and ending at limit.
intcanDisplayUpTo(CharacterIterator iter, int start, int limit)
Indicates whether or not this font can display the the characters in the specified CharacterIterator starting at start and ending at limit.
intcanDisplayUpTo(String str)
Indicates whether or not this font can display a specified String.
GVTGlyphVectorcreateGlyphVector(FontRenderContext frc, char[] chars)
Returns a new GlyphVector object created with the specified array of characters and the specified FontRenderContext.
GVTGlyphVectorcreateGlyphVector(FontRenderContext frc, CharacterIterator ci)
Returns a new GlyphVector object created with the specified CharacterIterator and the specified FontRenderContext.
GVTGlyphVectorcreateGlyphVector(FontRenderContext frc, int[] glyphCodes, CharacterIterator ci)
Returns a new GlyphVector object created with the specified integer array and the specified FontRenderContext.
GVTGlyphVectorcreateGlyphVector(FontRenderContext frc, String str)
Returns a new GlyphVector object created with the specified String and the specified FontRenderContext.
GVTFontderiveFont(float size)
Creates a new Font object by replicating the current Font object and applying a new size to it.
StringgetFamilyName()
static AWTGlyphGeometryCache.ValuegetGlyphGeometry(AWTGVTFont font, char c, GlyphVector gv, int glyphIndex, Point2D glyphPos)
Returns the geometry of the specified character.
floatgetHKern(int glyphCode1, int glyphCode2)
Returns the horizontal kerning value for this glyph pair.
GVTLineMetricsgetLineMetrics(char[] chars, int beginIndex, int limit, FontRenderContext frc)
Returns a LineMetrics object created with the specified arguments.
GVTLineMetricsgetLineMetrics(CharacterIterator ci, int beginIndex, int limit, FontRenderContext frc)
Returns a GVTLineMetrics object created with the specified arguments.
GVTLineMetricsgetLineMetrics(String str, FontRenderContext frc)
Returns a GVTLineMetrics object created with the specified String and FontRenderContext.
GVTLineMetricsgetLineMetrics(String str, int beginIndex, int limit, FontRenderContext frc)
Returns a GVTLineMetrics object created with the specified arguments.
floatgetSize()
Returns the size of this font.
floatgetVKern(int glyphCode1, int glyphCode2)
Returns the vertical kerning value for this glyph pair.

Field Detail

awtFont

protected Font awtFont

FONT_SIZE

public static final float FONT_SIZE

scale

protected float scale

size

protected float size

Constructor Detail

AWTGVTFont

public AWTGVTFont(Font font)
Creates a new AWTGVTFont that wraps the given Font.

Parameters: font The font object to wrap.

AWTGVTFont

public AWTGVTFont(Font font, float scale)
Creates a new AWTGVTFont that wraps the given Font.

Parameters: font The font object to wrap. scale The scale factor to apply to font...

AWTGVTFont

public AWTGVTFont(Map attributes)
Creates a new AWTGVTFont with the specified attributes.

Parameters: attributes Contains attributes of the font to create.

AWTGVTFont

public AWTGVTFont(String name, int style, int size)
Creates a new AWTGVTFont from the specified name, style and point size.

Parameters: name The name of the new font. style The required font style. size The required font size.

Method Detail

canDisplay

public boolean canDisplay(char c)
Checks if this font can display the specified character.

Parameters: c The character to check.

Returns: Whether or not the character can be displayed.

canDisplayUpTo

public int canDisplayUpTo(char[] text, int start, int limit)
Indicates whether or not this font can display the characters in the specified text starting at start and ending at limit.

Parameters: text An array containing the characters to check. start The index of the first character to check. limit The index of the last character to check.

Returns: The index of the first char this font cannot display. Will be -1 if it can display all characters in the specified range.

canDisplayUpTo

public int canDisplayUpTo(CharacterIterator iter, int start, int limit)
Indicates whether or not this font can display the the characters in the specified CharacterIterator starting at start and ending at limit.

canDisplayUpTo

public int canDisplayUpTo(String str)
Indicates whether or not this font can display a specified String.

createGlyphVector

public GVTGlyphVector createGlyphVector(FontRenderContext frc, char[] chars)
Returns a new GlyphVector object created with the specified array of characters and the specified FontRenderContext.

createGlyphVector

public GVTGlyphVector createGlyphVector(FontRenderContext frc, CharacterIterator ci)
Returns a new GlyphVector object created with the specified CharacterIterator and the specified FontRenderContext.

createGlyphVector

public GVTGlyphVector createGlyphVector(FontRenderContext frc, int[] glyphCodes, CharacterIterator ci)
Returns a new GlyphVector object created with the specified integer array and the specified FontRenderContext.

createGlyphVector

public GVTGlyphVector createGlyphVector(FontRenderContext frc, String str)
Returns a new GlyphVector object created with the specified String and the specified FontRenderContext.

deriveFont

public GVTFont deriveFont(float size)
Creates a new Font object by replicating the current Font object and applying a new size to it.

getFamilyName

public String getFamilyName()

getGlyphGeometry

public static AWTGlyphGeometryCache.Value getGlyphGeometry(AWTGVTFont font, char c, GlyphVector gv, int glyphIndex, Point2D glyphPos)
Returns the geometry of the specified character. This method also put the in cache the geometry associated to the specified character if needed.

getHKern

public float getHKern(int glyphCode1, int glyphCode2)
Returns the horizontal kerning value for this glyph pair.

getLineMetrics

public GVTLineMetrics getLineMetrics(char[] chars, int beginIndex, int limit, FontRenderContext frc)
Returns a LineMetrics object created with the specified arguments.

getLineMetrics

public GVTLineMetrics getLineMetrics(CharacterIterator ci, int beginIndex, int limit, FontRenderContext frc)
Returns a GVTLineMetrics object created with the specified arguments.

getLineMetrics

public GVTLineMetrics getLineMetrics(String str, FontRenderContext frc)
Returns a GVTLineMetrics object created with the specified String and FontRenderContext.

getLineMetrics

public GVTLineMetrics getLineMetrics(String str, int beginIndex, int limit, FontRenderContext frc)
Returns a GVTLineMetrics object created with the specified arguments.

getSize

public float getSize()
Returns the size of this font.

getVKern

public float getVKern(int glyphCode1, int glyphCode2)
Returns the vertical kerning value for this glyph pair.
Copyright B) 2007 Apache Software Foundation. All Rights Reserved.