Home » openjdk-7 » java » awt » [javadoc | source]

java.awt
public class: Font [javadoc | source]

java.lang.Object
   java.awt.Font

All Implemented Interfaces:
    java$io$Serializable

Direct Known Subclasses:
    FontUIResource

The Font class represents fonts, which are used to render text in a visible way. A font provides the information needed to map sequences of characters to sequences of glyphs and to render sequences of glyphs on Graphics and Component objects.

Characters and Glyphs

A character is a symbol that represents an item such as a letter, a digit, or punctuation in an abstract way. For example, 'g', LATIN SMALL LETTER G, is a character.

A glyph is a shape used to render a character or a sequence of characters. In simple writing systems, such as Latin, typically one glyph represents one character. In general, however, characters and glyphs do not have one-to-one correspondence. For example, the character 'á' LATIN SMALL LETTER A WITH ACUTE, can be represented by two glyphs: one for 'a' and one for '´'. On the other hand, the two-character string "fi" can be represented by a single glyph, an "fi" ligature. In complex writing systems, such as Arabic or the South and South-East Asian writing systems, the relationship between characters and glyphs can be more complicated and involve context-dependent selection of glyphs as well as glyph reordering. A font encapsulates the collection of glyphs needed to render a selected set of characters as well as the tables needed to map sequences of characters to corresponding sequences of glyphs.

Physical and Logical Fonts

The Java Platform distinguishes between two kinds of fonts: physical fonts and logical fonts.

Physical fonts are the actual font libraries containing glyph data and tables to map from character sequences to glyph sequences, using a font technology such as TrueType or PostScript Type 1. All implementations of the Java Platform must support TrueType fonts; support for other font technologies is implementation dependent. Physical fonts may use names such as Helvetica, Palatino, HonMincho, or any number of other font names. Typically, each physical font supports only a limited set of writing systems, for example, only Latin characters or only Japanese and Basic Latin. The set of available physical fonts varies between configurations. Applications that require specific fonts can bundle them and instantiate them using the createFont method.

Logical fonts are the five font families defined by the Java platform which must be supported by any Java runtime environment: Serif, SansSerif, Monospaced, Dialog, and DialogInput. These logical fonts are not actual font libraries. Instead, the logical font names are mapped to physical fonts by the Java runtime environment. The mapping is implementation and usually locale dependent, so the look and the metrics provided by them vary. Typically, each logical font name maps to several physical fonts in order to cover a large range of characters.

Peered AWT components, such as Label and TextField , can only use logical fonts.

For a discussion of the relative advantages and disadvantages of using physical or logical fonts, see the Internationalization FAQ document.

Font Faces and Names

A Font can have many faces, such as heavy, medium, oblique, gothic and regular. All of these faces have similar typographic design.

There are three different names that you can get from a Font object. The logical font name is simply the name that was used to construct the font. The font face name, or just font name for short, is the name of a particular font face, like Helvetica Bold. The family name is the name of the font family that determines the typographic design across several faces, like Helvetica.

The Font class represents an instance of a font face from a collection of font faces that are present in the system resources of the host system. As examples, Arial Bold and Courier Bold Italic are font faces. There can be several Font objects associated with a font face, each differing in size, style, transform and font features.

The getAllFonts method of the GraphicsEnvironment class returns an array of all font faces available in the system. These font faces are returned as Font objects with a size of 1, identity transform and default font features. These base fonts can then be used to derive new Font objects with varying sizes, styles, transforms and font features via the deriveFont methods in this class.

Font and TextAttribute

Font supports most TextAttributes. This makes some operations, such as rendering underlined text, convenient since it is not necessary to explicitly construct a TextLayout object. Attributes can be set on a Font by constructing or deriving it using a Map of TextAttribute values.

The values of some TextAttributes are not serializable, and therefore attempting to serialize an instance of Font that has such values will not serialize them. This means a Font deserialized from such a stream will not compare equal to the original Font that contained the non-serializable attributes. This should very rarely pose a problem since these attributes are typically used only in special circumstances and are unlikely to be serialized.

• FOREGROUND and BACKGROUND use Paint values. The subclass Color is serializable, while GradientPaint and TexturePaint are not.
• CHAR_REPLACEMENT uses GraphicAttribute values. The subclasses ShapeGraphicAttribute and ImageGraphicAttribute are not serializable.
• INPUT_METHOD_HIGHLIGHT uses InputMethodHighlight values, which are not serializable. See java.awt.im.InputMethodHighlight .

Clients who create custom subclasses of Paint and GraphicAttribute can make them serializable and avoid this problem. Clients who use input method highlights can convert these to the platform-specific attributes for that highlight on the current platform and set them on the Font as a workaround.

The Map-based constructor and deriveFont APIs ignore the FONT attribute, and it is not retained by the Font; the static #getFont method should be used if the FONT attribute might be present. See java.awt.font.TextAttribute#FONT for more information.

Several attributes will cause additional rendering overhead and potentially invoke layout. If a Font has such attributes, the #hasLayoutAttributes() method will return true.

Note: Font rotations can cause text baselines to be rotated. In order to account for this (rare) possibility, font APIs are specified to return metrics and take parameters 'in baseline-relative coordinates'. This maps the 'x' coordinate to the advance along the baseline, (positive x is forward along the baseline), and the 'y' coordinate to a distance along the perpendicular to the baseline at 'x' (positive y is 90 degrees clockwise from the baseline vector). APIs for which this is especially important are called out as having 'baseline-relative coordinates.'

