java.awt
Class Font

java.lang.Object
  java.awt.Font

All Implemented Interfaces:

java.io.Serializable

public class Font

extends java.lang.Object

implements java.io.Serializable

The Font class represents fonts, which are used to render text in a visible way. A font provides the information needed to map sequences of characters to sequences of glyphs and to render sequences of glyphs on Graphics and Component objects.

Characters and Glyphs

A character is a symbol that represents an item such as a letter, a digit, or punctuation in an abstract way. For example, 'g', LATIN SMALL LETTER G, is a character.

A glyph is a shape used to render a character or a sequence of characters. In simple writing systems, such as Latin, typically one glyph represents one character. In general, however, characters and glyphs do not have one-to-one correspondence. For example, the character 'á' LATIN SMALL LETTER A WITH ACUTE, can be represented by two glyphs: one for 'a' and one for '´'. On the other hand, the two-character string "fi" can be represented by a single glyph, an "fi" ligature. In complex writing systems, such as Arabic or the South and South-East Asian writing systems, the relationship between characters and glyphs can be more complicated and involve context-dependent selection of glyphs as well as glyph reordering. A font encapsulates the collection of glyphs needed to render a selected set of characters as well as the tables needed to map sequences of characters to corresponding sequences of glyphs.

Physical and Logical Fonts

The Java 2 platform distinguishes between two kinds of fonts: physical fonts and logical fonts.

Physical fonts are the actual font libraries containing glyph data and tables to map from character sequences to glyph sequences, using a font technology such as TrueType or PostScript Type 1. Physical fonts may use names such as Helvetica, Palatino, HonMincho, or any number of other font names. Typically, each physical font supports only a limited set of writing systems, for example, only Latin characters or only Japanese and Basic Latin. The set of available physical fonts varies between configurations.

Logical fonts are the five font families defined by the Java platform which must be supported by any Java runtime environment: Serif, SansSerif, Monospaced, Dialog, and DialogInput. These logical fonts are not actual font libraries. Instead, the logical font names are mapped to physical fonts by the Java runtime environment. The mapping is implementation and usually locale dependent, so the look and the metrics provided by them vary. Typically, each logical font name maps to several physical fonts in order to cover a large range of characters.

For a discussion of the relative advantages and disadvantages of using physical or logical fonts, see the Internationalization FAQ document.

Font Faces and Names

A Font can have many faces, such as heavy, medium, oblique, gothic and regular. All of these faces have similar typographic design.

There are three different names that you can get from a Font object. The logical font name is simply the name that was used to construct the font. The font face name, or just font name for short, is the name of a particular font face, like Helvetica Bold. The family name is the name of the font family that determines the typographic design across several faces, like Helvetica.

The Font class represents an instance of a font face from a collection of font faces that are present in the system resources of the host system. As examples, Arial Bold and Courier Bold Italic are font faces. There can be several Font objects associated with a font face, each differing in size, style, transform and font features.

See Also:

Serialized Form

Field Summary

static int	BOLD The bold style constant.
static int	CENTER_BASELINE The baseline used in ideographic scripts like Chinese, Japanese, and Korean when laying out text.
static int	HANGING_BASELINE The baseline used in Devanigiri and similar scripts when laying out text.
static int	ITALIC The italicized style constant.
static int	LAYOUT_LEFT_TO_RIGHT A flag to layoutGlyphVector indicating that text is left-to-right as determined by Bidi analysis.
static int	LAYOUT_NO_LIMIT_CONTEXT A flag to layoutGlyphVector indicating that text in the char array after the indicated limit should not be examined.
static int	LAYOUT_NO_START_CONTEXT A flag to layoutGlyphVector indicating that text in the char array before the indicated start should not be examined.
static int	LAYOUT_RIGHT_TO_LEFT A flag to layoutGlyphVector indicating that text is right-to-left as determined by Bidi analysis.
protected java.lang.String	name The logical name of this Font, as passed to the constructor.
static int	PLAIN The plain style constant.
protected float	pointSize The point size of this Font in float.
static int	ROMAN_BASELINE The baseline used in most Roman scripts when laying out text.
protected int	size The point size of this Font, rounded to integer.
protected int	style The style of this Font, as passed to the constructor.
static int	TRUETYPE_FONT Create a Font of type TRUETYPE.

Constructor Summary

