程序包 ohos.agp.text.richstyles

类 ImageRichStyle

java.lang.Object

ohos.agp.text.richstyles.RichStyle

ohos.agp.text.richstyles.ImageRichStyle

public class ImageRichStyle
extends RichStyle

Implements rich styles for images inserted into the text. This class must be used in a RichText instance.

An inserted image replaces the text in a given range.

从以下版本开始:

7

另请参阅:

RichText.setRichStyle(RichStyle, int, int, RangedRichStyle.Flag)

嵌套类概要

嵌套类

限定符和类型	类	说明
static class	ImageRichStyle.ImageAlignment	Enumerates vertical alignment modes of an image in the line where the image is located.

从类继承的嵌套类/接口 ohos.agp.text.richstyles.RichStyle

RichStyle.Capability, RichStyle.TypeId

构造器概要

构造器

构造器	说明
ImageRichStyle(Element element)	A constructor used to create an ImageRichStyle instance based on the specified element.
ImageRichStyle(Element element, ImageRichStyle.ImageAlignment alignment)	A constructor used to create an ImageRichStyle instance based on the specified element and alignment.

方法概要

限定符和类型	方法	说明
Element	getElement()	Obtains the image in this ImageRichStyle instance.
ImageRichStyle.ImageAlignment	getImageAlign()	Obtains the vertical alignment mode of the image in this ImageRichStyle instance.

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

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

从类继承的方法 ohos.agp.text.richstyles.RichStyle

getCapability, getRichStyleTypeId

构造器详细资料

ImageRichStyle

public ImageRichStyle(Element element)

A constructor used to create an ImageRichStyle instance based on the specified element.

The image uses ImageAlignment#BOTTOM as the vertical alignment mode.

参数:

element - Indicates an image.

抛出:

IllegalArgumentException - Throws this exception if the specified element is null.

从以下版本开始:

7

ImageRichStyle

public ImageRichStyle(Element element,
                      ImageRichStyle.ImageAlignment alignment)

A constructor used to create an ImageRichStyle instance based on the specified element and alignment.

参数:

element - Indicates an image.

alignment - Indicates the vertical alignment mode of the image in the line. If this parameter is left empty, ImageAlignment#BOTTOM is used.

抛出:

IllegalArgumentException - Throws this exception if the specified element is null.

从以下版本开始:

7

另请参阅:

ImageRichStyle.ImageAlignment

方法详细资料

getElement

public Element getElement()

Obtains the image in this ImageRichStyle instance.

返回:

Returns the image.

从以下版本开始:

7

getImageAlign

public ImageRichStyle.ImageAlignment getImageAlign()

Obtains the vertical alignment mode of the image in this ImageRichStyle instance.

返回:

Returns the vertical alignment mode of the image.

从以下版本开始:

7