All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.awt.FontMetrics

java.lang.Object
   |
   +----java.awt.FontMetrics

public abstract class FontMetrics

extends Object

implements Serializable

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 in order 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):

• getAscent()
• getDescent()
• getLeading()
• getMaxAdvance()
• charWidth(char ch)
• charsWidth(char data[], int off, int len)

font

The actual font.

FontMetrics(Font)

Creates a new FontMetrics object with the specified font.

bytesWidth(byte[], int, int)

Returns the total advance width for showing the specified array of bytes in this Font.

charsWidth(char[], int, int)

Returns the total advance width for showing the specified array of characters in this Font.

charWidth(char)

Returns the advance width of the specified character in this Font.

charWidth(int)

Returns the advance width of the specified character in this Font.

getAscent()

Gets the font ascent.

getDescent()

Gets the font descent.

getFont()

Gets the font.

getHeight()

Gets the standard height of a line of text in this font.

getLeading()

Gets the standard leading, or line spacing, for the font.

getMaxAdvance()

Gets the maximum advance width of any character in this Font.

getMaxAscent()

Gets the maximum ascent of all characters in this Font.

getMaxDecent()

For backward compatibility only. Deprecated.

getMaxDescent()

Gets the maximum descent of all characters in this Font.

getWidths()

Gets the advance widths of the first 256 characters in the Font.

stringWidth(String)

Returns the total advance width for showing the specified String in this Font.

toString()

Returns the String representation of this FontMetric's values.

 protected Font font

The actual font.

See Also:

getFont

 protected FontMetrics(Font font)

Creates a new FontMetrics object with the specified font.

Parameters:

font - the font

See Also:

Font

 public Font getFont()

Gets the font.

 public int getLeading()

Gets the standard leading, or line spacing, for the font. This 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.

 public int getAscent()

Gets the font ascent. The font ascent is the distance from the base line to the top of most Alphanumeric characters. Note, however, that some characters in the font may extend above this height.

See Also:

getMaxAscent

 public int getDescent()

Gets the font descent. The font descent is the distance from the base line to the bottom of most Alphanumeric characters. Note, however, that some characters in the font may extend below this height.

See Also:

getMaxDescent

 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. There is no guarantee that lines of text spaced at this distance will be disjoint; such lines may overlap if some characters overshoot either the standard ascent or the standard descent metric.

 public int getMaxAscent()

Gets the maximum ascent of all characters in this Font. No character will extend further above the baseline than this distance.

See Also:

getAscent

 public int getMaxDescent()

Gets the maximum descent of all characters in this Font. No character will descend futher below the baseline than this distance.

See Also:

getDescent

 public int getMaxDecent()

Note: getMaxDecent() is deprecated. As of JDK version 1.1.1, replaced by getMaxDescent().

For backward compatibility only.

See Also:

getMaxDescent

 public int getMaxAdvance()

Gets the maximum advance width of any character in this Font. The advance width is the amount by which the current point is moved from one character to the next in a line of text.

Returns:

-1 if the max advance is not known.

 public int charWidth(int ch)

Returns the advance width of the specified character in this Font. The advance width is the amount by which the current point is moved from one character to the next in a line of text.

Parameters:

ch - the character to be measured

See Also:

stringWidth

 public int charWidth(char ch)

Returns the advance width of the specified character in this Font. The advance width is the amount by which the current point is moved from one character to the next in a line of text.

Parameters:

ch - the character to be measured

See Also:

stringWidth

 public int stringWidth(String str)

Returns the total advance width for showing the specified String in this Font. The advance width is the amount by which the current point is moved from one character to the next in a line of text.

Parameters:

str - the String to be measured

See Also:

charsWidth, bytesWidth

 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 width is the amount by which the current point is moved from one character to the next in a line of text.

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

See Also:

stringWidth, bytesWidth

 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 width is the amount by which the current point is moved from one character to the next in a line of text.

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

See Also:

stringWidth, charsWidth

 public int[] getWidths()

Gets the advance widths of the first 256 characters in the Font. The advance width is the amount by which the current point is moved from one character to the next in a line of text.

 public String toString()

Returns the String representation of this FontMetric's values.

Overrides:

toString in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index