com.aspose.drawing

Class Font

java.lang.Object

com.aspose.drawing.Font

All Implemented Interfaces:

com.aspose.ms.System.IDisposable

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

Defines a particular format for text, including font face, size, and style attributes. This class cannot be inherited.

Constructor Summary

Constructors

Constructor and Description
Font(FontFamily family, float emSize) Initializes a new instance of the Font class.
Font(FontFamily family, float emSize, int style) Initializes a new instance of the Font class using a specified size and style..
Font(FontFamily family, float emSize, int style, int unit) Initializes a new instance of the Font class using a specified size, style, and unit.
Font(FontFamily family, float emSize, int style, int unit, byte gdiCharSet) Initializes a new instance of the Font class using a specified size, style, unit, and character set..
Font(FontFamily family, float emSize, int style, int unit, byte gdiCharSet, boolean gdiVerticalFont) Initializes a new instance of the Font class using a specified size, style, unit, and character set..
Font(Font prototype, int newStyle) Initializes a new instance of the Font class uses the specified existing Font and FontStyle enumeration..
Font(String familyName, float emSize) Initializes a new instance of the Font class using a specified size.
Font(String familyName, float emSize, int style) Initializes a new instance of the Font class using a specified size and style.
Font(String familyName, float emSize, int style, int unit) Initializes a new instance of the Font class using a specified size, style, and unit.
Font(String familyName, float emSize, int style, int unit, byte gdiCharSet) Initializes a new instance of the Font class using a specified size, style, unit, and character set.
Font(String familyName, float emSize, int style, int unit, byte gdiCharSet, boolean gdiVerticalFont) Initializes a new instance of the Font class using the specified size, style, unit, and character set.

Method Summary

Modifier and Type	Method and Description
Font	deepClone() Creates an exact copy of this Font.
void	dispose() Releases all resources used by this Font.
boolean	equals(Object obj) Indicates whether the specified object is a Font and has the same FontFamily(Font.getFontFamily()), M:GdiVerticalFont, M:GdiCharSet, M:Style, M:Size, and M:Unit property values as this Font.
boolean	getBold() Gets a value indicating whether this Font is bold.
int	getCharacterSet() Gets a byte value that specifies the character set that this Font uses.
FontFamily	getFontFamily() Gets the FontFamily(Font.getFontFamily()) associated with this Font.
byte	getGdiCharSet() Gets a byte value that specifies the GDI character set that this Font uses.
boolean	getGdiVerticalFont() Gets a value indicating whether this Font is derived from a GDI vertical font..
int	getHeight_Rename_Namesake() Gets the line spacing of this font.
int	getHeight() Returns the line spacing, in pixels, of this font.
int	getHeight(float dpi) Returns the height, in pixels, of this Font when drawn to a device with the specified vertical resolution.
float	getHeight(Graphics graphics) Returns the line spacing, in the current unit of a specified Graphics, of this font.
boolean	getItalic() Gets a value indicating whether this Font is italic.
String	getName() Gets the face name of this Font.
String	getOriginalFontName() Gets the name of the font originally specified.
float	getSize() Gets the em-size of this Font measured in the units specified by the Font.Unit property.
float	getSizeInPoints() Gets the em-size, in points, of this Font.
boolean	getStrikeout() Gets a value indicating whether this Font specifies a horizontal line through the font.
int	getStyle() Gets style information for this Font.
String	getSystemFontName() Gets the name of the system font if the IsSystemFont property returns true.
boolean	getUnderline() Gets a value indicating whether this Font is underlined.
int	getUnit() Gets the unit of measure for this Font.
int	hashCode() Gets the hash code for this Font.
boolean	isSystemFont() Gets a value indicating whether the font is a member of SystemFonts.
String	toString() Returns a human-readable string representation of this Font.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Font

public Font(Font prototype,
            int newStyle)

Initializes a new instance of the Font class uses the specified existing Font and FontStyle enumeration..

Parameters:

prototype - The existing Font from which to create the new Font.

newStyle - The FontStyle to apply to the new Font. Multiple values of the FontStyle enumeration can be combined with the OR operator.

Font

public Font(FontFamily family,
            float emSize)

Initializes a new instance of the Font class.

Parameters:

