Thread Safety: All classes that implement the
* FontDelegate interface must allow calling these
* methods from multiple concurrent threads. The delegates are
* responsible for performing the necessary synchronization.
*
* @author Sascha Brawer (brawer@dandelis.ch)
*/
public interface FontDelegate
{
public static final int FLAG_FITTED = 1 << 0;
public static final int FLAG_NO_HINT_HORIZONTAL = 1 << 1;
public static final int FLAG_NO_HINT_VERTICAL = 1 << 2;
public static final int FLAG_NO_HINT_EDGE_POINTS = 1 << 3;
public static final int FLAG_NO_HINT_STRONG_POINTS = 1 << 4;
public static final int FLAG_NO_HINT_WEAK_POINTS = 1 << 5;
/**
* Returns the full name of this font face in the specified
* locale, for example “Univers Light”.
*
* @param locale the locale for which to localize the name.
*
* @return the face name.
*/
public String getFullName(Locale locale);
/**
* Returns the name of the family to which this font face belongs,
* for example “Univers”.
*
* @param locale the locale for which to localize the name.
*
* @return the family name.
*/
public String getFamilyName(Locale locale);
/**
* Returns the name of this font face inside the family, for example
* “Light”.
*
* @param locale the locale for which to localize the name.
*
* @return the name of the face inside its family.
*/
public String getSubFamilyName(Locale locale);
/**
* Returns the PostScript name of this font face, for example
* “Helvetica-Bold”.
*
* @return the PostScript name, or null if the font
* does not provide a PostScript name.
*/
public String getPostScriptName();
/**
* Returns the number of glyphs in this font face.
*/
public int getNumGlyphs();
/**
* Returns the glyph code for the specified character.
*
* @param c the character to map
*
* @return the glyph code
*/
public int getGlyphIndex(int c);
/**
* Returns the index of the glyph which gets displayed if the font
* cannot map a Unicode code point to a glyph. Many fonts show this
* glyph as an empty box.
*/
public int getMissingGlyphCode();
/**
* Creates a GlyphVector by mapping each character in a
* CharacterIterator to the corresponding glyph.
*
*
The mapping takes only the font’s cmap
* tables into consideration. No other operations (such as glyph
* re-ordering, composition, or ligature substitution) are
* performed. This means that the resulting GlyphVector will not be
* correct for text in languages that have complex
* character-to-glyph mappings, such as Arabic, Hebrew, Hindi, or
* Thai.
*
* @param font the font object that the created GlyphVector
* will return when it gets asked for its font. This argument is
* needed because the public API works with java.awt.Font,
* not with some private delegate like OpenTypeFont.
*
* @param frc the font rendering parameters that are used for
* measuring glyphs. The exact placement of text slightly depends on
* device-specific characteristics, for instance the device
* resolution or anti-aliasing. For this reason, any measurements
* will only be accurate if the passed
* FontRenderContext correctly reflects the relevant
* parameters. Hence, frc should be obtained from the
* same Graphics2D that will be used for drawing, and
* any rendering hints should be set to the desired values before
* obtaining frc.
*
* @param ci a CharacterIterator for iterating over the
* characters to be displayed.
*/
public GlyphVector createGlyphVector(Font font,
FontRenderContext frc,
CharacterIterator ci);
/**
* Determines the advance width and height for a glyph.
*
* @param glyphIndex the glyph whose advance width is to be
* determined.
*
* @param pointSize the point size of the font.
*
* @param transform a transform that is applied in addition to
* scaling to the specified point size. This is often used for
* scaling according to the device resolution. Those who lack any
* aesthetic sense may also use the transform to slant or stretch
* glyphs.
*
* @param antialias true for anti-aliased rendering,
* false for normal rendering. For hinted fonts,
* this parameter may indeed affect the result.
*
* @param fractionalMetrics true for fractional metrics,
* false for rounding the result to a pixel boundary.
*
* @param horizontal true for horizontal line layout,
* false for vertical line layout.
*
* @param advance a point whose x and y
* fields will hold the advance in each direction. It is well
* possible that both values are non-zero, for example for rotated
* text or for Urdu fonts.
*/
public void getAdvance(int glyphIndex,
float pointSize,
AffineTransform transform,
boolean antialias,
boolean fractionalMetrics,
boolean horizontal,
Point2D advance);
/**
* Returns the shape of a glyph.
*
* @param glyphIndex the glyph whose advance width is to be
* determined.
*
* @param pointSize the point size of the font.
*
* @param transform a transform that is applied in addition to
* scaling to the specified point size. This is often used for
* scaling according to the device resolution. Those who lack any
* aesthetic sense may also use the transform to slant or stretch
* glyphs.
*
* @param antialias true for anti-aliased rendering,
* false for normal rendering. For hinted fonts, this
* parameter may indeed affect the result.
*
* @param fractionalMetrics true for fractional
* metrics, false for rounding the result to a pixel
* boundary.
*
* @return the scaled and grid-fitted outline of the specified
* glyph, or null for bitmap fonts.
*/
public GeneralPath getGlyphOutline(int glyphIndex,
float pointSize,
AffineTransform transform,
boolean antialias,
boolean fractionalMetrics,
int type);
/**
* Returns a name for the specified glyph. This is useful for
* generating PostScript or PDF files that embed some glyphs of a
* font.
*
*
Names are not unique: Under some rare circumstances, * the same name can be returned for different glyphs. It is * therefore recommended that printer drivers check whether the same * name has already been returned for antoher glyph, and make the * name unique by adding the string ".alt" followed by the glyph * index.
* *This situation would occur for an OpenType or TrueType font
* that has a post table of format 3 and provides a
* mapping from glyph IDs to Unicode sequences through a
* Zapf table. If the same sequence of Unicode
* codepoints leads to different glyphs (depending on contextual
* position, for example, or on typographic sophistication level),
* the same name would get synthesized for those glyphs.
*
* @param glyphIndex the glyph whose name the caller wants to
* retrieve.
*/
public String getGlyphName(int glyphIndex);
/**
* Determines the distance between the base line and the highest
* ascender.
*
* @param pointSize the point size of the font.
*
* @param transform a transform that is applied in addition to
* scaling to the specified point size. This is often used for
* scaling according to the device resolution. Those who lack any
* aesthetic sense may also use the transform to slant or stretch
* glyphs.
*
* @param antialiased true for anti-aliased rendering,
* false for normal rendering. For hinted fonts,
* this parameter may indeed affect the result.
*
* @param fractionalMetrics true for fractional metrics,
* false for rounding the result to a pixel boundary.
*
* @param horizontal true for horizontal line layout,
* false for vertical line layout.
*
* @return the ascent, which usually is a positive number.
*/
public float getAscent(float pointSize,
AffineTransform transform,
boolean antialiased,
boolean fractionalMetrics,
boolean horizontal);
/**
* Determines the distance between the base line and the lowest
* descender.
*
* @param pointSize the point size of the font.
*
* @param transform a transform that is applied in addition to
* scaling to the specified point size. This is often used for
* scaling according to the device resolution. Those who lack any
* aesthetic sense may also use the transform to slant or stretch
* glyphs.
*
* @param antialiased true for anti-aliased rendering,
* false for normal rendering. For hinted fonts,
* this parameter may indeed affect the result.
*
* @param fractionalMetrics true for fractional metrics,
* false for rounding the result to a pixel boundary.
*
* @param horizontal true for horizontal line layout,
* false for vertical line layout.
*
* @return the descent, which usually is a nagative number.
*/
public float getDescent(float pointSize,
AffineTransform transform,
boolean antialiased,
boolean fractionalMetrics,
boolean horizontal);
}