com.aspose.drawing

Class FontFamily

java.lang.Object

com.aspose.drawing.FontFamily

All Implemented Interfaces:

com.aspose.ms.System.IDisposable

public final class FontFamily
extends Object
implements com.aspose.ms.System.IDisposable

Defines a group of type faces having a similar basic design and certain variations in styles. This class cannot be inherited.

Constructor Summary

Constructors

Constructor and Description
FontFamily(String name) Initializes a new instance of the FontFamily class with the specified name.
FontFamily(String name, FontCollection fontCollection) Initializes a new instance of the FontFamily class.
FontFamily(String name, FontFamilyDefinition definition) Initializes a new instance of the FontFamily class.

Method Summary

Modifier and Type	Method and Description
void	dispose() Releases all resources used by this FontFamily.
boolean	equals(Object obj) Indicates whether the specified object is a FontFamily and is identical to this FontFamily.
int	getCellAscent(int style) Returns the cell ascent, in design units, of the FontFamily of the specified style.
int	getCellDescent(int style) Returns the cell descent, in design units, of the FontFamily of the specified style.
int	getEmHeight(int style) Gets the height, in font design units, of the EM square for the specified style.
static FontFamily[]	getFamilies() Gets an array that contains all the FontFamily objects associated with the current graphics context.
static FontFamily	getGenericMonospace() Gets a generic monospace FontFamily.
static FontFamily	getGenericSansSerif() Gets a generic sans serif FontFamily object.
static FontFamily	getGenericSerif() Gets a generic serif FontFamily.
int	getLineSpacing(int style) Returns the line spacing, in design units, of the FontFamily of the specified style.
String	getName() Gets the name of this FontFamily.
String	getName(int language) Returns the name, in the specified language, of this FontFamily.
int	hashCode() Gets a hash code for this FontFamily.
boolean	isStyleAvailable(int style) Indicates whether the specified FontStyle enumeration is available.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FontFamily

public FontFamily(String name)

Initializes a new instance of the FontFamily class with the specified name.

Parameters:

name - The name of the new FontFamily.

FontFamily

public FontFamily(String name,
                  FontCollection fontCollection)

Initializes a new instance of the FontFamily class.

Parameters:

name - The name of the font family.

fontCollection - The font collection.

FontFamily

public FontFamily(String name,
                  FontFamilyDefinition definition)

Initializes a new instance of the FontFamily class.

Parameters:

name - The name of the font family.

definition - The definition.

Method Detail

getFamilies

public static FontFamily[] getFamilies()

Gets an array that contains all the FontFamily objects associated with the current graphics context.

Returns:

An array of FontFamily objects associated with the current graphics context.

getGenericSansSerif

public static FontFamily getGenericSansSerif()

Gets a generic sans serif FontFamily object.

Returns:

A FontFamily object that represents a generic sans serif font.

getGenericSerif

public static FontFamily getGenericSerif()

Gets a generic serif FontFamily.

Returns:

A FontFamily that represents a generic serif font.

getGenericMonospace

public static FontFamily getGenericMonospace()

Gets a generic monospace FontFamily.

Returns:

A FontFamily that represents a generic monospace font.

getName

public String getName()

Gets the name of this FontFamily.

Returns:

A String that represents the name of this FontFamily.

dispose

public void dispose()

Releases all resources used by this FontFamily.

Specified by:

dispose in interface com.aspose.ms.System.IDisposable

getName

public String getName(int language)

Returns the name, in the specified language, of this FontFamily.

Parameters:

language - The language in which the name is returned.

Returns:

A String that represents the name, in the specified language, of this FontFamily.

isStyleAvailable

public boolean isStyleAvailable(int style)

Indicates whether the specified FontStyle enumeration is available.

Parameters:

style - The FontStyle to test.

Returns:

true if the specified FontStyle is available; otherwise, false.

getEmHeight

public int getEmHeight(int style)

Gets the height, in font design units, of the EM square for the specified style.

Parameters:

style - The FontStyle for which to get the EM height.

Returns:

The height of the EM square.

getCellAscent

public int getCellAscent(int style)

Returns the cell ascent, in design units, of the FontFamily of the specified style.

Parameters:

style - A FontStyle that contains style information for the font.

Returns:

The cell ascent for this FontFamily that uses the specified FontStyle.

getCellDescent

public int getCellDescent(int style)

Returns the cell descent, in design units, of the FontFamily of the specified style.

Parameters:

style - A FontStyle that contains style information for the font.

Returns:

The cell descent metric for this FontFamily that uses the specified FontStyle.

hashCode

public int hashCode()

Gets a hash code for this FontFamily.

Overrides:

hashCode in class Object

Returns:

The hash code for this FontFamily.

equals

public boolean equals(Object obj)

Indicates whether the specified object is a FontFamily and is identical to this FontFamily.

Overrides:

equals in class Object

Parameters:

obj - The object to test.

Returns:

true if obj is a FontFamily and is identical to this FontFamily; otherwise, false.

getLineSpacing

public int getLineSpacing(int style)

Returns the line spacing, in design units, of the FontFamily of the specified style. The line spacing is the vertical distance between the base lines of two consecutive lines of text.

Parameters:

style - The FontStyle to apply.

Returns:

The distance between two consecutive lines of text.