java.awt
Class FontMetrics

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.awt.FontMetrics
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable

public abstract class FontMetrics
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements Serializable sample code for java.io.Serializable definition code for java.io.Serializable

The FontMetrics class defines a font metrics object, which encapsulates information about the rendering of a particular font on a particular screen.

Note to subclassers: Since many of these methods form closed, mutually recursive loops, you must take care that you implement at least one of the methods in each such loop to prevent infinite recursion when your subclass is used. In particular, the following is the minimal suggested set of methods to override in order to ensure correctness and prevent infinite recursion (though other subsets are equally feasible):

The letter 'p' showing its 'reference point' Note that the implementations of these methods are inefficient, so they are usually overridden with more efficient toolkit-specific implementations.

When an application asks AWT to place a character at the position (xy), the character is placed so that its reference point (shown as the dot in the accompanying image) is put at that position. The reference point specifies a horizontal line called the baseline of the character. In normal printing, the baselines of characters should align.

In addition, every character in a font has an ascent, a descent, and an advance width. The ascent is the amount by which the character ascends above the baseline. The descent is the amount by which the character descends below the baseline. The advance width indicates the position at which AWT should place the next character.

An array of characters or a string can also have an ascent, a descent, and an advance width. The ascent of the array is the maximum ascent of any character in the array. The descent is the maximum descent of any character in the array. The advance width is the sum of the advance widths of each of the characters in the character array. The advance of a String is the distance along the baseline of the String. This distance is the width that should be used for centering or right-aligning the String. Note that the advance of a String is not necessarily the sum of the advances of its characters measured in isolation because the width of a character can vary depending on its context. For example, in Arabic text, the shape of a character can change in order to connect to other characters. Also, in some scripts, certain character sequences can be represented by a single shape, called a ligature. Measuring characters individually does not account for these transformations.

Since:
JDK1.0
See Also:
Font sample code for java.awt.Font definition code for java.awt.Font , Serialized Form

Field Summary
protected  Font sample code for java.awt.Font definition code for java.awt.Font font sample code for java.awt.FontMetrics.font definition code for java.awt.FontMetrics.font
          The actual Font sample code for java.awt.Font definition code for java.awt.Font from which the font metrics are created.
 
Constructor Summary
protected FontMetrics sample code for java.awt.FontMetrics.FontMetrics(java.awt.Font) definition code for java.awt.FontMetrics.FontMetrics(java.awt.Font) (Font sample code for java.awt.Font definition code for java.awt.Font  font)
          Creates a new FontMetrics object for finding out height and width information about the specified Font and specific character glyphs in that Font.
 
