com.aspose.imaging

Class Font

java.lang.Object

com.aspose.imaging.Font

public final class Font
extends Object

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

Code example:

This example demonstrates the use of Font and SolidBrush class to draw strings on Image surface. The example creates a new Image and draw shapes using Figures and GraphicsPath

//Creates an instance of BmpOptions and set its various properties
com.aspose.imaging.imageoptions.BmpOptions bmpOptions = new com.aspose.imaging.imageoptions.BmpOptions();
bmpOptions.setBitsPerPixel(24);

//Create an instance of FileCreateSource and assign it as Source for the instance of BmpOptions
//Second Boolean parameter determines if the file to be created IsTemporal or not
bmpOptions.setSource(new com.aspose.imaging.sources.FileCreateSource("C:\\temp\\sample.bmp", false));

//Creates an instance of Image
com.aspose.imaging.Image image = com.aspose.imaging.Image.create(bmpOptions, 500, 500);
try {
    //Creates and initialize an instance of Graphics class
    com.aspose.imaging.Graphics graphics = new com.aspose.imaging.Graphics(image);

    //Clears Graphics surface
    graphics.clear(com.aspose.imaging.Color.getWheat());

    //Creates an instance of Font
    com.aspose.imaging.Font font = new com.aspose.imaging.Font("Times New Roman", 16);

    //Create an instance of SolidBrush having Red Color
    com.aspose.imaging.brushes.SolidBrush brush = new com.aspose.imaging.brushes.SolidBrush(com.aspose.imaging.Color.getRed());

    //Draw a String
    graphics.drawString("Created by Aspose.Imaging for Java", font, brush, new com.aspose.imaging.PointF(100, 100));

    // save all changes
    image.save();
} finally {
    image.dispose();
}

Constructor Summary

Constructors

Constructor and Description
Font(Font prototype, int newStyle) Initializes a new com.aspose.imaging.Font that uses the specified existing com.aspose.imaging.Font and com.aspose.imaging.FontStyle enumeration.
Font(String fontName, float emSize) Initializes a new com.aspose.imaging.Font using a specified size.
Font(String fontName, float emSize, int style) Initializes a new com.aspose.imaging.Font using a specified size and style.
Font(String fontName, float emSize, int style, int unit) Initializes a new com.aspose.imaging.Font using a specified size, style, and unit.
Font(String fontName, float emSize, int style, int unit, int characterSet) Initializes a new com.aspose.imaging.Font using a specified size, style, unit, and character set.

Method Summary

Modifier and Type	Method and Description
Font	deepClone() Creates an exact deep copy of this Font.
boolean	equals(Object obj) Indicates whether the specified object is a com.aspose.imaging.Font and has the same property values as this com.aspose.imaging.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.
boolean	getItalic() Gets a value indicating whether this Font is italic.
String	getName() Gets the face name of this Font.
float	getSize() Gets the em-size of this Font measured in the units specified by the P:Aspose.Imaging.Font.Unit property.
boolean	getStrikeout() Gets a value indicating whether this Font specifies a horizontal line through the font.
int	getStyle() Gets style information for this Font.
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 com.aspose.imaging.Font.
static Font	makeFontWithGraphUnit(String fontName, float emSize, int unit) Initializes a new com.aspose.imaging.Font using a specified size and unit.
String	toString() Returns a human-readable string representation of this com.aspose.imaging.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 com.aspose.imaging.Font that uses the specified existing com.aspose.imaging.Font and com.aspose.imaging.FontStyle enumeration.

Parameters:

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

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

Throws:

com.aspose.ms.System.ArgumentNullException - prototype is null.

Font

public Font(String fontName,
            float emSize)

Initializes a new com.aspose.imaging.Font using a specified size. The character set is set to F:Aspose.Imaging.CharacterSet.Default, the graphics unit to F:Aspose.Imaging.GraphicsUnit.Point, the font style to F:Aspose.Imaging.FontStyle.Regular.

Parameters:

fontName - A string representation of the com.aspose.imaging.Font name.

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

Throws:

com.aspose.ms.System.ArgumentOutOfRangeException - emSize is less than or equal to 0, evaluates to infinity or is not a valid number.

com.aspose.ms.System.ArgumentNullException - fontName is null.

Font

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

