程序包 ohos.agp.text

类 RawFont.Builder

java.lang.Object

ohos.agp.text.RawFont.Builder

封闭类:

RawFont

public static final class RawFont.Builder
extends Object

Provides a builder to create a RawFont instance.

从以下版本开始:

7

构造器概要

构造器

构造器	说明
Builder(File path)	A constructor used to create a Builder instance with the specified file.
Builder(FileDescriptor fileDescriptor)	A constructor used to create a Builder instance with the specified file descriptor.
Builder(FileDescriptor fileDescriptor, long offset, long size)	A constructor used to create a Builder instance with the specified file descriptor and file offset.
Builder(ByteBuffer buffer)	A constructor used to create a Builder instance with the specified byte buffer.
Builder(ResourceManager resourceManager, int resourceId)	A constructor used to create a Builder instance with the specified resource ID.
Builder(ResourceManager resourceManager, String path)	A constructor used to create a Builder instance with the specified resource file path.

方法概要

限定符和类型	方法	说明
RawFont	build()	A constructor used to create a RawFont instance based on your configurations.
RawFont.Builder	setFontCollectionIndex(int fontCollectionIndex)	Sets the index of the font collection.
RawFont.Builder	setFontVariations(String variations)	Sets a font variation axis.
RawFont.Builder	setItalic(boolean isItalic)	Sets the font to be italic.
RawFont.Builder	setWeight(int weight)	Sets the font weight.

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

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

构造器详细资料

Builder

public Builder(ByteBuffer buffer)

A constructor used to create a Builder instance with the specified byte buffer.

参数:

buffer - Indicates the byte buffer, which must be a direct buffer.

抛出:

IllegalArgumentException - Throws this exception if the specified buffer is not a direct buffer.

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

另请参阅:

ByteBuffer.allocateDirect(int)

Builder

public Builder(File path)

A constructor used to create a Builder instance with the specified file.

参数:

path - Indicates the file path.

抛出:

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

Builder

public Builder(FileDescriptor fileDescriptor)

A constructor used to create a Builder instance with the specified file descriptor.

参数:

fileDescriptor - Indicates the file descriptor.

抛出:

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

Builder

public Builder(FileDescriptor fileDescriptor,
               long offset,
               long size)

A constructor used to create a Builder instance with the specified file descriptor and file offset.

参数:

fileDescriptor - Indicates the file descriptor.

offset - Indicates the offset of the file.

size - Indicates the data size. If size is set to -1, the actual file size is used.

抛出:

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

Builder

public Builder(ResourceManager resourceManager,
               int resourceId)

A constructor used to create a Builder instance with the specified resource ID.

参数:

resourceManager - Indicates a resource manager, which is obtained using Context.getResourceManager().

resourceId - Indicates the resource ID. The font file is stored in media, for example, ResourceTable.Media_yourfontfile.

抛出:

NullPointerException - Throws this exception if no data is obtained using the specified resourceId.

Builder

public Builder(ResourceManager resourceManager,
               String path)

A constructor used to create a Builder instance with the specified resource file path.

参数:

resourceManager - Indicates a resource manager, which is obtained using Context.getResourceManager().

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

抛出:

NullPointerException - Throws this exception if no data is obtained using the specified path.

方法详细资料

setFontVariations

public RawFont.Builder setFontVariations(String variations)

Sets a font variation axis. When the variation axis is empty, nothing happens.

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 a Builder instance.

setItalic

public RawFont.Builder setItalic(boolean isItalic)

Sets the font to be italic.

参数:

isItalic - Specifies whether to set the font to be italic. The value true means to set the font to be italic, and false means the opposite.

返回:

Returns a Builder instance.

setFontCollectionIndex

public RawFont.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. You must ensure the validity of the index. The value 0 is always valid.

返回:

Returns a Builder instance.

setWeight

public RawFont.Builder setWeight(int weight)

Sets the font weight.

参数:

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

返回:

Returns a Builder instance.

抛出:

IllegalArgumentException - Throws this exception if the specified weight is not in the valid range.

build

public RawFont build()
              throws IOException

A constructor used to create a RawFont instance based on your configurations.

返回:

Returns a RawFont instance.

抛出:

IOException - Throws this exception if the configurations passed to the Builder constructor are invalid.