Field Summary
public static final  String	DIALOG	A String constant for the canonical family name of the logical font "Dialog". It is useful in Font construction to provide compile-time verification of the name. since: 1.6 -
public static final  String	DIALOG_INPUT	A String constant for the canonical family name of the logical font "DialogInput". It is useful in Font construction to provide compile-time verification of the name. since: 1.6 -
public static final  String	SANS_SERIF	A String constant for the canonical family name of the logical font "SansSerif". It is useful in Font construction to provide compile-time verification of the name. since: 1.6 -
public static final  String	SERIF	A String constant for the canonical family name of the logical font "Serif". It is useful in Font construction to provide compile-time verification of the name. since: 1.6 -
public static final  String	MONOSPACED	A String constant for the canonical family name of the logical font "Monospaced". It is useful in Font construction to provide compile-time verification of the name. since: 1.6 -
public static final  int	PLAIN	The plain style constant.
public static final  int	BOLD	The bold style constant. This can be combined with the other style constants (except PLAIN) for mixed styles.
public static final  int	ITALIC	The italicized style constant. This can be combined with the other style constants (except PLAIN) for mixed styles.
public static final  int	ROMAN_BASELINE	The baseline used in most Roman scripts when laying out text.
public static final  int	CENTER_BASELINE	The baseline used in ideographic scripts like Chinese, Japanese, and Korean when laying out text.
public static final  int	HANGING_BASELINE	The baseline used in Devanigiri and similar scripts when laying out text.
public static final  int	TRUETYPE_FONT	Identify a font resource of type TRUETYPE. Used to specify a TrueType font resource to the #createFont method. The TrueType format was extended to become the OpenType format, which adds support for fonts with Postscript outlines, this tag therefore references these fonts, as well as those with TrueType outlines. since: 1.3 -
public static final  int	TYPE1_FONT	Identify a font resource of type TYPE1. Used to specify a Type1 font resource to the #createFont method. since: 1.5 -
protected  String	name	The logical name of this Font, as passed to the constructor. Also see: getName since: JDK1.0 - serial:
protected  int	style	The style of this Font, as passed to the constructor. This style can be PLAIN, BOLD, ITALIC, or BOLD+ITALIC. Also see: getStyle() since: JDK1.0 - serial:
protected  int	size	The point size of this Font, rounded to integer. Also see: getSize() since: JDK1.0 - serial:
protected  float	pointSize	The point size of this Font in float. Also see: getSize() getSize2D() serial:
transient  int	hash
public static final  int	LAYOUT_LEFT_TO_RIGHT	A flag to layoutGlyphVector indicating that text is left-to-right as determined by Bidi analysis.
public static final  int	LAYOUT_RIGHT_TO_LEFT	A flag to layoutGlyphVector indicating that text is right-to-left as determined by Bidi analysis.
public static final  int	LAYOUT_NO_START_CONTEXT	A flag to layoutGlyphVector indicating that text in the char array before the indicated start should not be examined.
public static final  int	LAYOUT_NO_LIMIT_CONTEXT	A flag to layoutGlyphVector indicating that text in the char array after the indicated limit should not be examined.