Method Summary
 int bytesWidth sample code for java.awt.FontMetrics.bytesWidth(byte[], int, int) definition code for java.awt.FontMetrics.bytesWidth(byte[], int, int) (byte[] data, int off, int len)
          Returns the total advance width for showing the specified array of bytes in this Font.
 int charsWidth sample code for java.awt.FontMetrics.charsWidth(char[], int, int) definition code for java.awt.FontMetrics.charsWidth(char[], int, int) (char[] data, int off, int len)
          Returns the total advance width for showing the specified array of characters in this Font.
 int charWidth sample code for java.awt.FontMetrics.charWidth(char) definition code for java.awt.FontMetrics.charWidth(char) (char ch)
          Returns the advance width of the specified character in this Font.
 int charWidth sample code for java.awt.FontMetrics.charWidth(int) definition code for java.awt.FontMetrics.charWidth(int) (int codePoint)
          Returns the advance width of the specified character in this Font.
 int getAscent sample code for java.awt.FontMetrics.getAscent() definition code for java.awt.FontMetrics.getAscent() ()
          Determines the font ascent of the Font described by this FontMetrics object.
 int getDescent sample code for java.awt.FontMetrics.getDescent() definition code for java.awt.FontMetrics.getDescent() ()
          Determines the font descent of the Font described by this FontMetrics object.
 Font sample code for java.awt.Font definition code for java.awt.Font getFont sample code for java.awt.FontMetrics.getFont() definition code for java.awt.FontMetrics.getFont() ()
          Gets the Font described by this FontMetrics object.
 int getHeight sample code for java.awt.FontMetrics.getHeight() definition code for java.awt.FontMetrics.getHeight() ()
          Gets the standard height of a line of text in this font.
 int getLeading sample code for java.awt.FontMetrics.getLeading() definition code for java.awt.FontMetrics.getLeading() ()
          Determines the standard leading of the Font described by this FontMetrics object.
 LineMetrics sample code for java.awt.font.LineMetrics definition code for java.awt.font.LineMetrics getLineMetrics sample code for java.awt.FontMetrics.getLineMetrics(char[], int, int, java.awt.Graphics) definition code for java.awt.FontMetrics.getLineMetrics(char[], int, int, java.awt.Graphics) (char[] chars, int beginIndex, int limit, Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics  context)
          Returns the LineMetrics sample code for java.awt.font.LineMetrics definition code for java.awt.font.LineMetrics object for the specified character array in the specified Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics context.
 LineMetrics sample code for java.awt.font.LineMetrics definition code for java.awt.font.LineMetrics getLineMetrics sample code for java.awt.FontMetrics.getLineMetrics(java.text.CharacterIterator, int, int, java.awt.Graphics) definition code for java.awt.FontMetrics.getLineMetrics(java.text.CharacterIterator, int, int, java.awt.Graphics) (CharacterIterator sample code for java.text.CharacterIterator definition code for java.text.CharacterIterator  ci, int beginIndex, int limit, Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics  context)
          Returns the LineMetrics sample code for java.awt.font.LineMetrics definition code for java.awt.font.LineMetrics object for the specified CharacterIterator sample code for java.text.CharacterIterator definition code for java.text.CharacterIterator in the specified Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics context.
 LineMetrics sample code for java.awt.font.LineMetrics definition code for java.awt.font.LineMetrics getLineMetrics sample code for java.awt.FontMetrics.getLineMetrics(java.lang.String, java.awt.Graphics) definition code for java.awt.FontMetrics.getLineMetrics(java.lang.String, java.awt.Graphics) (String sample code for java.lang.String definition code for java.lang.String  str, Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics  context)
          Returns the LineMetrics sample code for java.awt.font.LineMetrics definition code for java.awt.font.LineMetrics object for the specified String in the specified Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics context.
 LineMetrics sample code for java.awt.font.LineMetrics definition code for java.awt.font.LineMetrics getLineMetrics sample code for java.awt.FontMetrics.getLineMetrics(java.lang.String, int, int, java.awt.Graphics) definition code for java.awt.FontMetrics.getLineMetrics(java.lang.String, int, int, java.awt.Graphics) (String sample code for java.lang.String definition code for java.lang.String  str, int beginIndex, int limit, Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics  context)
          Returns the LineMetrics sample code for java.awt.font.LineMetrics definition code for java.awt.font.LineMetrics object for the specified String in the specified Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics context.
 int getMaxAdvance sample code for java.awt.FontMetrics.getMaxAdvance() definition code for java.awt.FontMetrics.getMaxAdvance() ()
          Gets the maximum advance width of any character in this Font.
 int getMaxAscent sample code for java.awt.FontMetrics.getMaxAscent() definition code for java.awt.FontMetrics.getMaxAscent() ()
          Determines the maximum ascent of the Font described by this FontMetrics object.
 Rectangle2D sample code for java.awt.geom.Rectangle2D definition code for java.awt.geom.Rectangle2D getMaxCharBounds sample code for java.awt.FontMetrics.getMaxCharBounds(java.awt.Graphics) definition code for java.awt.FontMetrics.getMaxCharBounds(java.awt.Graphics) (Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics  context)
          Returns the bounds for the character with the maximum bounds in the specified Graphics context.
 int getMaxDecent sample code for java.awt.FontMetrics.getMaxDecent() definition code for java.awt.FontMetrics.getMaxDecent() ()
          Deprecated. As of JDK version 1.1.1, replaced by getMaxDescent().
 int getMaxDescent sample code for java.awt.FontMetrics.getMaxDescent() definition code for java.awt.FontMetrics.getMaxDescent() ()
          Determines the maximum descent of the Font described by this FontMetrics object.
 Rectangle2D sample code for java.awt.geom.Rectangle2D definition code for java.awt.geom.Rectangle2D getStringBounds sample code for java.awt.FontMetrics.getStringBounds(char[], int, int, java.awt.Graphics) definition code for java.awt.FontMetrics.getStringBounds(char[], int, int, java.awt.Graphics) (char[] chars, int beginIndex, int limit, Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics  context)
          Returns the bounds of the specified array of characters in the specified Graphics context.
 Rectangle2D sample code for java.awt.geom.Rectangle2D definition code for java.awt.geom.Rectangle2D getStringBounds sample code for java.awt.FontMetrics.getStringBounds(java.text.CharacterIterator, int, int, java.awt.Graphics) definition code for java.awt.FontMetrics.getStringBounds(java.text.CharacterIterator, int, int, java.awt.Graphics) (CharacterIterator sample code for java.text.CharacterIterator definition code for java.text.CharacterIterator  ci, int beginIndex, int limit, Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics  context)
          Returns the bounds of the characters indexed in the specified CharacterIterator in the specified Graphics context.
 Rectangle2D sample code for java.awt.geom.Rectangle2D definition code for java.awt.geom.Rectangle2D getStringBounds sample code for java.awt.FontMetrics.getStringBounds(java.lang.String, java.awt.Graphics) definition code for java.awt.FontMetrics.getStringBounds(java.lang.String, java.awt.Graphics) (String sample code for java.lang.String definition code for java.lang.String  str, Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics  context)
          Returns the bounds of the specified String in the specified Graphics context.
 Rectangle2D sample code for java.awt.geom.Rectangle2D definition code for java.awt.geom.Rectangle2D getStringBounds sample code for java.awt.FontMetrics.getStringBounds(java.lang.String, int, int, java.awt.Graphics) definition code for java.awt.FontMetrics.getStringBounds(java.lang.String, int, int, java.awt.Graphics) (String sample code for java.lang.String definition code for java.lang.String  str, int beginIndex, int limit, Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics  context)
          Returns the bounds of the specified String in the specified Graphics context.
 int[] getWidths sample code for java.awt.FontMetrics.getWidths() definition code for java.awt.FontMetrics.getWidths() ()
          Gets the advance widths of the first 256 characters in the Font.
 boolean hasUniformLineMetrics sample code for java.awt.FontMetrics.hasUniformLineMetrics() definition code for java.awt.FontMetrics.hasUniformLineMetrics() ()
          Checks to see if the Font has uniform line metrics.
 int stringWidth sample code for java.awt.FontMetrics.stringWidth(java.lang.String) definition code for java.awt.FontMetrics.stringWidth(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  str)
          Returns the total advance width for showing the specified String in this Font.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for java.awt.FontMetrics.toString() definition code for java.awt.FontMetrics.toString() ()
          Returns a representation of this FontMetrics object's values as a String.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