Font(java.util.Map attributes)
Creates a new Font with the specified attributes.

Font(java.lang.String name, int style, int size)
Creates a new Font from the specified name, style and point size.

Method Summary

boolean	canDisplay(char c) Checks if this Font has a glyph for the specified character.
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.
int	canDisplayUpTo(java.text.CharacterIterator iter, int start, int limit) Indicates whether or not this Font can display the specified String.
int	canDisplayUpTo(java.lang.String str) Indicates whether or not this Font can display a specified String.
GlyphVector	createGlyphVector(FontRenderContext frc, char[] chars) Creates a GlyphVector by mapping characters to glyphs one-to-one based on the Unicode cmap in this Font.
GlyphVector	createGlyphVector(FontRenderContext frc, java.text.CharacterIterator ci) Creates a GlyphVector by mapping the specified characters to glyphs one-to-one based on the Unicode cmap in this Font.
GlyphVector	createGlyphVector(FontRenderContext frc, int[] glyphCodes) Creates a GlyphVector by mapping characters to glyphs one-to-one based on the Unicode cmap in this Font.
GlyphVector	createGlyphVector(FontRenderContext frc, java.lang.String str) Creates a GlyphVector by mapping characters to glyphs one-to-one based on the Unicode cmap in this Font.
static Font	decode(java.lang.String str) Returns the Font that the str argument describes.
Font	deriveFont(AffineTransform trans) Creates a new Font object by replicating the current Font object and applying a new transform to it.
Font	deriveFont(int style, float size) Creates a new Font object by replicating this Font object and applying a new style and size.
Font	deriveFont(java.util.Map attributes) Creates a new Font object by replicating the current Font object and applying a new set of font attributes to it.
boolean	equals(java.lang.Object obj) Compares this Font object to the specified Object.
java.util.Map	getAttributes() Returns a map of font attributes available in this Font.
java.text.AttributedCharacterIterator.Attribute[]	getAvailableAttributes() Returns the keys of all the attributes supported by this Font.
byte	getBaselineFor(char c) Returns the baseline appropriate for displaying this character.
java.lang.String	getFamily() Returns the family name of this Font.
java.lang.String	getFamily(java.util.Locale l) Returns the family name of this Font, localized for the specified locale.
static Font	getFont(java.util.Map attributes) Returns a Font appropriate to this attribute set.
static Font	getFont(java.lang.String nm) Returns a Font object from the system properties list.
static Font	getFont(java.lang.String nm, Font font) Gets the specified Font from the system properties list.
java.lang.String	getFontName() Returns the font face name of this Font.
java.lang.String	getFontName(java.util.Locale l) Returns the font face name of the Font, localized for the specified locale.
float	getItalicAngle() Returns the italic angle of this Font.
LineMetrics	getLineMetrics(char[] chars, int beginIndex, int limit, FontRenderContext frc) Returns a LineMetrics object created with the specified arguments.
LineMetrics	getLineMetrics(java.text.CharacterIterator ci, int beginIndex, int limit, FontRenderContext frc) Returns a LineMetrics object created with the specified arguments.
LineMetrics	getLineMetrics(java.lang.String str, FontRenderContext frc) Returns a LineMetrics object created with the specified String and FontRenderContext.
LineMetrics	getLineMetrics(java.lang.String str, int beginIndex, int limit, FontRenderContext frc) Returns a LineMetrics object created with the specified arguments.
Rectangle2D	getMaxCharBounds(FontRenderContext frc) Returns the bounds for the character with the maximum bounds as defined in the specified FontRenderContext.
int	getMissingGlyphCode() Returns the glyphCode which is used when this Font does not have a glyph for a specified unicode.
java.lang.String	getName() Returns the logical name of this Font.
int	getNumGlyphs() Returns the number of glyphs in this Font.
int	getSize() Returns the point size of this Font, rounded to an integer.
float	getSize2D() Returns the point size of this Font in float value.
Rectangle2D	getStringBounds(char[] chars, int beginIndex, int limit, FontRenderContext frc) Returns the logical bounds of the specified array of characters in the specified FontRenderContext.
Rectangle2D	getStringBounds(java.text.CharacterIterator ci, int beginIndex, int limit, FontRenderContext frc) Returns the logical bounds of the characters indexed in the specified CharacterIterator in the specified FontRenderContext.
Rectangle2D	getStringBounds(java.lang.String str, FontRenderContext frc) Returns the logical bounds of the specified String in the specified FontRenderContext.
Rectangle2D	getStringBounds(java.lang.String str, int beginIndex, int limit, FontRenderContext frc) Returns the logical bounds of the specified String in the specified FontRenderContext.
int	getStyle() Returns the style of this Font.
AffineTransform	getTransform() Returns a copy of the transform associated with this Font.
int	hashCode() Returns a hashcode for this Font.
boolean	hasUniformLineMetrics() Checks whether or not this Font has uniform line metrics.
boolean	isBold() Indicates whether or not this Font object's style is BOLD.
boolean	isItalic() Indicates whether or not this Font object's style is ITALIC.
boolean	isPlain() Indicates whether or not this Font object's style is PLAIN.
boolean	isTransformed() Indicates whether or not this Font object has a transform that affects its size in addition to the Size attribute.
GlyphVector	layoutGlyphVector(FontRenderContext frc, char[] text, int start, int limit, int flags) Returns a new GlyphVector object, performing full layout of the text if possible.
java.lang.String	toString() Converts this Font object to a String representation.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PLAIN