family - The FontFamily(Font.getFontFamily()) of the new Font.

emSize - The em-size, in points, of the new font.

Font

public Font(FontFamily family,
            float emSize,
            int style)

Initializes a new instance of the Font class using a specified size and style..

Parameters:

family - The FontFamily(Font.getFontFamily()) of the new Font.

emSize - The em-size, in points, of the new font.

style - The FontStyle of the new font.

Font

public Font(FontFamily family,
            float emSize,
            int style,
            int unit)

Initializes a new instance of the Font class using a specified size, style, and unit.

Parameters:

family - The FontFamily(Font.getFontFamily()) of the new Font.

emSize - The em-size of the new font in the units specified by the unit parameter.

style - The FontStyle of the new font.

unit - The GraphicsUnit of the new font.

Font

public Font(FontFamily family,
            float emSize,
            int style,
            int unit,
            byte gdiCharSet)

Initializes a new instance of the Font class using a specified size, style, unit, and character set..

Parameters:

family - The FontFamily(Font.getFontFamily()) of the new Font.

emSize - The em-size of the new font in the units specified by the unit parameter.

style - The FontStyle of the new font.

unit - The GraphicsUnit of the new font.

gdiCharSet - GDI character set to use for the new font.

Font

public Font(FontFamily family,
            float emSize,
            int style,
            int unit,
            byte gdiCharSet,
            boolean gdiVerticalFont)

Initializes a new instance of the Font class using a specified size, style, unit, and character set..

Parameters:

family - The FontFamily(Font.getFontFamily()) of the new Font.

emSize - The em-size of the new font in the units specified by the unit parameter.

style - The FontStyle of the new font.

unit - The GraphicsUnit of the new font.

gdiCharSet - GDI character set to use for the new font.

gdiVerticalFont - A Boolean value indicating whether the new font is derived from a GDI vertical font.

Font

public Font(String familyName,
            float emSize)

Initializes a new instance of the Font class using a specified size.

Parameters:

familyName - A string representation of the FontFamily for the new Font.

emSize - The em-size, in points, of the new font.

Font

public Font(String familyName,
            float emSize,
            int style)

Initializes a new instance of the Font class using a specified size and style.

Parameters:

familyName - A string representation of the FontFamily for the new Font.

emSize - The em-size, in points, of the new font.

style - The FontStyle of the new font.

Font

public Font(String familyName,
            float emSize,
            int style,
            int unit)

Initializes a new instance of the Font class using a specified size, style, and unit.

Parameters:

familyName - A string representation of the FontFamily(Font.getFontFamily()) for the new Font.

emSize - The em-size of the new font in the units specified by the unit parameter.

style - The FontStyle of the new font.

unit - The GraphicsUnit of the new font.

Font

public Font(String familyName,
            float emSize,
            int style,
            int unit,
            byte gdiCharSet)

Initializes a new instance of the Font class using a specified size, style, unit, and character set.

Parameters:

familyName - A string representation of the FontFamily for the new Font.

emSize - The em-size of the new font in the units specified by the unit parameter.

style - The FontStyle of the new font.

unit - The GraphicsUnit of the new font.

gdiCharSet - A byte that specifies a GDI character set to use for this font.

Font

public Font(String familyName,
            float emSize,
            int style,
            int unit,
            byte gdiCharSet,
            boolean gdiVerticalFont)

Initializes a new instance of the Font class using the specified size, style, unit, and character set.

Parameters:

familyName - A string representation of the FontFamily for the new Font.

emSize - The em-size of the new font in the units specified by the unit parameter.

style - The FontStyle of the new font.

unit - The GraphicsUnit of the new font.

gdiCharSet - A byte that specifies a GDI character set to use for this font.

gdiVerticalFont - A Boolean value indicating whether the new Font is derived from a GDI vertical font.

Method Detail

getFontFamily

public FontFamily getFontFamily()

Gets the FontFamily(Font.getFontFamily()) associated with this Font.

Returns:

The FontFamily(Font.getFontFamily()) associated with this Font.

getBold

public boolean getBold()

Gets a value indicating whether this Font is bold.

Returns:

a value indicating whether this Font is bold.

getGdiCharSet

public byte getGdiCharSet()