font sample code for java.awt.FontMetrics.font

protected Font sample code for java.awt.Font definition code for java.awt.Font  font
The actual Font sample code for java.awt.Font definition code for java.awt.Font from which the font metrics are created. This cannot be null.

See Also:
getFont() sample code for java.awt.FontMetrics.getFont() definition code for java.awt.FontMetrics.getFont()
Constructor Detail

FontMetrics sample code for java.awt.FontMetrics(java.awt.Font) definition code for java.awt.FontMetrics(java.awt.Font)

protected FontMetrics(Font sample code for java.awt.Font definition code for java.awt.Font  font)
Creates a new FontMetrics object for finding out height and width information about the specified Font and specific character glyphs in that Font.

Parameters:
font - the Font
See Also:
Font sample code for java.awt.Font definition code for java.awt.Font
Method Detail

getFont sample code for java.awt.FontMetrics.getFont() definition code for java.awt.FontMetrics.getFont()

public Font sample code for java.awt.Font definition code for java.awt.Font  getFont()
Gets the Font described by this FontMetrics object.

Returns:
the Font described by this FontMetrics object.

getLeading sample code for java.awt.FontMetrics.getLeading() definition code for java.awt.FontMetrics.getLeading()

public int getLeading()
Determines the standard leading of the Font described by this FontMetrics object. The standard leading, or interline spacing, is the logical amount of space to be reserved between the descent of one line of text and the ascent of the next line. The height metric is calculated to include this extra space.

Returns:
the standard leading of the Font.
See Also:
getHeight() sample code for java.awt.FontMetrics.getHeight() definition code for java.awt.FontMetrics.getHeight() , getAscent() sample code for java.awt.FontMetrics.getAscent() definition code for java.awt.FontMetrics.getAscent() , getDescent() sample code for java.awt.FontMetrics.getDescent() definition code for java.awt.FontMetrics.getDescent()