public static final int PLAIN

The plain style constant.

See Also:

Constant Field Values

BOLD

public static final int BOLD

The bold style constant. This can be combined with the other style constants (except PLAIN) for mixed styles.

See Also:

Constant Field Values

ITALIC

public static final int ITALIC

The italicized style constant. This can be combined with the other style constants (except PLAIN) for mixed styles.

See Also:

Constant Field Values

ROMAN_BASELINE

public static final int ROMAN_BASELINE

The baseline used in most Roman scripts when laying out text.

See Also:

Constant Field Values

CENTER_BASELINE

public static final int CENTER_BASELINE

The baseline used in ideographic scripts like Chinese, Japanese, and Korean when laying out text.

See Also:

Constant Field Values

HANGING_BASELINE

public static final int HANGING_BASELINE

The baseline used in Devanigiri and similar scripts when laying out text.

See Also:

Constant Field Values

TRUETYPE_FONT

public static final int TRUETYPE_FONT

Create a Font of type TRUETYPE. In future other types may be added to support other font types.

See Also:

Constant Field Values

name

protected java.lang.String name

The logical name of this Font, as passed to the constructor.

Since:

JDK1.0

See Also:

getName()

style

protected int style

The style of this Font, as passed to the constructor. This style can be PLAIN, BOLD, ITALIC, or BOLD+ITALIC.

Since:

JDK1.0

See Also:

getStyle()

size

protected int size

The point size of this Font, rounded to integer.

Since:

JDK1.0

See Also:

getSize()

pointSize

protected float pointSize

The point size of this Font in float.

See Also:

getSize(), getSize2D()

LAYOUT_LEFT_TO_RIGHT

public static final int LAYOUT_LEFT_TO_RIGHT

A flag to layoutGlyphVector indicating that text is left-to-right as determined by Bidi analysis.

See Also:

Constant Field Values

LAYOUT_RIGHT_TO_LEFT

public static final int LAYOUT_RIGHT_TO_LEFT

A flag to layoutGlyphVector indicating that text is right-to-left as determined by Bidi analysis.

See Also:

Constant Field Values

LAYOUT_NO_START_CONTEXT

public static final int LAYOUT_NO_START_CONTEXT

A flag to layoutGlyphVector indicating that text in the char array before the indicated start should not be examined.

See Also:

Constant Field Values

LAYOUT_NO_LIMIT_CONTEXT

public static final int LAYOUT_NO_LIMIT_CONTEXT

A flag to layoutGlyphVector indicating that text in the char array after the indicated limit should not be examined.

See Also:

Constant Field Values

Constructor Detail

Font

public Font(java.lang.String name,
            int style,
            int size)

Creates a new Font from the specified name, style and point size.

Parameters:

name - the font name. This can be a logical font name or a font face name. A logical name must be either: Dialog, DialogInput, Monospaced, Serif, or SansSerif. If name is null, the name of the new Font is set to the name "Default".

style - the style constant for the Font The style argument is an integer bitmask that may be PLAIN, or a bitwise union of BOLD and/or ITALIC (for example, ITALIC or BOLD|ITALIC). If the style argument does not conform to one of the expected integer bitmasks then the style is set to PLAIN.