Gets a byte value that specifies the GDI character set that this Font uses.

Returns:

A byte value that specifies the GDI character set that this Font uses.

getGdiVerticalFont

public boolean getGdiVerticalFont()

Gets a value indicating whether this Font is derived from a GDI vertical font..

Value: true if this Font is derived from a GDI vertical font; otherwise, false.

Returns:

a value indicating whether this Font is derived from a GDI vertical font.

getItalic

public boolean getItalic()

Gets a value indicating whether this Font is italic.

Returns:

a value indicating whether this Font is italic.

getName

public String getName()

Gets the face name of this Font.

Returns:

the face name of this Font.

getStrikeout

public boolean getStrikeout()

Gets a value indicating whether this Font specifies a horizontal line through the font.

Returns:

a value indicating whether this Font specifies a horizontal line through the font.

getUnderline

public boolean getUnderline()

Gets a value indicating whether this Font is underlined.

Returns:

a value indicating whether this Font is underlined.

getStyle

public int getStyle()

Gets style information for this Font.

Returns:

style information for this Font.

getSize

public float getSize()

Gets the em-size of this Font measured in the units specified by the Font.Unit property.

Returns:

the em-size of this Font measured in the units specified by the {@code Font.

getSizeInPoints

public float getSizeInPoints()

Gets the em-size, in points, of this Font.

Returns:

The em-size, in points, of this Font.

getUnit

public int getUnit()

Gets the unit of measure for this Font.

Returns:

the unit of measure for this Font.

getHeight_Rename_Namesake

public int getHeight_Rename_Namesake()

Gets the line spacing of this font.

Value: The line spacing, in pixels, of this font.

Returns:

the line spacing of this font.

isSystemFont

public boolean isSystemFont()

Gets a value indicating whether the font is a member of SystemFonts.

Value: true if the font is a member of SystemFonts; otherwise, false.

Returns:

a value indicating whether the font is a member of SystemFonts.

getSystemFontName

public String getSystemFontName()

Gets the name of the system font if the IsSystemFont property returns true.

Value: The name of the system font, if IsSystemFont returns true; otherwise, an empty string ("").

Returns:

the name of the system font if the IsSystemFont property returns true.

getOriginalFontName

public String getOriginalFontName()

Gets the name of the font originally specified.

Value: The string representing the name of the font originally specified.

Returns:

the name of the font originally specified.

deepClone

public Font deepClone()

Creates an exact copy of this Font.

Returns:

The Font this method creates, cast as an Object.

equals

public boolean equals(Object obj)

Indicates whether the specified object is a Font and has the same FontFamily(Font.getFontFamily()), M:GdiVerticalFont, M:GdiCharSet, M:Style, M:Size, and M:Unit property values as this Font.

Overrides:

equals in class Object

Parameters:

obj - The object to test.

Returns:

true if the obj parameter is a Font and has the same FontFamily(Font.getFontFamily()), M:GdiVerticalFont, M:GdiCharSet, M:Style, M:Size, and M:Unit property values as this Font; otherwise, false.

hashCode

public int hashCode()

Gets the hash code for this Font.

Overrides:

hashCode in class Object

Returns:

The hash code for this Font.

getHeight

public int getHeight()

Returns the line spacing, in pixels, of this font.

Returns:

The line spacing, in pixels, of this font.

getHeight

public float getHeight(Graphics graphics)

Returns the line spacing, in the current unit of a specified Graphics, of this font.

Parameters:

graphics - A Graphics that holds the vertical resolution, in dots per inch, of the display device as well as settings for page unit and page scale.

Returns:

The line spacing, in pixels, of this font.

getHeight

public int getHeight(float dpi)

Returns the height, in pixels, of this Font when drawn to a device with the specified vertical resolution.

Parameters:

dpi - The vertical resolution, in dots per inch, used to calculate the height of the font.

Returns:

The height, in pixels, of this Font.

dispose

public void dispose()

Releases all resources used by this Font.

Specified by:

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

toString

public String toString()

Returns a human-readable string representation of this Font.

Overrides:

toString in class Object

Returns:

A string that represents this Font.

getCharacterSet

public int getCharacterSet()

Gets a byte value that specifies the character set that this Font uses.

Returns:

A character set that this Font uses.