getAscent sample code for java.awt.FontMetrics.getAscent() definition code for java.awt.FontMetrics.getAscent()

public int getAscent()
Determines the font ascent of the Font described by this FontMetrics object. The font ascent is the distance from the font's baseline to the top of most alphanumeric characters. Some characters in the Font might extend above the font ascent line.

Returns:
the font ascent of the Font.
See Also:
getMaxAscent() sample code for java.awt.FontMetrics.getMaxAscent() definition code for java.awt.FontMetrics.getMaxAscent()

getDescent sample code for java.awt.FontMetrics.getDescent() definition code for java.awt.FontMetrics.getDescent()

public int getDescent()
Determines the font descent of the Font described by this FontMetrics object. The font descent is the distance from the font's baseline to the bottom of most alphanumeric characters with descenders. Some characters in the Font might extend below the font descent line.

Returns:
the font descent of the Font.
See Also:
getMaxDescent() sample code for java.awt.FontMetrics.getMaxDescent() definition code for java.awt.FontMetrics.getMaxDescent()

getHeight sample code for java.awt.FontMetrics.getHeight() definition code for java.awt.FontMetrics.getHeight()

public int getHeight()
Gets the standard height of a line of text in this font. This is the distance between the baseline of adjacent lines of text. It is the sum of the leading + ascent + descent. Due to rounding this may not be the same as getAscent() + getDescent() + getLeading(). There is no guarantee that lines of text spaced at this distance are disjoint; such lines may overlap if some characters overshoot either the standard ascent or the standard descent metric.

Returns:
the standard height of the font.
See Also:
getLeading() sample code for java.awt.FontMetrics.getLeading() definition code for java.awt.FontMetrics.getLeading() , getAscent() sample code for java.awt.FontMetrics.getAscent() definition code for java.awt.FontMetrics.getAscent() , getDescent() sample code for java.awt.FontMetrics.getDescent() definition code for java.awt.FontMetrics.getDescent()

getMaxAscent sample code for java.awt.FontMetrics.getMaxAscent() definition code for java.awt.FontMetrics.getMaxAscent()

public int getMaxAscent()
Determines the maximum ascent of the Font described by this FontMetrics object. No character extends further above the font's baseline than this height.

Returns:
the maximum ascent of any character in the Font.
See Also:
getAscent() sample code for java.awt.FontMetrics.getAscent() definition code for java.awt.FontMetrics.getAscent()

getMaxDescent sample code for java.awt.FontMetrics.getMaxDescent() definition code for java.awt.FontMetrics.getMaxDescent()

public int getMaxDescent()
Determines the maximum descent of the Font described by this FontMetrics object. No character extends further below the font's baseline than this height.

Returns:
the maximum descent of any character in the Font.
See Also:
getDescent() sample code for java.awt.FontMetrics.getDescent() definition code for java.awt.FontMetrics.getDescent()

getMaxDecent sample code for java.awt.FontMetrics.getMaxDecent() definition code for java.awt.FontMetrics.getMaxDecent()

@Deprecated
public int getMaxDecent()
Deprecated. As of JDK version 1.1.1, replaced by getMaxDescent().

For backward compatibility only.

Returns:
the maximum descent of any character in the Font.
See Also:
getMaxDescent() sample code for java.awt.FontMetrics.getMaxDescent() definition code for java.awt.FontMetrics.getMaxDescent()

getMaxAdvance sample code for java.awt.FontMetrics.getMaxAdvance() definition code for java.awt.FontMetrics.getMaxAdvance()

public int getMaxAdvance()
Gets the maximum advance width of any character in this Font. The advance is the distance from the leftmost point to the rightmost point on the string's baseline. The advance of a String is not necessarily the sum of the advances of its characters.

Returns:
the maximum advance width of any character in the Font, or -1 if the maximum advance width is not known.

charWidth sample code for java.awt.FontMetrics.charWidth(int) definition code for java.awt.FontMetrics.charWidth(int)

public int charWidth(int codePoint)
Returns the advance width of the specified character in this Font. The advance is the distance from the leftmost point to the rightmost point on the character's baseline. Note that the advance of a String is not necessarily the sum of the advances of its characters.