Constructor:
public Font(Map<Attribute, ?> attributes) { initFromValues(AttributeValues.fromMap(attributes, RECOGNIZED_MASK)); } Creates a new Font with the specified attributes. Only keys defined in TextAttribute are recognized. In addition the FONT attribute is not recognized by this constructor (see #getAvailableAttributes ). Only attributes that have values of valid types will affect the new Font. If attributes is null, a new Font is initialized with default values. Parameters: attributes - the attributes to assign to the new Font, or null Also see: java.awt.font.TextAttribute
protected Font(Font font) { if (font.values != null) { initFromValues(font.getAttributeValues().clone()); } else { this.name = font.name; this.style = font.style; this.size = font.size; this.pointSize = font.pointSize; } this.font2DHandle = font.font2DHandle; this.createdFont = font.createdFont; } Creates a new Font from the specified font. This constructor is intended for use by subclasses. Parameters: font - from which to create this Font. Throws: NullPointerException - if font is null since: 1.6 -
public Font(String name, int style, int size) { this.name = (name != null) ? name : "Default"; this.style = (style & ~0x03) == 0 ? style : 0; this.size = size; this.pointSize = size; } Creates a new Font from the specified name, style and point size. The font name can be a font face name or a font family name. It is used together with the style to find an appropriate font face. When a font family name is specified, the style argument is used to select the most appropriate face from the family. When a font face name is specified, the face's style and the style argument are merged to locate the best matching font from the same family. For example if face name "Arial Bold" is specified with style Font.ITALIC, the font system looks for a face in the "Arial" family that is bold and italic, and may associate the font instance with the physical font face "Arial Bold Italic". The style argument is merged with the specified face's style, not added or subtracted. This means, specifying a bold face and a bold style does not double-embolden the font, and specifying a bold face and a plain style does not lighten the font. If no face for the requested style can be found, the font system may apply algorithmic styling to achieve the desired style. For example, if ITALIC is requested, but no italic face is available, glyphs from the plain face may be algorithmically obliqued (slanted). Font name lookup is case insensitive, using the case folding rules of the US locale. If the name parameter represents something other than a logical font, i.e. is interpreted as a physical font face or family, and this cannot be mapped by the implementation to a physical font or a compatible alternative, then the font system will map the Font instance to "Dialog", such that for example, the family as reported by getFamily will be "Dialog". Parameters: name - the font name. This can be a font face name or a font family name, and may represent either a logical font or a physical font found in this {@code GraphicsEnvironment}. The family names for logical fonts are: Dialog, DialogInput, Monospaced, Serif, or SansSerif. Pre-defined String constants exist for all of these names, for example, {@code DIALOG}. If {@code name} is {@code null}, the logical font name of the new {@code Font} as returned by {@code getName()} is set to the name "Default". style - the style constant for the {@code Font} The style argument is an integer bitmask that may be {@code PLAIN}, or a bitwise union of {@code BOLD} and/or {@code ITALIC} (for example, {@code ITALIC} or {@code BOLD|ITALIC}). If the style argument does not conform to one of the expected integer bitmasks then the style is set to {@code PLAIN}. size - the point size of the {@code Font} Also see: GraphicsEnvironment#getAllFonts GraphicsEnvironment#getAvailableFontFamilyNames since: JDK1.0 -

Method from java.awt.Font Summary:

canDisplay,   canDisplay,   canDisplayUpTo,   canDisplayUpTo,   canDisplayUpTo,   createFont,   createFont,   createGlyphVector,   createGlyphVector,   createGlyphVector,   createGlyphVector,   decode,   deriveFont,   deriveFont,   deriveFont,   deriveFont,   deriveFont,   deriveFont,   equals,   getAttributes,   getAvailableAttributes,   getBaselineFor,   getFamily,   getFamily,   getFamily_NoClientCode,   getFont,   getFont,   getFont,   getFontName,   getFontName,   getItalicAngle,   getLineMetrics,   getLineMetrics,   getLineMetrics,   getLineMetrics,   getMaxCharBounds,   getMissingGlyphCode,   getName,   getNumGlyphs,   getPSName,   getPeer,   getPeer_NoClientCode,   getSize,   getSize2D,   getStringBounds,   getStringBounds,   getStringBounds,   getStringBounds,   getStyle,   getTransform,   hasLayoutAttributes,   hasUniformLineMetrics,   hashCode,   isBold,   isItalic,   isPlain,   isTransformed,   layoutGlyphVector,   toString

Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait

Method from java.awt.Font Detail:
public boolean canDisplay(char c) { return getFont2D().canDisplay(c); } Checks if this Font has a glyph for the specified character. Note: This method cannot handle supplementary characters. To support all Unicode characters, including supplementary characters, use the #canDisplay(int) method or canDisplayUpTo methods.
public boolean canDisplay(int codePoint) { if (!Character.isValidCodePoint(codePoint)) { throw new IllegalArgumentException("invalid code point: " + Integer.toHexString(codePoint)); } return getFont2D().canDisplay(codePoint); } Checks if this Font has a glyph for the specified character.
public int canDisplayUpTo(String str) { Font2D font2d = getFont2D(); int len = str.length(); for (int i = 0; i < len; i++) { char c = str.charAt(i); if (font2d.canDisplay(c)) { continue; } if (!Character.isHighSurrogate(c)) { return i; } if (!font2d.canDisplay(str.codePointAt(i))) { return i; } i++; } return -1; } Indicates whether or not this Font can display a specified String. For strings with Unicode encoding, it is important to know if a particular font can display the string. This method returns an offset into the String str which is the first character this Font cannot display without using the missing glyph code. If the Font can display all characters, -1 is returned.
public int canDisplayUpTo(char[] text, int start, int limit) { Font2D font2d = getFont2D(); for (int i = start; i < limit; i++) { char c = text[i]; if (font2d.canDisplay(c)) { continue; } if (!Character.isHighSurrogate(c)) { return i; } if (!font2d.canDisplay(Character.codePointAt(text, i, limit))) { return i; } i++; } return -1; } Indicates whether or not this Font can display the characters in the specified text starting at start and ending at limit. This method is a convenience overload.
public int canDisplayUpTo(CharacterIterator iter, int start, int limit) { Font2D font2d = getFont2D(); char c = iter.setIndex(start); for (int i = start; i < limit; i++, c = iter.next()) { if (font2d.canDisplay(c)) { continue; } if (!Character.isHighSurrogate(c)) { return i; } char c2 = iter.next(); // c2 could be CharacterIterator.DONE which is not a low surrogate. if (!Character.isLowSurrogate(c2)) { return i; } if (!font2d.canDisplay(Character.toCodePoint(c, c2))) { return i; } i++; } return -1; } Indicates whether or not this Font can display the text specified by the iter starting at start and ending at limit.
public static Font createFont(int fontFormat, InputStream fontStream) throws FontFormatException, IOException { if (fontFormat != Font.TRUETYPE_FONT && fontFormat != Font.TYPE1_FONT) { throw new IllegalArgumentException ("font format not recognized"); } boolean copiedFontData = false; try { final File tFile = AccessController.doPrivileged( new PrivilegedExceptionAction< File >() { public File run() throws IOException { return File.createTempFile("+~JF", ".tmp", null); } } ); int totalSize = 0; CreatedFontTracker tracker = null; try { final OutputStream outStream = AccessController.doPrivileged( new PrivilegedExceptionAction< OutputStream >() { public OutputStream run() throws IOException { return new FileOutputStream(tFile); } } ); if (!hasTempPermission()) { tracker = CreatedFontTracker.getTracker(); } try { byte[] buf = new byte[8192]; for (;;) { int bytesRead = fontStream.read(buf); if (bytesRead < 0) { break; } if (tracker != null) { if (totalSize+bytesRead > tracker.MAX_FILE_SIZE) { throw new IOException("File too big."); } if (totalSize+tracker.getNumBytes() > tracker.MAX_TOTAL_BYTES) { throw new IOException("Total files too big."); } totalSize += bytesRead; tracker.addBytes(bytesRead); } outStream.write(buf, 0, bytesRead); } /* don't close the input stream */ } finally { outStream.close(); } /* After all references to a Font2D are dropped, the file * will be removed. To support long-lived AppContexts, * we need to then decrement the byte count by the size * of the file. * If the data isn't a valid font, the implementation will * delete the tmp file and decrement the byte count * in the tracker object before returning from the * constructor, so we can set 'copiedFontData' to true here * without waiting for the results of that constructor. */ copiedFontData = true; Font font = new Font(tFile, fontFormat, true, tracker); return font; } finally { if (!copiedFontData) { if (tracker != null) { tracker.subBytes(totalSize); } AccessController.doPrivileged( new PrivilegedExceptionAction< Void >() { public Void run() { tFile.delete(); return null; } } ); } } } catch (Throwable t) { if (t instanceof FontFormatException) { throw (FontFormatException)t; } if (t instanceof IOException) { throw (IOException)t; } Throwable cause = t.getCause(); if (cause instanceof FontFormatException) { throw (FontFormatException)cause; } throw new IOException("Problem reading font data."); } } Returns a new Font using the specified font type and input data. The new Font is created with a point size of 1 and style PLAIN . This base font can then be used with the deriveFont methods in this class to derive new Font objects with varying sizes, styles, transforms and font features. This method does not close the InputStream . To make the Font available to Font constructors the returned Font must be registered in the GraphicsEnviroment by calling registerFont(Font) .
public static Font createFont(int fontFormat, File fontFile) throws FontFormatException, IOException { fontFile = new File(fontFile.getPath()); if (fontFormat != Font.TRUETYPE_FONT && fontFormat != Font.TYPE1_FONT) { throw new IllegalArgumentException ("font format not recognized"); } SecurityManager sm = System.getSecurityManager(); if (sm != null) { FilePermission filePermission = new FilePermission(fontFile.getPath(), "read"); sm.checkPermission(filePermission); } if (!fontFile.canRead()) { throw new IOException("Can't read " + fontFile); } return new Font(fontFile, fontFormat, false, null); } Returns a new Font using the specified font type and the specified font file. The new Font is created with a point size of 1 and style PLAIN . This base font can then be used with the deriveFont methods in this class to derive new Font objects with varying sizes, styles, transforms and font features.
public GlyphVector createGlyphVector(FontRenderContext frc, String str) { return (GlyphVector)new StandardGlyphVector(this, str, frc); } Creates a GlyphVector by mapping characters to glyphs one-to-one based on the Unicode cmap in this Font. This method does no other processing besides the mapping of glyphs to characters. This means that this method is not useful for some scripts, such as Arabic, Hebrew, Thai, and Indic, that require reordering, shaping, or ligature substitution.
public GlyphVector createGlyphVector(FontRenderContext frc, char[] chars) { return (GlyphVector)new StandardGlyphVector(this, chars, frc); } Creates a GlyphVector by mapping characters to glyphs one-to-one based on the Unicode cmap in this Font. This method does no other processing besides the mapping of glyphs to characters. This means that this method is not useful for some scripts, such as Arabic, Hebrew, Thai, and Indic, that require reordering, shaping, or ligature substitution.
public GlyphVector createGlyphVector(FontRenderContext frc, CharacterIterator ci) { return (GlyphVector)new StandardGlyphVector(this, ci, frc); } Creates a GlyphVector by mapping the specified characters to glyphs one-to-one based on the Unicode cmap in this Font. This method does no other processing besides the mapping of glyphs to characters. This means that this method is not useful for some scripts, such as Arabic, Hebrew, Thai, and Indic, that require reordering, shaping, or ligature substitution.
public GlyphVector createGlyphVector(FontRenderContext frc, int[] glyphCodes) { return (GlyphVector)new StandardGlyphVector(this, glyphCodes, frc); } Creates a GlyphVector by mapping characters to glyphs one-to-one based on the Unicode cmap in this Font. This method does no other processing besides the mapping of glyphs to characters. This means that this method is not useful for some scripts, such as Arabic, Hebrew, Thai, and Indic, that require reordering, shaping, or ligature substitution.
public static Font decode(String str) { String fontName = str; String styleName = ""; int fontSize = 12; int fontStyle = Font.PLAIN; if (str == null) { return new Font(DIALOG, fontStyle, fontSize); } int lastHyphen = str.lastIndexOf('-'); int lastSpace = str.lastIndexOf(' '); char sepChar = (lastHyphen > lastSpace) ? '-' : ' '; int sizeIndex = str.lastIndexOf(sepChar); int styleIndex = str.lastIndexOf(sepChar, sizeIndex-1); int strlen = str.length(); if (sizeIndex > 0 && sizeIndex+1 < strlen) { try { fontSize = Integer.valueOf(str.substring(sizeIndex+1)).intValue(); if (fontSize < = 0) { fontSize = 12; } } catch (NumberFormatException e) { /* It wasn't a valid size, if we didn't also find the * start of the style string perhaps this is the style */ styleIndex = sizeIndex; sizeIndex = strlen; if (str.charAt(sizeIndex-1) == sepChar) { sizeIndex--; } } } if (styleIndex >= 0 && styleIndex+1 < strlen) { styleName = str.substring(styleIndex+1, sizeIndex); styleName = styleName.toLowerCase(Locale.ENGLISH); if (styleName.equals("bolditalic")) { fontStyle = Font.BOLD | Font.ITALIC; } else if (styleName.equals("italic")) { fontStyle = Font.ITALIC; } else if (styleName.equals("bold")) { fontStyle = Font.BOLD; } else if (styleName.equals("plain")) { fontStyle = Font.PLAIN; } else { /* this string isn't any of the expected styles, so * assume its part of the font name */ styleIndex = sizeIndex; if (str.charAt(styleIndex-1) == sepChar) { styleIndex--; } } fontName = str.substring(0, styleIndex); } else { int fontEnd = strlen; if (styleIndex > 0) { fontEnd = styleIndex; } else if (sizeIndex > 0) { fontEnd = sizeIndex; } if (fontEnd > 0 && str.charAt(fontEnd-1) == sepChar) { fontEnd--; } fontName = str.substring(0, fontEnd); } return new Font(fontName, fontStyle, fontSize); } Returns the Font that the str argument describes. To ensure that this method returns the desired Font, format the str parameter in one of these ways fontname-style-pointsize fontname-pointsize fontname-style fontname fontname style pointsize fontname pointsize fontname style fontname in which style is one of the four case-insensitive strings: "PLAIN", "BOLD", "BOLDITALIC", or "ITALIC", and pointsize is a positive decimal integer representation of the point size. For example, if you want a font that is Arial, bold, with a point size of 18, you would call this method with: "Arial-BOLD-18". This is equivalent to calling the Font constructor : new Font("Arial", Font.BOLD, 18); and the values are interpreted as specified by that constructor. A valid trailing decimal field is always interpreted as the pointsize. Therefore a fontname containing a trailing decimal value should not be used in the fontname only form. If a style name field is not one of the valid style strings, it is interpreted as part of the font name, and the default style is used. Only one of ' ' or '-' may be used to separate fields in the input. The identified separator is the one closest to the end of the string which separates a valid pointsize, or a valid style name from the rest of the string. Null (empty) pointsize and style fields are treated as valid fields with the default value for that field. Some font names may include the separator characters ' ' or '-'. If str is not formed with 3 components, e.g. such that style or pointsize fields are not present in str, and fontname also contains a character determined to be the separator character then these characters where they appear as intended to be part of fontname may instead be interpreted as separators so the font name may not be properly recognised. The default size is 12 and the default style is PLAIN. If str does not specify a valid size, the returned Font has a size of 12. If str does not specify a valid style, the returned Font has a style of PLAIN. If you do not specify a valid font name in the str argument, this method will return a font with the family name "Dialog". To determine what font family names are available on your system, use the GraphicsEnvironment#getAvailableFontFamilyNames() method. If str is null, a new Font is returned with the family name "Dialog", a size of 12 and a PLAIN style.
public Font deriveFont(float size) { if (values == null) { return new Font(name, style, size, createdFont, font2DHandle); } AttributeValues newValues = getAttributeValues().clone(); newValues.setSize(size); return new Font(newValues, null, -1, createdFont, font2DHandle); } Creates a new Font object by replicating the current Font object and applying a new size to it.
public Font deriveFont(AffineTransform trans) { AttributeValues newValues = getAttributeValues().clone(); applyTransform(trans, newValues); return new Font(newValues, null, -1, createdFont, font2DHandle); } Creates a new Font object by replicating the current Font object and applying a new transform to it.
public Font deriveFont(int style) { if (values == null) { return new Font(name, style, size, createdFont, font2DHandle); } AttributeValues newValues = getAttributeValues().clone(); int oldStyle = (this.style != style) ? this.style : -1; applyStyle(style, newValues); return new Font(newValues, null, oldStyle, createdFont, font2DHandle); } Creates a new Font object by replicating the current Font object and applying a new style to it.
public Font deriveFont(Map<Attribute, ?> attributes) { if (attributes == null) { return this; } AttributeValues newValues = getAttributeValues().clone(); newValues.merge(attributes, RECOGNIZED_MASK); return new Font(newValues, name, style, createdFont, font2DHandle); } Creates a new Font object by replicating the current Font object and applying a new set of font attributes to it.
public Font deriveFont(int style, float size) { if (values == null) { return new Font(name, style, size, createdFont, font2DHandle); } AttributeValues newValues = getAttributeValues().clone(); int oldStyle = (this.style != style) ? this.style : -1; applyStyle(style, newValues); newValues.setSize(size); return new Font(newValues, null, oldStyle, createdFont, font2DHandle); } Creates a new Font object by replicating this Font object and applying a new style and size.
public Font deriveFont(int style, AffineTransform trans) { AttributeValues newValues = getAttributeValues().clone(); int oldStyle = (this.style != style) ? this.style : -1; applyStyle(style, newValues); applyTransform(trans, newValues); return new Font(newValues, null, oldStyle, createdFont, font2DHandle); } Creates a new Font object by replicating this Font object and applying a new style and transform.
public boolean equals(Object obj) { if (obj == this) { return true; } if (obj != null) { try { Font font = (Font)obj; if (size == font.size && style == font.style && nonIdentityTx == font.nonIdentityTx && hasLayoutAttributes == font.hasLayoutAttributes && pointSize == font.pointSize && name.equals(font.name)) { /* 'values' is usually initialized lazily, except when * the font is constructed from a Map, or derived using * a Map or other values. So if only one font has * the field initialized we need to initialize it in * the other instance and compare. */ if (values == null) { if (font.values == null) { return true; } else { return getAttributeValues().equals(font.values); } } else { return values.equals(font.getAttributeValues()); } } } catch (ClassCastException e) { } } return false; } Compares this Font object to the specified Object.
public Map<TextAttribute, ?> getAttributes() { return new AttributeMap(getAttributeValues()); } Returns a map of font attributes available in this Font. Attributes include things like ligatures and glyph substitution.
public Attribute[] getAvailableAttributes() { // FONT is not supported by Font Attribute attributes[] = { TextAttribute.FAMILY, TextAttribute.WEIGHT, TextAttribute.WIDTH, TextAttribute.POSTURE, TextAttribute.SIZE, TextAttribute.TRANSFORM, TextAttribute.SUPERSCRIPT, TextAttribute.CHAR_REPLACEMENT, TextAttribute.FOREGROUND, TextAttribute.BACKGROUND, TextAttribute.UNDERLINE, TextAttribute.STRIKETHROUGH, TextAttribute.RUN_DIRECTION, TextAttribute.BIDI_EMBEDDING, TextAttribute.JUSTIFICATION, TextAttribute.INPUT_METHOD_HIGHLIGHT, TextAttribute.INPUT_METHOD_UNDERLINE, TextAttribute.SWAP_COLORS, TextAttribute.NUMERIC_SHAPING, TextAttribute.KERNING, TextAttribute.LIGATURES, TextAttribute.TRACKING, }; return attributes; } Returns the keys of all the attributes supported by this Font. These attributes can be used to derive other fonts.
public byte getBaselineFor(char c) { return getFont2D().getBaselineFor(c); } Returns the baseline appropriate for displaying this character. Large fonts can support different writing systems, and each system can use a different baseline. The character argument determines the writing system to use. Clients should not assume all characters use the same baseline.
public String getFamily() { return getFamily_NoClientCode(); } Returns the family name of this Font. The family name of a font is font specific. Two fonts such as Helvetica Italic and Helvetica Bold have the same family name, Helvetica, whereas their font face names are Helvetica Bold and Helvetica Italic. The list of available family names may be obtained by using the GraphicsEnvironment#getAvailableFontFamilyNames() method. Use getName to get the logical name of the font. Use getFontName to get the font face name of the font.
public String getFamily(Locale l) { if (l == null) { throw new NullPointerException("null locale doesn't mean default"); } return getFont2D().getFamilyName(l); } Returns the family name of this Font, localized for the specified locale. The family name of a font is font specific. Two fonts such as Helvetica Italic and Helvetica Bold have the same family name, Helvetica, whereas their font face names are Helvetica Bold and Helvetica Italic. The list of available family names may be obtained by using the GraphicsEnvironment#getAvailableFontFamilyNames() method. Use getFontName to get the font face name of the font.
final String getFamily_NoClientCode() { return getFamily(Locale.getDefault()); }
public static Font getFont(Map<Attribute, ?> attributes) { // optimize for two cases: // 1) FONT attribute, and nothing else // 2) attributes, but no FONT // avoid turning the attributemap into a regular map for no reason if (attributes instanceof AttributeMap && ((AttributeMap)attributes).getValues() != null) { AttributeValues values = ((AttributeMap)attributes).getValues(); if (values.isNonDefault(EFONT)) { Font font = values.getFont(); if (!values.anyDefined(SECONDARY_MASK)) { return font; } // merge values = font.getAttributeValues().clone(); values.merge(attributes, SECONDARY_MASK); return new Font(values, font.name, font.style, font.createdFont, font.font2DHandle); } return new Font(attributes); } Font font = (Font)attributes.get(TextAttribute.FONT); if (font != null) { if (attributes.size() > 1) { // oh well, check for anything else AttributeValues values = font.getAttributeValues().clone(); values.merge(attributes, SECONDARY_MASK); return new Font(values, font.name, font.style, font.createdFont, font.font2DHandle); } return font; } return new Font(attributes); } Returns a Font appropriate to the attributes. If attributescontains a FONT attribute with a valid Font as its value, it will be merged with any remaining attributes. See java.awt.font.TextAttribute#FONT for more information.
public static Font getFont(String nm) { return getFont(nm, null); } Returns a Font object from the system properties list. nm is treated as the name of a system property to be obtained. The String value of this property is then interpreted as a Font object according to the specification of Font.decode(String) If the specified property is not found, or the executing code does not have permission to read the property, null is returned instead.
public static Font getFont(String nm, Font font) { String str = null; try { str =System.getProperty(nm); } catch(SecurityException e) { } if (str == null) { return font; } return decode ( str ); } Gets the specified Font from the system properties list. As in the getProperty method of System, the first argument is treated as the name of a system property to be obtained. The String value of this property is then interpreted as a Font object. The property value should be one of the forms accepted by Font.decode(String) If the specified property is not found, or the executing code does not have permission to read the property, the font argument is returned instead.
public String getFontName() { return getFontName(Locale.getDefault()); } Returns the font face name of this Font. For example, Helvetica Bold could be returned as a font face name. Use getFamily to get the family name of the font. Use getName to get the logical name of the font.
public String getFontName(Locale l) { if (l == null) { throw new NullPointerException("null locale doesn't mean default"); } return getFont2D().getFontName(l); } Returns the font face name of the Font, localized for the specified locale. For example, Helvetica Fett could be returned as the font face name. Use getFamily to get the family name of the font.
public float getItalicAngle() { return getItalicAngle(null); } Returns the italic angle of this Font. The italic angle is the inverse slope of the caret which best matches the posture of this Font.
public LineMetrics getLineMetrics(String str, FontRenderContext frc) { FontLineMetrics flm = defaultLineMetrics(frc); flm.numchars = str.length(); return flm; } Returns a LineMetrics object created with the specified String and FontRenderContext .
public LineMetrics getLineMetrics(String str, int beginIndex, int limit, FontRenderContext frc) { FontLineMetrics flm = defaultLineMetrics(frc); int numChars = limit - beginIndex; flm.numchars = (numChars < 0)? 0: numChars; return flm; } Returns a LineMetrics object created with the specified arguments.
public LineMetrics getLineMetrics(char[] chars, int beginIndex, int limit, FontRenderContext frc) { FontLineMetrics flm = defaultLineMetrics(frc); int numChars = limit - beginIndex; flm.numchars = (numChars < 0)? 0: numChars; return flm; } Returns a LineMetrics object created with the specified arguments.
public LineMetrics getLineMetrics(CharacterIterator ci, int beginIndex, int limit, FontRenderContext frc) { FontLineMetrics flm = defaultLineMetrics(frc); int numChars = limit - beginIndex; flm.numchars = (numChars < 0)? 0: numChars; return flm; } Returns a LineMetrics object created with the specified arguments.
public Rectangle2D getMaxCharBounds(FontRenderContext frc) { float [] metrics = new float[4]; getFont2D().getFontMetrics(this, frc, metrics); return new Rectangle2D.Float(0, -metrics[0], metrics[3], metrics[0] + metrics[1] + metrics[2]); } Returns the bounds for the character with the maximum bounds as defined in the specified FontRenderContext. Note: The returned bounds is in baseline-relative coordinates (see class notes ).
public int getMissingGlyphCode() { return getFont2D().getMissingGlyphCode(); } Returns the glyphCode which is used when this Font does not have a glyph for a specified unicode code point.
public String getName() { return name; } Returns the logical name of this Font. Use getFamily to get the family name of the font. Use getFontName to get the font face name of the font.
public int getNumGlyphs() { return getFont2D().getNumGlyphs(); } Returns the number of glyphs in this Font. Glyph codes for this Font range from 0 to getNumGlyphs() - 1.
public String getPSName() { return getFont2D().getPostscriptName(); } Returns the postscript name of this Font. Use getFamily to get the family name of the font. Use getFontName to get the font face name of the font.
public FontPeer getPeer() { return getPeer_NoClientCode(); } Deprecated! Font - rendering is now platform independent. Gets the peer of this Font.
final FontPeer getPeer_NoClientCode() { if(peer == null) { Toolkit tk = Toolkit.getDefaultToolkit(); this.peer = tk.getFontPeer(name, style); } return peer; }
public int getSize() { return size; } Returns the point size of this Font, rounded to an integer. Most users are familiar with the idea of using point size to specify the size of glyphs in a font. This point size defines a measurement between the baseline of one line to the baseline of the following line in a single spaced text document. The point size is based on typographic points, approximately 1/72 of an inch. The Java(tm)2D API adopts the convention that one point is equivalent to one unit in user coordinates. When using a normalized transform for converting user space coordinates to device space coordinates 72 user space units equal 1 inch in device space. In this case one point is 1/72 of an inch.
public float getSize2D() { return pointSize; } Returns the point size of this Font in float value.
public Rectangle2D getStringBounds(String str, FontRenderContext frc) { char[] array = str.toCharArray(); return getStringBounds(array, 0, array.length, frc); } Returns the logical bounds of the specified String in the specified FontRenderContext. The logical bounds contains the origin, ascent, advance, and height, which includes the leading. The logical bounds does not always enclose all the text. For example, in some languages and in some fonts, accent marks can be positioned above the ascent or below the descent. To obtain a visual bounding box, which encloses all the text, use the getBounds method of TextLayout. Note: The returned bounds is in baseline-relative coordinates (see class notes ).
public Rectangle2D getStringBounds(String str, int beginIndex, int limit, FontRenderContext frc) { String substr = str.substring(beginIndex, limit); return getStringBounds(substr, frc); } Returns the logical bounds of the specified String in the specified FontRenderContext. The logical bounds contains the origin, ascent, advance, and height, which includes the leading. The logical bounds does not always enclose all the text. For example, in some languages and in some fonts, accent marks can be positioned above the ascent or below the descent. To obtain a visual bounding box, which encloses all the text, use the getBounds method of TextLayout. Note: The returned bounds is in baseline-relative coordinates (see class notes ).
public Rectangle2D getStringBounds(char[] chars, int beginIndex, int limit, FontRenderContext frc) { if (beginIndex < 0) { throw new IndexOutOfBoundsException("beginIndex: " + beginIndex); } if (limit > chars.length) { throw new IndexOutOfBoundsException("limit: " + limit); } if (beginIndex > limit) { throw new IndexOutOfBoundsException("range length: " + (limit - beginIndex)); } // this code should be in textlayout // quick check for simple text, assume GV ok to use if simple boolean simple = values == null || (values.getKerning() == 0 && values.getLigatures() == 0 && values.getBaselineTransform() == null); if (simple) { simple = ! FontUtilities.isComplexText(chars, beginIndex, limit); } if (simple) { GlyphVector gv = new StandardGlyphVector(this, chars, beginIndex, limit - beginIndex, frc); return gv.getLogicalBounds(); } else { // need char array constructor on textlayout String str = new String(chars, beginIndex, limit - beginIndex); TextLayout tl = new TextLayout(str, this, frc); return new Rectangle2D.Float(0, -tl.getAscent(), tl.getAdvance(), tl.getAscent() + tl.getDescent() + tl.getLeading()); } } Returns the logical bounds of the specified array of characters in the specified FontRenderContext. The logical bounds contains the origin, ascent, advance, and height, which includes the leading. The logical bounds does not always enclose all the text. For example, in some languages and in some fonts, accent marks can be positioned above the ascent or below the descent. To obtain a visual bounding box, which encloses all the text, use the getBounds method of TextLayout. Note: The returned bounds is in baseline-relative coordinates (see class notes ).
public Rectangle2D getStringBounds(CharacterIterator ci, int beginIndex, int limit, FontRenderContext frc) { int start = ci.getBeginIndex(); int end = ci.getEndIndex(); if (beginIndex < start) { throw new IndexOutOfBoundsException("beginIndex: " + beginIndex); } if (limit > end) { throw new IndexOutOfBoundsException("limit: " + limit); } if (beginIndex > limit) { throw new IndexOutOfBoundsException("range length: " + (limit - beginIndex)); } char[] arr = new char[limit - beginIndex]; ci.setIndex(beginIndex); for(int idx = 0; idx < arr.length; idx++) { arr[idx] = ci.current(); ci.next(); } return getStringBounds(arr,0,arr.length,frc); } Returns the logical bounds of the characters indexed in the specified CharacterIterator in the specified FontRenderContext. The logical bounds contains the origin, ascent, advance, and height, which includes the leading. The logical bounds does not always enclose all the text. For example, in some languages and in some fonts, accent marks can be positioned above the ascent or below the descent. To obtain a visual bounding box, which encloses all the text, use the getBounds method of TextLayout. Note: The returned bounds is in baseline-relative coordinates (see class notes ).
public int getStyle() { return style; } Returns the style of this Font. The style can be PLAIN, BOLD, ITALIC, or BOLD+ITALIC.
public AffineTransform getTransform() { /* The most common case is the identity transform. Most callers * should call isTransformed() first, to decide if they need to * get the transform, but some may not. Here we check to see * if we have a nonidentity transform, and only do the work to * fetch and/or compute it if so, otherwise we return a new * identity transform. * * Note that the transform is _not_ necessarily the same as * the transform passed in as an Attribute in a Map, as the * transform returned will also reflect the effects of WIDTH and * SUPERSCRIPT attributes. Clients who want the actual transform * need to call getRequestedAttributes. */ if (nonIdentityTx) { AttributeValues values = getAttributeValues(); AffineTransform at = values.isNonDefault(ETRANSFORM) ? new AffineTransform(values.getTransform()) : new AffineTransform(); if (values.getSuperscript() != 0) { // can't get ascent and descent here, recursive call to this fn, // so use pointsize // let users combine super- and sub-scripting int superscript = values.getSuperscript(); double trans = 0; int n = 0; boolean up = superscript > 0; int sign = up ? -1 : 1; int ss = up ? superscript : -superscript; while ((ss & 7) > n) { int newn = ss & 7; trans += sign * (ssinfo[newn] - ssinfo[n]); ss > >= 3; sign = -sign; n = newn; } trans *= pointSize; double scale = Math.pow(2./3., n); at.preConcatenate(AffineTransform.getTranslateInstance(0, trans)); at.scale(scale, scale); // note on placement and italics // We preconcatenate the transform because we don't want to translate along // the italic angle, but purely perpendicular to the baseline. While this // looks ok for superscripts, it can lead subscripts to stack on each other // and bring the following text too close. The way we deal with potential // collisions that can occur in the case of italics is by adjusting the // horizontal spacing of the adjacent glyphvectors. Examine the italic // angle of both vectors, if one is non-zero, compute the minimum ascent // and descent, and then the x position at each for each vector along its // italic angle starting from its (offset) baseline. Compute the difference // between the x positions and use the maximum difference to adjust the // position of the right gv. } if (values.isNonDefault(EWIDTH)) { at.scale(values.getWidth(), 1f); } return at; } return new AffineTransform(); } Returns a copy of the transform associated with this Font. This transform is not necessarily the one used to construct the font. If the font has algorithmic superscripting or width adjustment, this will be incorporated into the returned AffineTransform. Typically, fonts will not be transformed. Clients generally should call #isTransformed first, and only call this method if isTransformed returns true.
public boolean hasLayoutAttributes() { return hasLayoutAttributes; } Return true if this Font contains attributes that require extra layout processing.
public boolean hasUniformLineMetrics() { return false; // REMIND always safe, but prevents caller optimize } Checks whether or not this Font has uniform line metrics. A logical Font might be a composite font, which means that it is composed of different physical fonts to cover different code ranges. Each of these fonts might have different LineMetrics. If the logical Font is a single font then the metrics would be uniform.
public int hashCode() { if (hash == 0) { hash = name.hashCode() ^ style ^ size; /* It is possible many fonts differ only in transform. * So include the transform in the hash calculation. * nonIdentityTx is set whenever there is a transform in * 'values'. The tests for null are required because it can * also be set for other reasons. */ if (nonIdentityTx && values != null && values.getTransform() != null) { hash ^= values.getTransform().hashCode(); } } return hash; } Returns a hashcode for this Font.
public boolean isBold() { return (style & BOLD) != 0; } Indicates whether or not this Font object's style is BOLD.
public boolean isItalic() { return (style & ITALIC) != 0; } Indicates whether or not this Font object's style is ITALIC.
public boolean isPlain() { return style == 0; } Indicates whether or not this Font object's style is PLAIN.
public boolean isTransformed() { return nonIdentityTx; } Indicates whether or not this Font object has a transform that affects its size in addition to the Size attribute.
public GlyphVector layoutGlyphVector(FontRenderContext frc, char[] text, int start, int limit, int flags) { GlyphLayout gl = GlyphLayout.get(null); // !!! no custom layout engines StandardGlyphVector gv = gl.layout(this, frc, text, start, limit-start, flags, null); GlyphLayout.done(gl); return gv; } Returns a new GlyphVector object, performing full layout of the text if possible. Full layout is required for complex text, such as Arabic or Hindi. Support for different scripts depends on the font and implementation. Layout requires bidi analysis, as performed by Bidi, and should only be performed on text that has a uniform direction. The direction is indicated in the flags parameter,by using LAYOUT_RIGHT_TO_LEFT to indicate a right-to-left (Arabic and Hebrew) run direction, or LAYOUT_LEFT_TO_RIGHT to indicate a left-to-right (English) run direction. In addition, some operations, such as Arabic shaping, require context, so that the characters at the start and limit can have the proper shapes. Sometimes the data in the buffer outside the provided range does not have valid data. The values LAYOUT_NO_START_CONTEXT and LAYOUT_NO_LIMIT_CONTEXT can be added to the flags parameter to indicate that the text before start, or after limit, respectively, should not be examined for context. All other values for the flags parameter are reserved.
public String toString() { String strStyle; if (isBold()) { strStyle = isItalic() ? "bolditalic" : "bold"; } else { strStyle = isItalic() ? "italic" : "plain"; } return getClass().getName() + "[family=" + getFamily() + ",name=" + name + ",style=" + strStyle + ",size=" + size + "]"; } Converts this Font object to a String representation.