size - the point size of the Font

Since:

JDK1.0

Font

public Font(java.util.Map attributes)

Creates a new Font with the specified attributes. This Font only recognizes keys defined in TextAttribute as attributes. If attributes is null, a new Font is initialized with default attributes.

Parameters:

attributes - the attributes to assign to the new Font, or null

Method Detail

getFont

public static Font getFont(java.util.Map attributes)

Returns a Font appropriate to this attribute set.

Parameters:

attributes - the attributes to assign to the new Font

Returns:

a new Font created with the specified attributes

Since:

1.2

See Also:

TextAttribute

getTransform

public AffineTransform getTransform()

Returns a copy of the transform associated with this Font.

Returns:

an AffineTransform object representing the transform attribute of this Font object.

getFamily

public java.lang.String getFamily()

Returns the family name of this Font.

The family name of a font is font specific. Two fonts such as Helvetica Italic and Helvetica Bold have the same family name, Helvetica, whereas their font face names are Helvetica Bold and Helvetica Italic. The list of available family names may be obtained by using the GraphicsEnvironment#getAvailableFontFamilyNames() method.

Use getName to get the logical name of the font.

Returns:

a String that is the family name of this Font.

Since:

JDK1.1

See Also:

getName()

getFamily

public java.lang.String getFamily(java.util.Locale l)

Returns the family name of this Font, localized for the specified locale.

The family name of a font is font specific. Two fonts such as Helvetica Italic and Helvetica Bold have the same family name, Helvetica, whereas their font face names are Helvetica Bold and Helvetica Italic. The list of available family names may be obtained by using the GraphicsEnvironment#getAvailableFontFamilyNames() method.

Use getFontName to get the font face name of the font.

Parameters:

l - locale for which to get the family name

Returns:

a String representing the family name of the font, localized for the specified locale.

Since:

1.2

See Also:

getFontName(), Locale

getName

public java.lang.String getName()

Returns the logical name of this Font. Use getFamily to get the family name of the font.

Returns:

a String representing the logical name of this Font.

Since:

JDK1.0

See Also:

getFamily()

getFontName

public java.lang.String getFontName()

Returns the font face name of this Font. For example, Helvetica Bold could be returned as a font face name. Use getFamily to get the family name of the font. Use getName to get the logical name of the font.

Returns:

a String representing the font face name of this Font.

Since:

1.2

See Also:

getFamily(), getName()

getFontName

public java.lang.String getFontName(java.util.Locale l)

Returns the font face name of the Font, localized for the specified locale. For example, Helvetica Fett could be returned as the font face name. Use getFamily to get the family name of the font.

Parameters:

l - a locale for which to get the font face name

Returns:

a String representing the font face name, localized for the specified locale.

See Also:

getFamily(), Locale

getStyle

public int getStyle()

Returns the style of this Font. The style can be PLAIN, BOLD, ITALIC, or BOLD+ITALIC.

Returns:

the style of this Font

Since:

JDK1.0

See Also:

isPlain(), isBold(), isItalic()

getSize

public int getSize()

Returns the point size of this Font, rounded to an integer. Most users are familiar with the idea of using point size to specify the size of glyphs in a font. This point size defines a measurement between the baseline of one line to the baseline of the following line in a single spaced text document. The point size is based on typographic points, approximately 1/72 of an inch.

The Java(tm)2D API adopts the convention that one point is equivalent to one unit in user coordinates. In this case one point is 1/72 of an inch.

Returns:

the point size of this Font in 1/72 of an inch units.

Since:

JDK1.0

getSize2D

public float getSize2D()

Returns the point size of this Font in float value.

Returns:

the point size of this Font as a float value.

Since:

1.2

See Also:

getSize()

isPlain

public boolean isPlain()

Indicates whether or not this Font object's style is PLAIN.

Returns:

true if this Font has a PLAIN sytle; false otherwise.

Since:

JDK1.0

See Also:

getStyle()

isBold

public boolean isBold()

Indicates whether or not this Font object's style is BOLD.

Returns:

true if this Font object's style is BOLD; false otherwise.

Since:

JDK1.0

See Also:

getStyle()

isItalic

public boolean isItalic()

Indicates whether or not this Font object's style is ITALIC.

Returns:

true if this Font object's style is ITALIC; false otherwise.