This method doesn't validate the specified character to be a valid Unicode code point. The caller must validate the character value using Character.isValidCodePoint sample code for java.lang.Character.isValidCodePoint(int) definition code for java.lang.Character.isValidCodePoint(int) if necessary.

Parameters:
codePoint - the character (Unicode code point) to be measured
Returns:
the advance width of the specified character in the Font described by this FontMetrics object.
See Also:
charsWidth(char[], int, int) sample code for java.awt.FontMetrics.charsWidth(char[], int, int) definition code for java.awt.FontMetrics.charsWidth(char[], int, int) , stringWidth(String) sample code for java.awt.FontMetrics.stringWidth(java.lang.String) definition code for java.awt.FontMetrics.stringWidth(java.lang.String)

charWidth sample code for java.awt.FontMetrics.charWidth(char) definition code for java.awt.FontMetrics.charWidth(char)

public int charWidth(char ch)
Returns the advance width of the specified character in this Font. The advance is the distance from the leftmost point to the rightmost point on the character's baseline. Note that the advance of a String is not necessarily the sum of the advances of its characters.

Note: This method cannot handle supplementary characters. To support all Unicode characters, including supplementary characters, use the charWidth(int) sample code for java.awt.FontMetrics.charWidth(int) definition code for java.awt.FontMetrics.charWidth(int) method.

Parameters:
ch - the character to be measured
Returns:
the advance width of the specified character in the Font described by this FontMetrics object.
See Also:
charsWidth(char[], int, int) sample code for java.awt.FontMetrics.charsWidth(char[], int, int) definition code for java.awt.FontMetrics.charsWidth(char[], int, int) , stringWidth(String) sample code for java.awt.FontMetrics.stringWidth(java.lang.String) definition code for java.awt.FontMetrics.stringWidth(java.lang.String)

stringWidth sample code for java.awt.FontMetrics.stringWidth(java.lang.String) definition code for java.awt.FontMetrics.stringWidth(java.lang.String)

public int stringWidth(String sample code for java.lang.String definition code for java.lang.String  str)
Returns the total advance width for showing the specified String in this Font. The advance is the distance from the leftmost point to the rightmost point on the string's baseline.

Note that the total advance width returned from this method does not take into account the rendering context. Therefore, the anti-aliasing and fractional metrics hints can affect the value of the advance. When enabling the anti-aliasing and fractional metrics hints, use getStringBounds(String, Graphics) instead of this method. The advance of a String is not necessarily the sum of the advances of its characters.

Parameters:
str - the String to be measured
Returns:
the advance width of the specified String in the Font described by this FontMetrics.
See Also:
bytesWidth(byte[], int, int) sample code for java.awt.FontMetrics.bytesWidth(byte[], int, int) definition code for java.awt.FontMetrics.bytesWidth(byte[], int, int) , charsWidth(char[], int, int) sample code for java.awt.FontMetrics.charsWidth(char[], int, int) definition code for java.awt.FontMetrics.charsWidth(char[], int, int) , getStringBounds(String, Graphics) sample code for java.awt.FontMetrics.getStringBounds(java.lang.String, java.awt.Graphics) definition code for java.awt.FontMetrics.getStringBounds(java.lang.String, java.awt.Graphics)

charsWidth sample code for java.awt.FontMetrics.charsWidth(char[], int, int) definition code for java.awt.FontMetrics.charsWidth(char[], int, int)

public int charsWidth(char[] data,
                      int off,
                      int len)
Returns the total advance width for showing the specified array of characters in this Font. The advance is the distance from the leftmost point to the rightmost point on the string's baseline. The advance of a String is not necessarily the sum of the advances of its characters. This is equivalent to measuring a String of the characters in the specified range.

Parameters:
data - the array of characters to be measured
off - the start offset of the characters in the array
len - the number of characters to be measured from the array
Returns:
the advance width of the subarray of the specified char array in the font described by this FontMetrics object.
See Also:
charWidth(int) sample code for java.awt.FontMetrics.charWidth(int) definition code for java.awt.FontMetrics.charWidth(int) , charWidth(char) sample code for java.awt.FontMetrics.charWidth(char) definition code for java.awt.FontMetrics.charWidth(char) , bytesWidth(byte[], int, int) sample code for java.awt.FontMetrics.bytesWidth(byte[], int, int) definition code for java.awt.FontMetrics.bytesWidth(byte[], int, int) , stringWidth(String) sample code for java.awt.FontMetrics.stringWidth(java.lang.String) definition code for java.awt.FontMetrics.stringWidth(java.lang.String)

