java.awt
Class Font

java.lang.Object
  java.awt.Font

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

QtFont

public class Font
extends Object
implements Serializable

A class that produces font objects.

Since:

JDK1.0

See Also:

Serialized Form

Field Summary

static int	BOLD The bold style constant.
static int	ITALIC The italicized style constant.
protected String	name The logical name of this font.
static int	PLAIN The plain style constant.
protected int	size The point size of this font.
protected int	style The style of the font.

Constructor Summary

Font(String name, int style, int size)
Creates a new font with the specified name, style and point size.

Method Summary

static Font	decode(String str) Gets the specified font using the name passed in.
boolean	equals(Object obj) Compares this object to the specifed object.
String	getFamily() Gets the platform specific family name of the font.
static Font	getFont(String nm) Gets a font from the system properties list.
static Font	getFont(String nm, Font font) Gets the specified font from the system properties list.
String	getName() Gets the logical name of the font.
int	getSize() Gets the point size of the font.
int	getStyle() Gets the style of the font.
int	hashCode() Returns a hashcode for this font.
boolean	isBold() Indicates whether the font's style is bold.
boolean	isItalic() Indicates whether the font's style is italic.
boolean	isPlain() Indicates whether the font's style is plain.
String	toString() Converts this object to a String representation.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PLAIN

public static final int PLAIN

The plain style constant. This style can be combined with the other style constants for mixed styles.

Since:

JDK1.0

See Also:

Constant Field Values

BOLD

public static final int BOLD

The bold style constant. This style can be combined with the other style constants for mixed styles.

Since:

JDK1.0

See Also:

Constant Field Values

ITALIC

public static final int ITALIC

The italicized style constant. This style can be combined with the other style constants for mixed styles.

Since:

JDK1.0

See Also:

Constant Field Values

name

protected String name

The logical name of this font.

Since:

JDK1.0

style

protected int style

The style of the font. This is the sum of the constants PLAIN, BOLD, or ITALIC.

size

protected int size

The point size of this font.

Since:

JDK1.0

Constructor Detail

Font

public Font(String name,
            int style,
            int size)

Creates a new font with the specified name, style and point size.

Parameters:

name - the font name

style - the constant style used

size - the point size of the font

Since:

JDK1.0

See Also:

Toolkit.getFontList()

Method Detail

getFamily

public String getFamily()

Gets the platform specific family name of the font. Use the getName method to get the logical name of the font.

Returns:

a string, the platform specific family name.

Since:

JDK1.0

See Also:

getName()

getName

public String getName()

Gets the logical name of the font.

Returns:

a string, the logical name of the font.

Since:

JDK1.0

See Also:

getFamily()

getStyle

public int getStyle()

Gets the style of the font.

Returns:

the style of this font.

Since:

JDK1.0

See Also:

isPlain(), isBold(), isItalic()

getSize

public int getSize()

Gets the point size of the font.

Returns:

the point size of this font.

Since:

JDK1.0

isPlain

public boolean isPlain()

Indicates whether the font's style is plain.

Returns:

true if the font is neither bold nor italic; false otherwise.

Since:

JDK1.0

See Also:

getStyle()

isBold

public boolean isBold()

Indicates whether the font's style is bold.

Returns:

true if the font is bold; false otherwise.

Since:

JDK1.0

See Also:

getStyle()

isItalic

public boolean isItalic()

Indicates whether the font's style is italic.

Returns:

true if the font is italic; false otherwise.

Since:

JDK1.0

See Also:

getStyle()

getFont

public static Font getFont(String nm)

Gets a font from the system properties list.

Parameters:

nm - the property name

Since:

JDK1.0

See Also:

getFont(java.lang.String, java.awt.Font)

decode

public static Font decode(String str)

Gets the specified font using the name passed in.

Parameters:

str - the name

Since:

JDK1.1

getFont

public static Font getFont(String nm,
                           Font font)

Gets the specified font from the system properties list. The first argument is treated as the name of a system property to be obtained as if by the method System.getProperty. The string value of this property is then interpreted as a font.

The property value should be one of the following forms:

• fontname-style-pointsize
• fontname-pointsize
• fontname-style
• fontname

where style is one of the three strings "BOLD", "BOLDITALIC", or "ITALIC", and point size is a decimal representation of the point size.

The default style is PLAIN. The default point size is 12.

If the specified property is not found, the font argument is returned instead.

Parameters:

nm - the property name

font - a default font to return if property nm is not defined

Returns:

the Font value of the property.

Since:

JDK1.0

hashCode

public int hashCode()

Returns a hashcode for this font.

Overrides:

hashCode in class Object

Returns:

a hashcode value for this font.

Since:

JDK1.0

See Also:

Object.equals(java.lang.Object), Hashtable

equals

public boolean equals(Object obj)

Compares this object to the specifed object. The result is true if and only if the argument is not null and is a Font object with the same name, style, and point size as this font.

Overrides:

equals in class Object

Parameters:

obj - the object to compare this font with.

Returns:

true if the objects are equal; false otherwise.

Since:

JDK1.0

See Also:

Object.hashCode(), Hashtable

toString

public String toString()

Converts this object to a String representation.

Overrides:

toString in class Object

Returns:

a string representation of this object

Since:

JDK1.0