Since:

JDK1.0

See Also:

getStyle()

isTransformed

public boolean isTransformed()

Indicates whether or not this Font object has a transform that affects its size in addition to the Size attribute.

Returns:

true if this Font object has a non-identity AffineTransform attribute. false otherwise.

Since:

1.4

See Also:

getTransform()

getFont

public static Font getFont(java.lang.String nm)

Returns a Font object from the system properties list.

Parameters:

nm - the property name

Returns:

a Font object that the property name describes.

Since:

1.2

decode

public static Font decode(java.lang.String str)

Returns the Font that the str argument describes. To ensure that this method returns the desired Font, format the str parameter in one of two ways:

"fontfamilyname-style-pointsize" or
"fontfamilyname style pointsize"

in which style is one of the three case-insensitive strings: "BOLD", "BOLDITALIC", or "ITALIC", and pointsize is a decimal representation of the point size. For example, if you want a font that is Arial, bold, and a point size of 18, you would call this method with: "Arial-BOLD-18".

The default size is 12 and the default style is PLAIN. If you don't specify a valid size, the returned Font has a size of 12. If you don't specify a valid style, the returned Font has a style of PLAIN. If you do not provide a valid font family name in the str argument, this method still returns a valid font with a family name of "dialog". To determine what font family names are available on your system, use the GraphicsEnvironment#getAvailableFontFamilyNames() method. If str is null, a new Font is returned with the family name "dialog", a size of 12 and a PLAIN style. If str is null, a new Font is returned with the name "dialog", a size of 12 and a PLAIN style.

Parameters:

str - the name of the font, or null

Returns:

the Font object that str describes, or a new default Font if str is null.

Since:

JDK1.1

See Also:

getFamily()

getFont

public static Font getFont(java.lang.String nm,
                           Font font)

Gets the specified Font from the system properties list. As in the getProperty method of System, the first argument is treated as the name of a system property to be obtained. The String value of this property is then interpreted as a Font object.

The property value should be one of the following forms:

• fontname-style-pointsize
• fontname-pointsize
• fontname-style
• fontname

where style is one of the three case-insensitive strings "BOLD", "BOLDITALIC", or "ITALIC", and point size is a decimal representation of the point size.

The default style is PLAIN. The default point size is 12.

If the specified property is not found, the font argument is returned instead.

Parameters:

nm - the case-insensitive property name

font - a default Font to return if property nm is not defined

Returns:

the Font value of the property.

See Also:

decode(String)

hashCode

public int hashCode()

Returns a hashcode for this Font.

Returns:

a hashcode value for this Font.

Since:

JDK1.0

equals

public boolean equals(java.lang.Object obj)

Compares this Font object to the specified Object.

Parameters:

obj - the Object to compare

Returns:

true if the objects are the same or if the argument is a Font object describing the same font as this object; false otherwise.

Since:

JDK1.0

toString

public java.lang.String toString()

Converts this Font object to a String representation.

Returns:

a String representation of this Font object.

Since:

JDK1.0

getNumGlyphs

public int getNumGlyphs()

Returns the number of glyphs in this Font. Glyph codes for this Font range from 0 to getNumGlyphs() - 1.

Returns:

the number of glyphs in this Font.

Since:

1.2

getMissingGlyphCode

public int getMissingGlyphCode()

Returns the glyphCode which is used when this Font does not have a glyph for a specified unicode.

Returns:

the glyphCode of this Font.

Since:

1.2

getBaselineFor

public byte getBaselineFor(char c)

Returns the baseline appropriate for displaying this character.

Large fonts can support different writing systems, and each system can use a different baseline. The character argument determines the writing system to use. Clients should not assume all characters use the same baseline.

Parameters:

c - a character used to identify the writing system

Returns:

the baseline appropriate for the specified character.

Since:

1.2

See Also:

LineMetrics.getBaselineOffsets(), ROMAN_BASELINE, CENTER_BASELINE, HANGING_BASELINE

getAttributes

public java.util.Map getAttributes()

Returns a map of font attributes available in this Font. Attributes include things like ligatures and glyph substitution.

Returns:

the attributes map of this Font.

deriveFont

public Font deriveFont(int style,
                       float size)

Creates a new Font object by replicating this Font object and applying a new style and size.

Parameters:

style - the style for the new Font

