|
Modifier and Type |
Method and Description |
|
bytesWidth |
int bytesWidth(byte[] data,
int off,
int len)
Returns the total advance width for showing the specified array
of bytes in this Font .
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 measuredoff - the start offset of the bytes in the arraylen - 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.
- Throws:
java.lang.NullPointerException - if data is null.
java.lang.IndexOutOfBoundsException - if the off
and len arguments index bytes outside
the bounds of the data array.- See Also:
charsWidth(char[], int, int) ,
stringWidth(String)
|
|
charsWidth |
int charsWidth(char[] data,
int off,
int len)
Returns the total advance width for showing the specified array
of characters in this Font .
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 measuredoff - the start offset of the characters in the arraylen - 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.
- Throws:
java.lang.NullPointerException - if data is null.
java.lang.IndexOutOfBoundsException - if the off
and len arguments index characters outside
the bounds of the data array.- See Also:
charWidth(int) ,
charWidth(char) ,
bytesWidth(byte[], int, int) ,
stringWidth(String)
|
|
charWidth |
int charWidth(char ch)
Returns the advance width of the specified character in this
Font .
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) 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) ,
stringWidth(String)
|
|
charWidth |
int charWidth(int codePoint)
Returns the advance width of the specified character in this
Font .
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 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) ,
stringWidth(String)
|
|
getAscent |
int getAscent()
Determines the font ascent of the Font
described by this FontMetrics object.
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()
|
|
getDescent |
int getDescent()
Determines the font descent of the Font
described by this
FontMetrics object.
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()
|
|
getFont |
Gets the Font described by this
FontMetrics object.
-
Gets the Font described by this
FontMetrics object.
- Returns:
- the
Font described by this
FontMetrics object.
|
|
getFontRenderContext |
java.awt.font.FontRenderContext getFontRenderContext()
Gets the FontRenderContext used by this
FontMetrics object to measure text.
public java.awt.font.FontRenderContext getFontRenderContext()
-
Gets the FontRenderContext used by this
FontMetrics object to measure text.
Note that methods in this class which take a Graphics
parameter measure text using the FontRenderContext
of that Graphics object, and not this
FontRenderContext
- Returns:
- the
FontRenderContext used by this
FontMetrics object. - Since:
- 1.6
|
|
getHeight |
int getHeight()
Gets the standard height of a line of text in this font.
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() ,
getAscent() ,
getDescent()
|
|
getLeading |
int getLeading()
Determines the standard leading of the
Font described by this FontMetrics
object.
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() ,
getAscent() ,
getDescent()
|
|
getLineMetrics |
java.awt.font.LineMetrics getLineMetrics(char[] chars,
int beginIndex,
int limit,
Graphics context)
Returns the LineMetrics object for the specified
character array in the specified Graphics context.
public java.awt.font.LineMetrics getLineMetrics(char[] chars,
int beginIndex,
int limit,
Graphics context)
-
Returns the LineMetrics object for the specified
character array in the specified Graphics context.
- Parameters:
chars - the specified character arraybeginIndex - the initial offset of chars limit - the end offset 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)
|
|
getLineMetrics |
java.awt.font.LineMetrics getLineMetrics(java.text.CharacterIterator ci,
int beginIndex,
int limit,
Graphics context)
Returns the LineMetrics object for the specified
CharacterIterator in the specified Graphics
context.
public java.awt.font.LineMetrics getLineMetrics(java.text.CharacterIterator ci,
int beginIndex,
int limit,
Graphics context)
-
Returns the LineMetrics object for 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
LineMetrics object created with the
specified arguments. - See Also:
Font.getLineMetrics(CharacterIterator, int, int, FontRenderContext)
|
|
getLineMetrics |
java.awt.font.LineMetrics getLineMetrics(java.lang.String str,
Graphics context)
Returns the LineMetrics object for the specified
String in the specified Graphics context.
public java.awt.font.LineMetrics getLineMetrics(java.lang.String str,
Graphics context)
-
Returns the LineMetrics object for the specified
String in the specified 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)
|
|
getLineMetrics |
java.awt.font.LineMetrics getLineMetrics(java.lang.String str,
int beginIndex,
int limit,
Graphics context)
Returns the LineMetrics object for the specified
String in the specified Graphics context.
public java.awt.font.LineMetrics getLineMetrics(java.lang.String str,
int beginIndex,
int limit,
Graphics context)
-
Returns the LineMetrics object for the specified
String in the specified Graphics context.
- Parameters:
str - the specified String beginIndex - the initial offset of str limit - the end offset 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)
|
|
getMaxAdvance |
int getMaxAdvance()
Gets the maximum advance width of any character in this
Font .
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.
|
|
getMaxAscent |
int getMaxAscent()
Determines the maximum ascent of the Font
described by this FontMetrics object.
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()
|
|
getMaxCharBounds |
java.awt.geom.Rectangle2D getMaxCharBounds(Graphics context)
Returns the bounds for the character with the maximum bounds
in the specified Graphics context.
public java.awt.geom.Rectangle2D getMaxCharBounds( 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)
|
|
getMaxDecent |
int getMaxDecent()
Deprecated. As of JDK version 1.1.1,
replaced by getMaxDescent() .
@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()
|
|
getMaxDescent |
int getMaxDescent()
Determines the maximum descent of the Font
described by this FontMetrics object.
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()
|
|
getStringBounds |
java.awt.geom.Rectangle2D getStringBounds(char[] chars,
int beginIndex,
int limit,
Graphics context)
Returns the bounds of the specified array of characters
in the specified Graphics context.
public java.awt.geom.Rectangle2D getStringBounds(char[] chars,
int beginIndex,
int limit,
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 .
Note: The returned bounds is in baseline-relative coordinates
(see class notes ).
- Parameters:
chars - an array of charactersbeginIndex - the initial offset of the array of
characterslimit - the end offset of the array of characterscontext - 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)
|
|
getStringBounds |
java.awt.geom.Rectangle2D getStringBounds(java.text.CharacterIterator ci,
int beginIndex,
int limit,
Graphics context)
Returns the bounds of the characters indexed in the specified
CharacterIterator in the
specified Graphics context.
public java.awt.geom.Rectangle2D getStringBounds(java.text.CharacterIterator ci,
int beginIndex,
int limit,
Graphics context)
-
Returns the bounds of the characters indexed in the specified
CharacterIterator in the
specified Graphics context.
Note: The returned bounds is in baseline-relative coordinates
(see class notes ).
- 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)
|
|
getStringBounds |
java.awt.geom.Rectangle2D getStringBounds(java.lang.String str,
Graphics context)
Returns the bounds of the specified String in the
specified Graphics context.
public java.awt.geom.Rectangle2D getStringBounds(java.lang.String str,
Graphics context)
-
Returns the bounds of the specified String in the
specified Graphics context. The bounds is used
to layout the String .
Note: The returned bounds is in baseline-relative coordinates
(see class notes ).
- Parameters:
str - the specified String 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, FontRenderContext)
|
|
getStringBounds |
java.awt.geom.Rectangle2D getStringBounds(java.lang.String str,
int beginIndex,
int limit,
Graphics context)
Returns the bounds of the specified String in the
specified Graphics context.
public java.awt.geom.Rectangle2D getStringBounds(java.lang.String str,
int beginIndex,
int limit,
Graphics context)
-
Returns the bounds of the specified String in the
specified Graphics context. The bounds is used
to layout the String .
Note: The returned bounds is in baseline-relative coordinates
(see class notes ).
- Parameters:
str - the specified String beginIndex - the offset of the beginning of str limit - the end offset 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)
|
|
getWidths |
int[] getWidths()
Gets the advance widths of the first 256 characters in the
Font .
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 |
boolean hasUniformLineMetrics()
Checks to see if the Font has uniform line metrics.
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()
|
|
stringWidth |
int stringWidth(java.lang.String str)
Returns the total advance width for showing the specified
String in this Font .
public int stringWidth(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 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 .
- Throws:
java.lang.NullPointerException - if str is null.- See Also:
bytesWidth(byte[], int, int) ,
charsWidth(char[], int, int) ,
getStringBounds(String, Graphics)
|
|
toString |
java.lang.String toString()
Returns a representation of this FontMetrics
object's values as a String .
public java.lang.String toString()
-
Returns a representation of this FontMetrics
object's values as a String .
- Overrides:
toString in class java.lang.Object
- Returns:
- a
String representation of this
FontMetrics object. - Since:
- JDK1.0.
|