程序包 ohos.agp.text

类 Font.Builder

java.lang.Object

ohos.agp.text.Font.Builder

封闭类:

Font

public static class Font.Builder
extends Object

Provides a builder to create a Font instance.

You can use it to create a Font instance by specifying the text style.

字段概要

字段

限定符和类型	字段	说明
static int	MAX_FALLBACK_NUM	Specifies the maximum number of FontFamily objects allowed in the custom fallback list.

构造器概要

构造器

构造器	说明
Builder(File file)	Creates a Builder instance with specified font file.
Builder(FileDescriptor fileDescriptor)	Creates a Font object based on the file descriptor.
Builder(String name)	Creates a Builder instance with specified font family.
Builder(Font font)	Creates a Font object based on the existing Font object.
Builder(FontFamily fontFamily)	Creates a font based on the specified fontFamily.
Builder(ResourceManager resourceManager, String path)	Creates a Font object based on the specified font file (from the Resource Manager).

方法概要

限定符和类型	方法	说明
Font.Builder	addCustomFallback(FontFamily fontFamily)	Adds the specified fontFamily to the custom fallback list.
Font	build()	Creates a font object based on the specified style.
Font.Builder	makeItalic(boolean italic)	Italicizes the font to be built.
Font.Builder	setFontCollectionIndex(int fontCollectionIndex)	Sets the index of the font collection.
Font.Builder	setFontVariations(String variations)	Specifies the settings of the font variation axis.
Font.Builder	setSystemFallback(String fontFamilyName)	Searches for the system fallback list matching the specified fontFamilyName and uses it as the fallback list of the font to be created.
Font.Builder	setWeight(int weight)	Sets the font weight of the font to be built.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

MAX_FALLBACK_NUM

public static final int MAX_FALLBACK_NUM

Specifies the maximum number of FontFamily objects allowed in the custom fallback list.

另请参阅:

常量字段值

构造器详细资料

Builder

public Builder(String name)

Creates a Builder instance with specified font family.

参数:

name - Indicates the font family specified for the Builder instance.

Builder

public Builder(File file)

Creates a Builder instance with specified font file.

参数:

file - Indicates the font file specified for the Builder instance.

Builder

public Builder(FileDescriptor fileDescriptor)

Creates a Font object based on the file descriptor.

参数:

fileDescriptor - Indicates the font file descriptor.

从以下版本开始:

7

Builder

public Builder(ResourceManager resourceManager,
               String path)

Creates a Font object based on the specified font file (from the Resource Manager).

参数:

resourceManager - Indicates the Resource Manager. You can use getResourceManager() to obtain the Resource Manager.

path - Indicates the path of the font file. The font file is stored in the rawfile directory, for example, resources/rawfile/your_font_file.ttf.

抛出:

NullPointerException - Throws this exception if the specified resourceManager or path is null.

从以下版本开始:

7

Builder

public Builder(Font font)

Creates a Font object based on the existing Font object.

Then, you can obtain Font objects of different styles by specifying the font weight and italic style.

参数:

font - Indicates the existing Font object. The default font will be used if this parameter is null.

从以下版本开始:

7

Builder

public Builder(FontFamily fontFamily)

Creates a font based on the specified fontFamily.

参数:

fontFamily - Indicates the FontFamily object.

抛出:

NullPointerException - Throws this exception if the specified fontFamily is null.

从以下版本开始:

7

方法详细资料

makeItalic

public Font.Builder makeItalic(boolean italic)

Italicizes the font to be built.

参数:

italic - Specifies whether to italicize the font, true means to italicize the font, and false means the opposite.

返回:

Returns the builder.

setWeight

public Font.Builder setWeight(int weight)

Sets the font weight of the font to be built.

参数:

weight - Indicates the font weight to set. The value ranges from 1 to 1000. Commonly used weights includes Font.REGULAR, Font.MEDIUM and Font.BOLD.

返回:

Returns the builder.

build

public Font build()

Creates a font object based on the specified style.

返回:

Returns the font object with the specified style.

setSystemFallback

public Font.Builder setSystemFallback(String fontFamilyName)

Searches for the system fallback list matching the specified fontFamilyName and uses it as the fallback list of the font to be created.

A custom fallback (if available) takes precedence over the system fallback list.

参数:

fontFamilyName - Indicates the font family name specified. It is used to search for the system fallback list.

返回:

Returns the builder.

抛出:

NullPointerException - Throws this exception if the specified fontFamilyName is null.

IllegalArgumentException - Throws this exception if the family name and font objects are specified as Builder parameters.

从以下版本开始:

7

addCustomFallback

public Font.Builder addCustomFallback(FontFamily fontFamily)

Adds the specified fontFamily to the custom fallback list.

A maximum of 64 FontFamilys (Include the one passed in the constructor).

参数:

fontFamily - Indicates the FontFamily to be added to the custom fallback list.

返回:

Returns the builder.

抛出:

NullPointerException - Throws this exception if the specified fontFamily is null.

IllegalArgumentException - Throws this exception if the number of FontFamily objects is 0 or exceeds the upper limit.

从以下版本开始:

7

setFontCollectionIndex

public Font.Builder setFontCollectionIndex(int fontCollectionIndex)

Sets the index of the font collection. Note: When calling this method, you must know the valid index range of the corresponding font collection file. The value 0 is always valid.

参数:

fontCollectionIndex - Indicates the index of the font collection. Ensure that the index is valid. The value 0 is always valid.

返回:

Returns the builder.

抛出:

IllegalArgumentException - Throws this exception if no font file is specified as the Builder parameter.

从以下版本开始:

7

setFontVariations

public Font.Builder setFontVariations(String variations)

Specifies the settings of the font variation axis. Note: When calling this method, you must know the valid variation axes of the corresponding font file and the valid ranges of the values.

参数:

variations - Indicates the font variation axis to set. For example, the string "'wght' 400,'ital' 1" means that the font is in italics and the font weight is 400.

返回:

Returns the builder.

抛出:

NullPointerException - Throws this exception if the specified variations is null.

IllegalArgumentException - Throws this exception if no font file is specified as the Builder parameter.

从以下版本开始:

7