bytesWidth sample code for java.awt.FontMetrics.bytesWidth(byte[], int, int) definition code for java.awt.FontMetrics.bytesWidth(byte[], int, int)

public int bytesWidth(byte[] data,
                      int off,
                      int len)
Returns the total advance width for showing the specified array of bytes in this Font. The advance is the distance from the leftmost point to the rightmost point on the string's baseline. The advance of a String is not necessarily the sum of the advances of its characters. This is equivalent to measuring a String of the characters in the specified range.

Parameters:
data - the array of bytes to be measured
off - the start offset of the bytes in the array
len - the number of bytes to be measured from the array
Returns:
the advance width of the subarray of the specified byte array in the Font described by this FontMetrics object.
See Also:
charsWidth(char[], int, int) sample code for java.awt.FontMetrics.charsWidth(char[], int, int) definition code for java.awt.FontMetrics.charsWidth(char[], int, int) , stringWidth(String) sample code for java.awt.FontMetrics.stringWidth(java.lang.String) definition code for java.awt.FontMetrics.stringWidth(java.lang.String)

getWidths sample code for java.awt.FontMetrics.getWidths() definition code for java.awt.FontMetrics.getWidths()

public int[] getWidths()
Gets the advance widths of the first 256 characters in the Font. The advance is the distance from the leftmost point to the rightmost point on the character's baseline. Note that the advance of a String is not necessarily the sum of the advances of its characters.

Returns:
an array storing the advance widths of the characters in the Font described by this FontMetrics object.

hasUniformLineMetrics sample code for java.awt.FontMetrics.hasUniformLineMetrics() definition code for java.awt.FontMetrics.hasUniformLineMetrics()

public boolean hasUniformLineMetrics()
Checks to see if the Font has uniform line metrics. A composite font may consist of several different fonts to cover various character sets. In such cases, the FontLineMetrics objects are not uniform. Different fonts may have a different ascent, descent, metrics and so on. This information is sometimes necessary for line measuring and line breaking.

Returns:
true if the font has uniform line metrics; false otherwise.
See Also:
Font.hasUniformLineMetrics() sample code for java.awt.Font.hasUniformLineMetrics() definition code for java.awt.Font.hasUniformLineMetrics()

getLineMetrics sample code for java.awt.FontMetrics.getLineMetrics(java.lang.String, java.awt.Graphics) definition code for java.awt.FontMetrics.getLineMetrics(java.lang.String, java.awt.Graphics)

public LineMetrics sample code for java.awt.font.LineMetrics definition code for java.awt.font.LineMetrics  getLineMetrics(String sample code for java.lang.String definition code for java.lang.String  str,
                                  Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics  context)
Returns the LineMetrics sample code for java.awt.font.LineMetrics definition code for java.awt.font.LineMetrics object for the specified String in the specified Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics context.

Parameters:
str - the specified String
context - the specified Graphics context
Returns:
a LineMetrics object created with the specified String and Graphics context.
See Also:
Font.getLineMetrics(String, FontRenderContext) sample code for java.awt.Font.getLineMetrics(java.lang.String, java.awt.font.FontRenderContext) definition code for java.awt.Font.getLineMetrics(java.lang.String, java.awt.font.FontRenderContext)

getLineMetrics sample code for java.awt.FontMetrics.getLineMetrics(java.lang.String, int, int, java.awt.Graphics) definition code for java.awt.FontMetrics.getLineMetrics(java.lang.String, int, int, java.awt.Graphics)

public LineMetrics sample code for java.awt.font.LineMetrics definition code for java.awt.font.LineMetrics  getLineMetrics(String sample code for java.lang.String definition code for java.lang.String  str,
                                  int beginIndex,
                                  int limit,
                                  Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics  context)
Returns the LineMetrics sample code for java.awt.font.LineMetrics definition code for java.awt.font.LineMetrics object for the specified String in the specified Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics context.