size - the size for the new Font

Returns:

a new Font object.

Since:

1.2

deriveFont

public Font deriveFont(AffineTransform trans)

Creates a new Font object by replicating the current Font object and applying a new transform to it.

Parameters:

trans - the AffineTransform associated with the new Font

Returns:

a new Font object.

Throws:

java.lang.IllegalArgumentException - if trans is null

Since:

1.2

getAvailableAttributes

public java.text.AttributedCharacterIterator.Attribute[] getAvailableAttributes()

Returns the keys of all the attributes supported by this Font.

Returns:

an array containing the keys of all the attributes supported by this Font.

Since:

1.2

deriveFont

public Font deriveFont(java.util.Map attributes)

Creates a new Font object by replicating the current Font object and applying a new set of font attributes to it.

Parameters:

attributes - a map of attributes enabled for the new Font

Returns:

a new Font object.

Since:

1.2

canDisplay

public boolean canDisplay(char c)

Checks if this Font has a glyph for the specified character.

Parameters:

c - a unicode character code

Returns:

true if this Font can display the character; false otherwise.

Since:

1.2

canDisplayUpTo

public int canDisplayUpTo(java.lang.String str)

Indicates whether or not this Font can display a specified String. For strings with Unicode encoding, it is important to know if a particular font can display the string. This method returns an offset into the String str which is the first character this Font cannot display without using the missing glyph code. If the Font can display all characters, -1 is returned.

Parameters:

str - a String object

Returns:

an offset into str that points to the first character in str that this Font cannot display; or -1 if this Font can display all characters in str.

Since:

1.2

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. This method is a convenience overload.

Parameters:

text - the specified array of characters

start - the specified starting offset into the specified array of characters

limit - the specified ending offset into the specified array of characters

Returns:

an offset into text that points to the first character in text that this Font cannot display; or -1 if this Font can display all characters in text.

Since:

1.2

canDisplayUpTo

public int canDisplayUpTo(java.text.CharacterIterator iter,
                          int start,
                          int limit)

Indicates whether or not this Font can display the specified String. For strings with Unicode encoding, it is important to know if a particular font can display the string. This method returns an offset into the String str which is the first character this Font cannot display without using the missing glyph code . If this Font can display all characters, -1 is returned.

Parameters:

iter - a CharacterIterator object

start - the specified starting offset into the specified array of characters

limit - the specified ending offset into the specified array of characters

Returns:

an offset into the String object that can be displayed by this Font.

Since:

1.2

getItalicAngle

public float getItalicAngle()

Returns the italic angle of this Font. The italic angle is the inverse slope of the caret which best matches the posture of this Font.

Returns:

the angle of the ITALIC style of this Font.

See Also:

TextAttribute.POSTURE

hasUniformLineMetrics

public boolean hasUniformLineMetrics()

Checks whether or not this Font has uniform line metrics. A logical Font might be a composite font, which means that it is composed of different physical fonts to cover different code ranges. Each of these fonts might have different LineMetrics. If the logical Font is a single font then the metrics would be uniform.

Returns:

true if this Font has uniform line metrics; false otherwise.

getLineMetrics

public LineMetrics getLineMetrics(java.lang.String str,
                                  FontRenderContext frc)

Returns a LineMetrics object created with the specified String and FontRenderContext.

Parameters:

str - the specified String

frc - the specified FontRenderContext

Returns:

a LineMetrics object created with the specified String and FontRenderContext.

getLineMetrics

public LineMetrics getLineMetrics(java.lang.String str,
                                  int beginIndex,
                                  int limit,
                                  FontRenderContext frc)

Returns a LineMetrics object created with the specified arguments.

Parameters:

str - the specified String

beginIndex - the initial offset of str

limit - the end offset of str

frc - the specified FontRenderContext

Returns:

a LineMetrics object created with the specified arguments.

getLineMetrics

public LineMetrics getLineMetrics(char[] chars,
                                  int beginIndex,
                                  int limit,
                                  FontRenderContext frc)

Returns a LineMetrics object created with the specified arguments.

Parameters:

chars - an array of characters

beginIndex - the initial offset of chars

limit - the end offset of chars

frc - the specified FontRenderContext

Returns:

a LineMetrics object created with the specified arguments.

getLineMetrics