Initializes a new com.aspose.imaging.Font using a specified size and style. The character set is set to F:Aspose.Imaging.CharacterSet.Default, the graphics unit to F:Aspose.Imaging.GraphicsUnit.Point.

Parameters:

fontName - A string representation of the com.aspose.imaging.Font name.

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

style - The com.aspose.imaging.FontStyle of the new font.

Throws:

com.aspose.ms.System.ArgumentOutOfRangeException - emSize is less than or equal to 0, evaluates to infinity or is not a valid number.

com.aspose.ms.System.ArgumentNullException - fontName is null.

Font

public Font(String fontName,
            float emSize,
            int style,
            int unit,
            int characterSet)

Initializes a new com.aspose.imaging.Font using a specified size, style, unit, and character set.

Parameters:

fontName - A string representation of the com.aspose.imaging.Font name.

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

style - The com.aspose.imaging.FontStyle of the new font.

unit - The com.aspose.imaging.GraphicsUnit of the new font.

characterSet - A character set to use for this font.

Throws:

com.aspose.ms.System.ArgumentOutOfRangeException - emSize is less than or equal to 0, evaluates to infinity or is not a valid number.

com.aspose.ms.System.ArgumentNullException - fontName is null.

Font

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

Initializes a new com.aspose.imaging.Font using a specified size, style, and unit.

Parameters:

fontName - A string representation of the com.aspose.imaging.Font name.

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

style - The com.aspose.imaging.FontStyle of the new font.

unit - The com.aspose.imaging.GraphicsUnit of the new font.

Throws:

com.aspose.ms.System.ArgumentOutOfRangeException - emSize is less than or equal to 0, evaluates to infinity or is not a valid number.

com.aspose.ms.System.ArgumentNullException - fontName is null.

Method Detail

makeFontWithGraphUnit

public static Font makeFontWithGraphUnit(String fontName,
                                         float emSize,
                                         int unit)

Initializes a new com.aspose.imaging.Font using a specified size and unit. The character set is set to F:Aspose.Imaging.CharacterSet.Default, the style is set to F:Aspose.Imaging.FontStyle.Regular.

Parameters:

fontName - A string representation of the com.aspose.imaging.Font name.

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

unit - The com.aspose.imaging.GraphicsUnit of the new font.

Throws:

com.aspose.ms.System.ArgumentOutOfRangeException - emSize is less than or equal to 0, evaluates to infinity or is not a valid number.

com.aspose.ms.System.ArgumentNullException - fontName is null.

getBold

public boolean getBold()

Gets a value indicating whether this Font is bold.

Returns:

True if this Font is bold; otherwise, false.

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.

getItalic

public boolean getItalic()

Gets a value indicating whether this Font is italic.

Returns:

True if this Font is italic; otherwise, false.

getName

public String getName()

Gets the face name of this Font.

Returns:

A string representation of 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:

True if this Font has a horizontal line through it; otherwise, false.

getUnderline

public boolean getUnderline()

Gets a value indicating whether this Font is underlined.

Returns:

True if this Font is underlined; otherwise, false.

getStyle

public int getStyle()

Gets style information for this Font.

Returns:

A FontStyle enumeration that contains style information for this Font.

getSize

public float getSize()

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

Returns:

The em-size of this Font.

getUnit

public int getUnit()

Gets the unit of measure for this Font.

Returns:

A GraphicsUnit that represents the unit of measure for this Font.

deepClone

public Font deepClone()

Creates an exact deep copy of this Font.

Returns:

The Font this method creates.

equals

public boolean equals(Object obj)

Indicates whether the specified object is a com.aspose.imaging.Font and has the same property values as this com.aspose.imaging.Font.

Overrides:

equals in class Object

Parameters:

obj - The object to test.

Returns:

True if the obj parameter is a com.aspose.imaging.Font and has the same property values as this com.aspose.imaging.Font; otherwise, false.

hashCode

public int hashCode()

Gets the hash code for this com.aspose.imaging.Font.

Overrides:

hashCode in class Object

Returns:

The hash code for this com.aspose.imaging.Font.

toString

public String toString()

Returns a human-readable string representation of this com.aspose.imaging.Font.

Overrides:

toString in class Object

Returns:

A string that represents this com.aspose.imaging.Font.