Parameters:
str - the specified String
beginIndex - the initial offset of str
limit - the length of str
context - the specified Graphics context
Returns:
a LineMetrics object created with the specified String and Graphics context.
See Also:
Font.getLineMetrics(String, int, int, FontRenderContext) sample code for java.awt.Font.getLineMetrics(java.lang.String, int, int, java.awt.font.FontRenderContext) definition code for java.awt.Font.getLineMetrics(java.lang.String, int, int, java.awt.font.FontRenderContext)

getLineMetrics sample code for java.awt.FontMetrics.getLineMetrics(char[], int, int, java.awt.Graphics) definition code for java.awt.FontMetrics.getLineMetrics(char[], int, int, java.awt.Graphics)

public LineMetrics sample code for java.awt.font.LineMetrics definition code for java.awt.font.LineMetrics  getLineMetrics(char[] chars,
                                  int beginIndex,
                                  int limit,
                                  Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics  context)
Returns the LineMetrics sample code for java.awt.font.LineMetrics definition code for java.awt.font.LineMetrics object for the specified character array in the specified Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics context.

Parameters:
chars - the specified character array
beginIndex - the initial offset of chars
limit - the length of chars
context - the specified Graphics context
Returns:
a LineMetrics object created with the specified character array and Graphics context.
See Also:
Font.getLineMetrics(char[], int, int, FontRenderContext) sample code for java.awt.Font.getLineMetrics(char[], int, int, java.awt.font.FontRenderContext) definition code for java.awt.Font.getLineMetrics(char[], int, int, java.awt.font.FontRenderContext)

getLineMetrics sample code for java.awt.FontMetrics.getLineMetrics(java.text.CharacterIterator, int, int, java.awt.Graphics) definition code for java.awt.FontMetrics.getLineMetrics(java.text.CharacterIterator, int, int, java.awt.Graphics)

public LineMetrics sample code for java.awt.font.LineMetrics definition code for java.awt.font.LineMetrics  getLineMetrics(CharacterIterator sample code for java.text.CharacterIterator definition code for java.text.CharacterIterator  ci,
                                  int beginIndex,
                                  int limit,
                                  Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics  context)
Returns the LineMetrics sample code for java.awt.font.LineMetrics definition code for java.awt.font.LineMetrics object for the specified CharacterIterator sample code for java.text.CharacterIterator definition code for java.text.CharacterIterator in the specified Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics context.

Parameters:
ci - the specified CharacterIterator
beginIndex - the initial offset in ci
limit - the end index of ci
context - the specified Graphics context
Returns:
a LineMetrics object created with the specified arguments.
See Also:
Font.getLineMetrics(CharacterIterator, int, int, FontRenderContext) sample code for java.awt.Font.getLineMetrics(java.text.CharacterIterator, int, int, java.awt.font.FontRenderContext) definition code for java.awt.Font.getLineMetrics(java.text.CharacterIterator, int, int, java.awt.font.FontRenderContext)

getStringBounds sample code for java.awt.FontMetrics.getStringBounds(java.lang.String, java.awt.Graphics) definition code for java.awt.FontMetrics.getStringBounds(java.lang.String, java.awt.Graphics)

public Rectangle2D sample code for java.awt.geom.Rectangle2D definition code for java.awt.geom.Rectangle2D  getStringBounds(String sample code for java.lang.String definition code for java.lang.String  str,
                                   Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics  context)
Returns the bounds of the specified String in the specified Graphics context. The bounds is used to layout the String.

Parameters:
str - the specified String
context - the specified Graphics context
Returns:
a Rectangle2D sample code for java.awt.geom.Rectangle2D definition code for java.awt.geom.Rectangle2D that is the bounding box of the specified String in the specified Graphics context.
See Also:
Font.getStringBounds(String, FontRenderContext) sample code for java.awt.Font.getStringBounds(java.lang.String, java.awt.font.FontRenderContext) definition code for java.awt.Font.getStringBounds(java.lang.String, java.awt.font.FontRenderContext)

getStringBounds sample code for java.awt.FontMetrics.getStringBounds(java.lang.String, int, int, java.awt.Graphics) definition code for java.awt.FontMetrics.getStringBounds(java.lang.String, int, int, java.awt.Graphics)