public LineMetrics getLineMetrics(java.text.CharacterIterator ci,
                                  int beginIndex,
                                  int limit,
                                  FontRenderContext frc)

Returns a LineMetrics object created with the specified arguments.

Parameters:

ci - the specified CharacterIterator

beginIndex - the initial offset in ci

limit - the end offset of ci

frc - the specified FontRenderContext

Returns:

a LineMetrics object created with the specified arguments.

getStringBounds

public Rectangle2D getStringBounds(java.lang.String str,
                                   FontRenderContext frc)

Returns the logical bounds of the specified String in the specified FontRenderContext. The logical bounds contains the origin, ascent, advance, and height, which includes the leading. The logical bounds does not always enclose all the text. For example, in some languages and in some fonts, accent marks can be positioned above the ascent or below the descent. To obtain a visual bounding box, which encloses all the text, use the getBounds method of TextLayout.

Parameters:

str - the specified String

frc - the specified FontRenderContext

Returns:

a Rectangle2D that is the bounding box of the specified String in the specified FontRenderContext.

Since:

1.2

See Also:

FontRenderContext, createGlyphVector(java.awt.font.FontRenderContext, java.lang.String)

getStringBounds

public Rectangle2D getStringBounds(java.lang.String str,
                                   int beginIndex,
                                   int limit,
                                   FontRenderContext frc)

Returns the logical bounds of the specified String in the specified FontRenderContext. The logical bounds contains the origin, ascent, advance, and height, which includes the leading. The logical bounds does not always enclose all the text. For example, in some languages and in some fonts, accent marks can be positioned above the ascent or below the descent. To obtain a visual bounding box, which encloses all the text, use the getBounds method of TextLayout.

Parameters:

str - the specified String

beginIndex - the initial offset of str

limit - the end offset of str

frc - the specified FontRenderContext

Returns:

a Rectangle2D that is the bounding box of the specified String in the specified FontRenderContext.

Throws:

java.lang.IndexOutOfBoundsException - if beginIndex is less than zero, or limit is greater than the length of str, or beginIndex is greater than limit.

Since:

1.2

See Also:

FontRenderContext, createGlyphVector(java.awt.font.FontRenderContext, java.lang.String)

getStringBounds

public Rectangle2D getStringBounds(char[] chars,
                                   int beginIndex,
                                   int limit,
                                   FontRenderContext frc)

Returns the logical bounds of the specified array of characters in the specified FontRenderContext. The logical bounds contains the origin, ascent, advance, and height, which includes the leading. The logical bounds does not always enclose all the text. For example, in some languages and in some fonts, accent marks can be positioned above the ascent or below the descent. To obtain a visual bounding box, which encloses all the text, use the getBounds method of TextLayout.

Parameters:

chars - an array of characters

beginIndex - the initial offset in the array of characters

limit - the end offset in the array of characters

frc - the specified FontRenderContext

Returns:

a Rectangle2D that is the bounding box of the specified array of characters in the specified FontRenderContext.

Throws:

java.lang.IndexOutOfBoundsException - if beginIndex is less than zero, or limit is greater than the length of chars, or beginIndex is greater than limit.

Since:

1.2

See Also:

FontRenderContext, createGlyphVector(java.awt.font.FontRenderContext, java.lang.String)

getStringBounds

public Rectangle2D getStringBounds(java.text.CharacterIterator ci,
                                   int beginIndex,
                                   int limit,
                                   FontRenderContext frc)

Returns the logical bounds of the characters indexed in the specified CharacterIterator in the specified FontRenderContext. The logical bounds contains the origin, ascent, advance, and height, which includes the leading. The logical bounds does not always enclose all the text. For example, in some languages and in some fonts, accent marks can be positioned above the ascent or below the descent. To obtain a visual bounding box, which encloses all the text, use the getBounds method of TextLayout.

Parameters:

ci - the specified CharacterIterator

beginIndex - the initial offset in ci

limit - the end offset in ci

frc - the specified FontRenderContext

Returns:

a Rectangle2D that is the bounding box of the characters indexed in the specified CharacterIterator in the specified FontRenderContext.

Throws:

java.lang.IndexOutOfBoundsException - if beginIndex is less than the start index of ci, or limit is greater than the end index of ci, or beginIndex is greater than limit

Since:

1.2

See Also:

FontRenderContext, createGlyphVector(java.awt.font.FontRenderContext, java.lang.String)

