public final class GlyphMetrics extends Object
GlyphMetrics class represents information for a single glyph. A glyph is the visual representation of one or more characters. Many different glyphs can be used to represent a single character or combination of characters.
GlyphMetrics instances are produced by
Font and are applicable to a specific glyph in a particular
Glyphs are either STANDARD, LIGATURE, COMBINING, or COMPONENT.
GlyphVectordo not correspond to a particular character in a text model. Instead, COMPONENT glyphs are added for typographical reasons, such as Arabic justification.
Other metrics available through
GlyphMetrics are the components of the advance, the visual bounds, and the left and right side bearings.
Glyphs for a rotated font, or obtained from a
GlyphVector which has applied a rotation to the glyph, can have advances that contain both X and Y components. Usually the advance only has one component.
The advance of a glyph is the distance from the glyph's origin to the origin of the next glyph along the baseline, which is either vertical or horizontal. Note that, in a
GlyphVector, the distance from a glyph to its following glyph might not be the glyph's advance, because of kerning or other positioning adjustments.
The bounds is the smallest rectangle that completely contains the outline of the glyph. The bounds rectangle is relative to the glyph's origin. The left-side bearing is the distance from the glyph origin to the left of its bounds rectangle. If the left-side bearing is negative, part of the glyph is drawn to the left of its origin. The right-side bearing is the distance from the right side of the bounds rectangle to the next glyph origin (the origin plus the advance). If negative, part of the glyph is drawn to the right of the next glyph's origin. Note that the bounds does not necessarily enclose all the pixels affected when rendering the glyph, because of rasterization and pixel adjustment effects.
Although instances of
GlyphMetrics can be directly constructed, they are almost always obtained from a
GlyphVector. Once constructed,
GlyphMetrics objects are immutable.
Font for glyph information
Font font = ...; int glyphIndex = ...; GlyphMetrics metrics = GlyphVector.getGlyphMetrics(glyphIndex); int isStandard = metrics.isStandard(); float glyphAdvance = metrics.getAdvance();
public static final byte STANDARD
Indicates a glyph that represents a single standard character.
public static final byte LIGATURE
Indicates a glyph that represents multiple characters as a ligature, for example 'fi' or 'ffi'. It is followed by filler glyphs for the remaining characters. Filler and combining glyphs can be intermixed to control positioning of accent marks on the logically preceding ligature.
public static final byte COMBINING
Indicates a glyph that represents a combining character, such as an umlaut. There is no caret position between this glyph and the preceding glyph.
public static final byte COMPONENT
Indicates a glyph with no corresponding character in the backing store. The glyph is associated with the character represented by the logically preceding non-component glyph. This is used for kashida justification or other visual modifications to existing glyphs. There is no caret position between this glyph and the preceding glyph.
public static final byte WHITESPACE
Indicates a glyph with no visual representation. It can be added to the other code values to indicate an invisible glyph.
public GlyphMetrics(float advance, Rectangle2D bounds, byte glyphType)
advance- the advance width of the glyph
bounds- the black box bounds of the glyph
glyphType- the type of the glyph
public GlyphMetrics(boolean horizontal, float advanceX, float advanceY, Rectangle2D bounds, byte glyphType)
horizontal- if true, metrics are for a horizontal baseline, otherwise they are for a vertical baseline
advanceX- the X-component of the glyph's advance
advanceY- the Y-component of the glyph's advance
bounds- the visual bounds of the glyph
glyphType- the type of the glyph
public float getAdvance()
Returns the advance of the glyph along the baseline (either horizontal or vertical).
public float getAdvanceX()
Returns the x-component of the advance of the glyph.
public float getAdvanceY()
Returns the y-component of the advance of the glyph.
public Rectangle2D getBounds2D()
Returns the bounds of the glyph. This is the bounding box of the glyph outline. Because of rasterization and pixel alignment effects, it does not necessarily enclose the pixels that are affected when rendering the glyph.
Rectangle2Dthat is the bounds of the glyph.
public float getLSB()
Returns the left (top) side bearing of the glyph.
This is the distance from 0, 0 to the left (top) of the glyph bounds. If the bounds of the glyph is to the left of (above) the origin, the LSB is negative.
public float getRSB()
Returns the right (bottom) side bearing of the glyph.
This is the distance from the right (bottom) of the glyph bounds to the advance. If the bounds of the glyph is to the right of (below) the advance, the RSB is negative.
public int getType()
Returns the raw glyph type code.
public boolean isStandard()
true if this is a standard glyph.
trueif this is a standard glyph;
public boolean isLigature()
true if this is a ligature glyph.
trueif this is a ligature glyph;
public boolean isCombining()
true if this is a combining glyph.
trueif this is a combining glyph;
public boolean isComponent()
true if this is a component glyph.
trueif this is a component glyph;
public boolean isWhitespace()
true if this is a whitespace glyph.
trueif this is a whitespace glyph;
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.