public Rectangle2D sample code for java.awt.geom.Rectangle2D definition code for java.awt.geom.Rectangle2D  getStringBounds(String sample code for java.lang.String definition code for java.lang.String  str,
                                   int beginIndex,
                                   int limit,
                                   Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics  context)
Returns the bounds of the specified String in the specified Graphics context. The bounds is used to layout the String.

Parameters:
str - the specified String
beginIndex - the offset of the beginning of str
limit - the length of str
context - the specified Graphics context
Returns:
a Rectangle2D that is the bounding box of the specified String in the specified Graphics context.
See Also:
Font.getStringBounds(String, int, int, FontRenderContext) sample code for java.awt.Font.getStringBounds(java.lang.String, int, int, java.awt.font.FontRenderContext) definition code for java.awt.Font.getStringBounds(java.lang.String, int, int, java.awt.font.FontRenderContext)

getStringBounds sample code for java.awt.FontMetrics.getStringBounds(char[], int, int, java.awt.Graphics) definition code for java.awt.FontMetrics.getStringBounds(char[], int, int, java.awt.Graphics)

public Rectangle2D sample code for java.awt.geom.Rectangle2D definition code for java.awt.geom.Rectangle2D  getStringBounds(char[] chars,
                                   int beginIndex,
                                   int limit,
                                   Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics  context)
Returns the bounds of the specified array of characters in the specified Graphics context. The bounds is used to layout the String created with the specified array of characters, beginIndex and limit.

Parameters:
chars - an array of characters
beginIndex - the initial offset of the array of characters
limit - the length of the array of characters
context - the specified Graphics context
Returns:
a Rectangle2D that is the bounding box of the specified character array in the specified Graphics context.
See Also:
Font.getStringBounds(char[], int, int, FontRenderContext) sample code for java.awt.Font.getStringBounds(char[], int, int, java.awt.font.FontRenderContext) definition code for java.awt.Font.getStringBounds(char[], int, int, java.awt.font.FontRenderContext)

getStringBounds sample code for java.awt.FontMetrics.getStringBounds(java.text.CharacterIterator, int, int, java.awt.Graphics) definition code for java.awt.FontMetrics.getStringBounds(java.text.CharacterIterator, int, int, java.awt.Graphics)

public Rectangle2D sample code for java.awt.geom.Rectangle2D definition code for java.awt.geom.Rectangle2D  getStringBounds(CharacterIterator sample code for java.text.CharacterIterator definition code for java.text.CharacterIterator  ci,
                                   int beginIndex,
                                   int limit,
                                   Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics  context)
Returns the bounds of the characters indexed in the specified CharacterIterator in the specified Graphics context.

Parameters:
ci - the specified CharacterIterator
beginIndex - the initial offset in ci
limit - the end index of ci
context - the specified Graphics context
Returns:
a Rectangle2D that is the bounding box of the characters indexed in the specified CharacterIterator in the specified Graphics context.
See Also:
Font.getStringBounds(CharacterIterator, int, int, FontRenderContext) sample code for java.awt.Font.getStringBounds(java.text.CharacterIterator, int, int, java.awt.font.FontRenderContext) definition code for java.awt.Font.getStringBounds(java.text.CharacterIterator, int, int, java.awt.font.FontRenderContext)

getMaxCharBounds sample code for java.awt.FontMetrics.getMaxCharBounds(java.awt.Graphics) definition code for java.awt.FontMetrics.getMaxCharBounds(java.awt.Graphics)

public Rectangle2D sample code for java.awt.geom.Rectangle2D definition code for java.awt.geom.Rectangle2D  getMaxCharBounds(Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics  context)
Returns the bounds for the character with the maximum bounds in the specified Graphics context.

Parameters:
context - the specified Graphics context
Returns:
a Rectangle2D that is the bounding box for the character with the maximum bounds.
See Also:
Font.getMaxCharBounds(FontRenderContext) sample code for java.awt.Font.getMaxCharBounds(java.awt.font.FontRenderContext) definition code for java.awt.Font.getMaxCharBounds(java.awt.font.FontRenderContext)

toString sample code for java.awt.FontMetrics.toString() definition code for java.awt.FontMetrics.toString()

public String sample code for java.lang.String definition code for java.lang.String  toString()
Returns a representation of this FontMetrics object's values as a String.

Overrides:
toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a String representation of this FontMetrics object.
Since:
JDK1.0.