getMaxCharBounds

public Rectangle2D getMaxCharBounds(FontRenderContext frc)

Returns the bounds for the character with the maximum bounds as defined in the specified FontRenderContext.

Parameters:

frc - the specified FontRenderContext

Returns:

a Rectangle2D that is the bounding box for the character with the maximum bounds.

createGlyphVector

public GlyphVector createGlyphVector(FontRenderContext frc,
                                     java.lang.String str)

Creates a GlyphVector by mapping characters to glyphs one-to-one based on the Unicode cmap in this Font. This method does no other processing besides the mapping of glyphs to characters. This means that this method is not useful for some scripts, such as Arabic, Hebrew, Thai, and Indic, that require reordering, shaping, or ligature substitution.

Parameters:

frc - the specified FontRenderContext

str - the specified String

Returns:

a new GlyphVector created with the specified String and the specified FontRenderContext.

createGlyphVector

public GlyphVector createGlyphVector(FontRenderContext frc,
                                     char[] chars)

Creates a GlyphVector by mapping characters to glyphs one-to-one based on the Unicode cmap in this Font. This method does no other processing besides the mapping of glyphs to characters. This means that this method is not useful for some scripts, such as Arabic, Hebrew, Thai, and Indic, that require reordering, shaping, or ligature substitution.

Parameters:

frc - the specified FontRenderContext

chars - the specified array of characters

Returns:

a new GlyphVector created with the specified array of characters and the specified FontRenderContext.

createGlyphVector

public GlyphVector createGlyphVector(FontRenderContext frc,
                                     java.text.CharacterIterator ci)

Creates a GlyphVector by mapping the specified characters to glyphs one-to-one based on the Unicode cmap in this Font. This method does no other processing besides the mapping of glyphs to characters. This means that this method is not useful for some scripts, such as Arabic, Hebrew, Thai, and Indic, that require reordering, shaping, or ligature substitution.

Parameters:

frc - the specified FontRenderContext

ci - the specified CharacterIterator

Returns:

a new GlyphVector created with the specified CharacterIterator and the specified FontRenderContext.

createGlyphVector

public GlyphVector createGlyphVector(FontRenderContext frc,
                                     int[] glyphCodes)

Creates a GlyphVector by mapping characters to glyphs one-to-one based on the Unicode cmap in this Font. This method does no other processing besides the mapping of glyphs to characters. This means that this method is not useful for some scripts, such as Arabic, Hebrew, Thai, and Indic, that require reordering, shaping, or ligature substitution.

Parameters:

frc - the specified FontRenderContext

glyphCodes - the specified integer array

Returns:

a new GlyphVector created with the specified integer array and the specified FontRenderContext.

layoutGlyphVector

public GlyphVector layoutGlyphVector(FontRenderContext frc,
                                     char[] text,
                                     int start,
                                     int limit,
                                     int flags)

Returns a new GlyphVector object, performing full layout of the text if possible. Full layout is required for complex text, such as Arabic or Hindi. Support for different scripts depends on the font and implementation. The direction is indicated in the flags parameter,by using LAYOUT_RIGHT_TO_LEFT to indicate a right-to-left (Arabic and Hebrew) run direction, or LAYOUT_LEFT_TO_RIGHT to indicate a left-to-right (English) run direction.

In addition, some operations, such as Arabic shaping, require context, so that the characters at the start and limit can have the proper shapes. Sometimes the data in the buffer outside the provided range does not have valid data. The values LAYOUT_NO_START_CONTEXT and LAYOUT_NO_LIMIT_CONTEXT can be added to the flags parameter to indicate that the text before start, or after limit, respectively, should not be examined for context.

All other values for the flags parameter are reserved.

Parameters:

frc - the specified FontRenderContext

text - the text to layout

start - the start of the text to use for the GlyphVector

limit - the limit of the text to use for the GlyphVector

flags - control flags as described above

Returns:

a new GlyphVector representing the text between start and limit, with glyphs chosen and positioned so as to best represent the text

Throws:

java.lang.ArrayIndexOutOfBoundsException - if start or limit is out of bounds

See Also:

LAYOUT_LEFT_TO_RIGHT, LAYOUT_RIGHT_TO_LEFT, LAYOUT_NO_START_CONTEXT, LAYOUT_NO_LIMIT_CONTEXT