RichText

java.lang.Object
- ohos.agp.text.RichText

所有已实现的接口:

Appendable, CharSequence
```
public final class RichText
extends Object
implements Appendable, CharSequence
```
Represents rich text in different formats.
This class is the combination of Text and RichStyle. You can use setRichStyle(ohos.agp.text.richstyles.RichStyle, int, int, ohos.agp.text.richstyles.RangedRichStyle.Flag) to add a rich style for the text.

从以下版本开始:

3

嵌套类概要

嵌套类
限定符和类型类说明

static interface RichText.TouchEventListener
已过时。
This change is effective since API version 8. Replaced by ClickRichStyle.

嵌套类
限定符和类型	类	说明
`static interface`	`RichText.TouchEventListener`	已过时。 This change is effective since API version 8. Replaced by `ClickRichStyle`.

构造器概要

构造器
构造器	说明
`RichText()`	A constructor used to create a `RichText` instance.
`RichText(String text)`	A constructor used to create a `RichText` instance based on the specified `text`.
`RichText(RichText richText)`	A constructor used to create a `RichText` instance based on the specified `richText`.

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法	说明
`void`	`addTouchEventListener(RichText.TouchEventListener listener, int start, int end)`	已过时。 This change is effective since API version 8. Replaced by `ClickRichStyle`.
`Appendable`	`append(char c)`	Appends a character to the end of this rich text.
`Appendable`	`append(CharSequence charSequence)`	Appends the specified `charSequence` to the end of this rich text.
`Appendable`	`append(CharSequence charSequence, int start, int end)`	Appends the content in the range specified by `start` and `end` of `charSequence` to the end of this rich text.
`char`	`charAt(int position)`	Obtains the character at the specified position in this rich text.
`void`	`delete(int start, int end)`	Deletes the text and rich style in the range specified by `start` and `end` from this rich text.
`void`	`deleteAll()`	Deletes the text and all rich styles from this rich text.
`void`	`deleteRichStyles()`	Deletes all the rich styles from this rich text.
`List<Integer>`	`findAllTransitionPointsByCapability(int start, int end, int capability)`	Obtains all the transition points of a rich style in the range specified by `start` and `end` based on the `capability`.
`List<Integer>`	`findAllTransitionPointsByTypeId(int start, int end, RichStyle.TypeId typeId)`	Obtains all the transition points of a rich style in the range specified by `start` and `end` based on the `typeId`.
`int`	`findNextTransitionPointByCapability(int start, int end, int capability)`	Obtains the next transition point of a rich style in the range specified by `start` and `end` based on the `capability`.
`int`	`findNextTransitionPointByTypeId(int start, int end, RichStyle.TypeId typeId)`	Obtains the next transition point of a rich style in the range specified by `start` and `end` based on the `typeId`.
`int`	`getLeadingMargin(boolean firstMargin)`	已过时。 This change is effective since API version 8. Replaced by `IndentRichStyle`.
`RangedRichStyle`	`getRangedRichStyle(RichStyle richStyle)`	Obtains the coverage and inclusion relationship of the specified rich style in this rich text.
`List<RangedRichStyle>`	`getRangedRichStylesByCapability(int start, int end, int capability)`	Obtains the list of rich styles corresponding to the `capability` in the given range of this rich text.
`List<RangedRichStyle>`	`getRangedRichStylesByTypeId(int start, int end, RichStyle.TypeId typeId)`	Obtains the list of rich styles of the specified `typeId` in a given range of this rich text.
`void`	`insert(int position, String text)`	Inserts the specified text into the `position` of this rich text.
`void`	`insert(int position, String text, int textStart, int textEnd)`	Inserts the content in the range specified by `textStart` and `textEnd` in the `text` into the `position` of this rich text.
`void`	`insert(int position, RichText richText)`	Inserts the specified rich text into the `position` of this rich text.
`void`	`insert(int position, RichText richText, int textStart, int textEnd)`	Inserts the content in the range specified by `textStart` and `textEnd` in the `richText` into the `position` of this rich text.
`int`	`length()`	Obtains the length of the string in this rich text.
`void`	`removeRichStyle(RichStyle richStyle)`	Removes the specified rich style from this rich text.
`void`	`removeRichStyleByCapability(int capability)`	Removes the rich style of the specified `capability` from this rich text.
`void`	`removeRichStyleByTypeId(RichStyle.TypeId typeId)`	Removes the rich styles enumerated by the `typeId` from this rich text.
`void`	`replace(int start, int end, String text)`	Replaces the content in the range specified by `start` and `end` of this rich text with the `text`.
`void`	`replace(int start, int end, String text, int textStart, int textEnd)`	Replaces the content in the range specified by `start` and `end` of this rich text with the content in the range specified by `textStart` and `textEnd` in the `text`.
`void`	`replace(int start, int end, RichText richText)`	Replaces the content in the range specified by `start` and `end` of this rich text with the `richText`.
`void`	`replace(int start, int end, RichText richText, int textStart, int textEnd)`	Replaces the content in the range specified by `start` and `end` of this rich text with the content in the range specified by `textStart` and `textEnd` in the `richText`.
`void`	`setLeadingMargin(int firstMargin, int restMargin)`	已过时。 This change is effective since API version 8. Replaced by `IndentRichStyle`.
`void`	`setRichStyle(RangedRichStyle rangedRichStyle)`	Sets a `RangedRichStyle` for this rich text.
`void`	`setRichStyle(RichStyle richStyle, int start, int end, RangedRichStyle.Flag includeFlag)`	Sets a `RichStyle` for this rich text.
`CharSequence`	`subSequence(int start, int end)`	Obtains a substring from this rich text.
`String`	`toString()`	Obtains the plain text from this rich text.

从接口继承的方法 java.lang.CharSequence
chars, codePoints

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - RichText
```
public RichText()
```
    A constructor used to create a RichText instance. You can use setRichStyle(ohos.agp.text.richstyles.RichStyle, int, int, ohos.agp.text.richstyles.RangedRichStyle.Flag) to add a rich style later.
    
    从以下版本开始:
    
    7
  - RichText
```
public RichText(String text)
```
    A constructor used to create a RichText instance based on the specified text. You can use setRichStyle(ohos.agp.text.richstyles.RichStyle, int, int, ohos.agp.text.richstyles.RangedRichStyle.Flag) to add a rich style later.
    
    参数:
    
    text - Indicates the plain text, which can be null.
    
    从以下版本开始:
    
    7
  - RichText
```
public RichText(RichText richText)
```
    A constructor used to create a RichText instance based on the specified richText.
    
    参数:
    
    richText - Indicates the rich text, which cannot be null.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the specified richText is null.
    
    从以下版本开始:
    
    7
- 方法详细资料
  - charAt
```
public char charAt(int position)
```
    Obtains the character at the specified position in this rich text.
    
    指定者:
    
    charAt 在接口中 CharSequence
    
    参数:
    
    position - Indicates the position at which the character is to be obtained. The value must be greater than or equal to 0 and less than the text length.
    
    返回:
    
    Returns the character at the specified position.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the value of position exceeds the text length or is negative.
    
    从以下版本开始:
    
    7
  - length
```
public int length()
```
    Obtains the length of the string in this rich text.
    
    指定者:
    
    length 在接口中 CharSequence
    
    返回:
    
    Returns the string length.
    
    从以下版本开始:
    
    7
  - subSequence
```
public CharSequence subSequence(int start,
                                int end)
```
    Obtains a substring from this rich text.
    
    指定者:
    
    subSequence 在接口中 CharSequence
    
    参数:
    
    start - Indicates the start position in the rich text.
    
    end - Indicates the end position in the rich text.
    
    返回:
    
    Returns the substring.
    
    从以下版本开始:
    
    7
  - toString
```
public String toString()
```
    Obtains the plain text from this rich text.
    
    指定者:
    
    toString 在接口中 CharSequence
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    Returns the plain text.
    
    从以下版本开始:
    
    7
  - append
```
public Appendable append(CharSequence charSequence)
```
    Appends the specified charSequence to the end of this rich text.
    
    指定者:
    
    append 在接口中 Appendable
    
    参数:
    
    charSequence - Indicates the rich text or plain text to append.
    
    返回:
    
    Returns the new rich text.
    
    从以下版本开始:
    
    7
  - append
```
public Appendable append(CharSequence charSequence,
                         int start,
                         int end)
```
    Appends the content in the range specified by start and end of charSequence to the end of this rich text.
    
    指定者:
    
    append 在接口中 Appendable
    
    参数:
    
    charSequence - Indicates the rich text or plain text to append.
    
    start - Indicates the start position in the rich text or plain text.
    
    end - Indicates the end position in the rich text or plain text.
    
    返回:
    
    Returns the new rich text.
    
    从以下版本开始:
    
    7
  - append
```
public Appendable append(char c)
```
    Appends a character to the end of this rich text.
    
    指定者:
    
    append 在接口中 Appendable
    
    参数:
    
    c - Indicates the character to append.
    
    返回:
    
    Returns the new rich text.
    
    从以下版本开始:
    
    7
  - addTouchEventListener
```
@Deprecated
public void addTouchEventListener(RichText.TouchEventListener listener,
                                  int start,
                                  int end)
```
    已过时。 This change is effective since API version 8. Replaced by ClickRichStyle.
    
    Adds a listener to listen for a touch event on a specific rich text paragraph.
    
    参数:
    
    listener - Indicates the touch event listener to add.
    
    start - Indicates the start position of the rich text paragraph that responds to a touch event.
    
    end - Indicates the end position of the rich text paragraph that responds to a touch event.
    
    从以下版本开始:
    
    3
  - setLeadingMargin
```
@Deprecated
public void setLeadingMargin(int firstMargin,
                             int restMargin)
```
    已过时。 This change is effective since API version 8. Replaced by IndentRichStyle.
    
    Sets the leading margins for this rich text paragraph.
    
    参数:
    
    firstMargin - Indicates the margin of the first line in the paragraph, in pixels.
    
    restMargin - Indicates the margin of the other lines in the paragraph, in pixels.
    
    从以下版本开始:
    
    3
  - getLeadingMargin
```
@Deprecated
public int getLeadingMargin(boolean firstMargin)
```
    已过时。 This change is effective since API version 8. Replaced by IndentRichStyle.
    
    Obtains the leading margins of this rich text paragraph.
    
    参数:
    
    firstMargin - Specifies whether to obtain the leading margin of the first line or the other lines of this rich text paragraph. The value true means to obtain the margin of the first line, and false means to obtain the margin of the other lines.
    
    返回:
    
    Returns the leading margins, in pixels.
    
    从以下版本开始:
    
    3
  - getRangedRichStylesByTypeId
```
public List<RangedRichStyle> getRangedRichStylesByTypeId(int start,
                                                         int end,
                                                         RichStyle.TypeId typeId)
```
    Obtains the list of rich styles of the specified typeId in a given range of this rich text.
    
    参数:
    
    start - Indicates the start position in the rich text.
    
    end - Indicates the end position in the rich text.
    
    typeId - Indicates a RichStyle.TypeId object.
    
    返回:
    
    Returns a list of RangedRichStyle objects, each of which includes a rich style, its coverage, and its inclusion relationship if obtained; returns the List that contains zero elements if no data is found.
    
    从以下版本开始:
    
    7
  - getRangedRichStylesByCapability
```
public List<RangedRichStyle> getRangedRichStylesByCapability(int start,
                                                             int end,
                                                             int capability)
```
    Obtains the list of rich styles corresponding to the capability in the given range of this rich text.
    
    参数:
    
    start - Indicates the start position in the rich text.
    
    end - Indicates the end position in the rich text.
    
    capability - Indicates the capability of a rich style, which affects the character appearance and paragraph presentation. For details, see RichStyle.Capability.
    
    返回:
    
    Returns a list of RangedRichStyle objects, each of which includes a rich style, its coverage, and its inclusion relationship if obtained; returns the List that contains zero elements if no data is found.
    
    从以下版本开始:
    
    7
  - getRangedRichStyle
```
public RangedRichStyle getRangedRichStyle(RichStyle richStyle)
```
    Obtains the coverage and inclusion relationship of the specified rich style in this rich text.
    
    参数:
    
    richStyle - Indicates the style of the rich text.
    
    返回:
    
    Returns a RangedRichStyle object, which includes a rich style, its coverage, and its inclusion relationship if obtained; returns null if no data is found.
    
    从以下版本开始:
    
    7
  - setRichStyle
```
public void setRichStyle(RichStyle richStyle,
                         int start,
                         int end,
                         RangedRichStyle.Flag includeFlag)
```
    Sets a RichStyle for this rich text.
    You must specify a richStyle, its start and end positions (start and end) in the string, and the inclusion relationship (includeFlag) for adding text to the left and right boundaries. Note: An exception is thrown if the range specified by start and end is incorrect. If a rich style is set for multiple times, only the last setting is retained.
    
    参数:
    
    richStyle - Indicates the rich style to set.
    
    start - Indicates the start position in the rich text.
    
    end - Indicates the end position in the rich text.
    
    includeFlag - Indicates the inclusion relationship. For details, see RangedRichStyle.Flag.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the value of richStyle is null, exceeds the text length, or is negative.
    
    从以下版本开始:
    
    7
  - setRichStyle
```
public void setRichStyle(RangedRichStyle rangedRichStyle)
```
    Sets a RangedRichStyle for this rich text.
    rangedRichStyle specifies the rich style, start position, end position, and inclusion relationship for adding text to the left and right boundaries. Note: If a rich style is set for multiple times, only the last setting is retained.
    
    参数:
    
    rangedRichStyle - Indicates the RichStyle data structure stored in the rich text, which contains the start position, end position, and inclusion relationship.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the value of rangedRichStyle is null, exceeds the text length, or is negative.
    
    从以下版本开始:
    
    7
  - findNextTransitionPointByTypeId
```
public int findNextTransitionPointByTypeId(int start,
                                           int end,
                                           RichStyle.TypeId typeId)
```
    Obtains the next transition point of a rich style in the range specified by start and end based on the typeId.
    
    参数:
    
    start - Indicates the start position in the rich text. start is not included.
    
    end - Indicates the end position in the rich text. end is included.
    
    typeId - Indicates a RichStyle.TypeId object.
    
    返回:
    
    Returns the next transition point if obtained; returns end if no data is found.
    
    从以下版本开始:
    
    7
  - findNextTransitionPointByCapability
```
public int findNextTransitionPointByCapability(int start,
                                               int end,
                                               int capability)
```
    Obtains the next transition point of a rich style in the range specified by start and end based on the capability.
    
    参数:
    
    start - Indicates the start position in the rich text. start is not included.
    
    end - Indicates the end position in the rich text. end is included.
    
    capability - Indicates the capability of a rich style, which affects the character appearance and paragraph presentation. For details, see RichStyle.Capability.
    
    返回:
    
    Returns the next transition point if obtained; returns end if no data is found.
    
    从以下版本开始:
    
    7
  - findAllTransitionPointsByTypeId
```
public List<Integer> findAllTransitionPointsByTypeId(int start,
                                                     int end,
                                                     RichStyle.TypeId typeId)
```
    Obtains all the transition points of a rich style in the range specified by start and end based on the typeId.
    
    参数:
    
    start - Indicates the start position in the rich text. start is not included.
    
    end - Indicates the end position in the rich text. end is included.
    
    typeId - Indicates a RichStyle.TypeId object.
    
    返回:
    
    Returns all the transition points.
    
    从以下版本开始:
    
    7
  - findAllTransitionPointsByCapability
```
public List<Integer> findAllTransitionPointsByCapability(int start,
                                                         int end,
                                                         int capability)
```
    Obtains all the transition points of a rich style in the range specified by start and end based on the capability.
    
    参数:
    
    start - Indicates the start position in the rich text. start is not included.
    
    end - Indicates the end position in the rich text. end is included.
    
    capability - Indicates the capability of a rich style, which affects the character appearance and paragraph presentation. For details, see RichStyle.Capability.
    
    返回:
    
    Returns all the transition points.
    
    从以下版本开始:
    
    7
  - removeRichStyle
```
public void removeRichStyle(RichStyle richStyle)
```
    Removes the specified rich style from this rich text. If richStyle is null, no rich style is removed.
    
    参数:
    
    richStyle - Indicates the rich style to remove.
    
    从以下版本开始:
    
    7
  - removeRichStyleByTypeId
```
public void removeRichStyleByTypeId(RichStyle.TypeId typeId)
```
    Removes the rich styles enumerated by the typeId from this rich text.
    
    参数:
    
    typeId - Indicates a RichStyle.TypeId object.
    
    从以下版本开始:
    
    7
  - removeRichStyleByCapability
```
public void removeRichStyleByCapability(int capability)
```
    Removes the rich style of the specified capability from this rich text.
    
    参数:
    
    capability - Indicates the capability of a rich style, which affects the character appearance and paragraph presentation. For details, see RichStyle.Capability.
    
    从以下版本开始:
    
    7
  - replace
```
public void replace(int start,
                    int end,
                    String text)
```
    Replaces the content in the range specified by start and end of this rich text with the text.
    Note:
    1. If the old content in the specified range contains a rich style, this rich style automatically applies to the new text.
    2. If the specified range is incorrect or the text to be used for replacement is null, the replacement operation will not be performed.
    参数:
    
    start - Indicates the start position in the rich text.
    
    end - Indicates the end position in the rich text.
    
    text - Indicates the text to be used for replacement.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if an input parameter is invalid.
    
    从以下版本开始:
    
    7
  - replace
```
public void replace(int start,
                    int end,
                    RichText richText)
```
    Replaces the content in the range specified by start and end of this rich text with the richText.
    Note:
    1. If the old content in the specified range contains a rich style, this rich style automatically applies to the new text.
    2. If the specified range is incorrect or the text to be used for replacement is null, the replacement operation will not be performed.
    参数:
    
    start - Indicates the start position in the rich text.
    
    end - Indicates the end position in the rich text.
    
    richText - Indicates the rich text to be used for replacement.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if an input parameter is invalid.
    
    从以下版本开始:
    
    7
  - replace
```
public void replace(int start,
                    int end,
                    String text,
                    int textStart,
                    int textEnd)
```
    Replaces the content in the range specified by start and end of this rich text with the content in the range specified by textStart and textEnd in the text.
    Note:
    1. If the old content in the specified range contains a rich style, this rich style automatically applies to the new text.
    2. If the specified range is incorrect or the text to be used for replacement is null, the replacement operation will not be performed.
    参数:
    
    start - Indicates the start position in the rich text.
    
    end - Indicates the end position in the rich text.
    
    text - Indicates the text to be used for replacement.
    
    textStart - Indicates the start position in the text to be used for replacement.
    
    textEnd - Indicates the end position in the text to be used for replacement.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if an input parameter is invalid.
    
    从以下版本开始:
    
    7
  - replace
```
public void replace(int start,
                    int end,
                    RichText richText,
                    int textStart,
                    int textEnd)
```
    Replaces the content in the range specified by start and end of this rich text with the content in the range specified by textStart and textEnd in the richText.
    Note:
    1. If the old content in the specified range contains a rich style, this rich style automatically applies to the new text.
    2. If the specified range is incorrect or the text to be used for replacement is null, the replacement operation will not be performed.
    参数:
    
    start - Indicates the start position in the rich text.
    
    end - Indicates the end position in the rich text.
    
    richText - Indicates the rich text to be used for replacement.
    
    textStart - Indicates the start position in the rich text to be used for replacement.
    
    textEnd - Indicates the end position in the rich text to be used for replacement.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if an input parameter is invalid.
    
    从以下版本开始:
    
    7
  - deleteAll
```
public void deleteAll()
```
    Deletes the text and all rich styles from this rich text.
    
    从以下版本开始:
    
    7
  - deleteRichStyles
```
public void deleteRichStyles()
```
    Deletes all the rich styles from this rich text.
    
    从以下版本开始:
    
    7
  - delete
```
public void delete(int start,
                   int end)
```
    Deletes the text and rich style in the range specified by start and end from this rich text. No deletion is performed if the input parameters are invalid.
    
    参数:
    
    start - Indicates the start position in the rich text.
    
    end - Indicates the end position in the rich text.
    
    从以下版本开始:
    
    7
  - insert
```
public void insert(int position,
                   String text)
```
    Inserts the specified text into the position of this rich text.
    Note:
    1. If the position contains a rich style, this rich style automatically applies to the inserted text.
    2. If the position is incorrect or the text to insert is null, the insertion operation will not be performed.
    参数:
    
    position - Indicates the position where the text will be inserted.
    
    text - Indicates the text to insert.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if an input parameter is invalid.
    
    从以下版本开始:
    
    7
  - insert
```
public void insert(int position,
                   RichText richText)
```
    Inserts the specified rich text into the position of this rich text.
    Note:
    1. If the position contains a rich style, this rich style automatically applies to the inserted text.
    2. If the position is incorrect or the text to insert is null, the insertion operation will not be performed.
    参数:
    
    position - Indicates the position where the rich text will be inserted.
    
    richText - Indicates the rich text to insert.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if an input parameter is invalid.
    
    从以下版本开始:
    
    7
  - insert
```
public void insert(int position,
                   String text,
                   int textStart,
                   int textEnd)
```
    Inserts the content in the range specified by textStart and textEnd in the text into the position of this rich text.
    Note:
    1. If the position contains a rich style, this rich style automatically applies to the inserted text.
    2. If the position is incorrect or the text to insert is null, the insertion operation will not be performed.
    参数:
    
    position - Indicates the position where the text will be inserted.
    
    text - Indicates the text to insert.
    
    textStart - Indicates the start position in the text to insert.
    
    textEnd - Indicates the end position in the text to insert.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if an input parameter is invalid.
    
    从以下版本开始:
    
    7
  - insert
```
public void insert(int position,
                   RichText richText,
                   int textStart,
                   int textEnd)
```
    Inserts the content in the range specified by textStart and textEnd in the richText into the position of this rich text.
    Note:
    1. If the position contains a rich style, this rich style automatically applies to the inserted text.
    2. If the position is incorrect or the text to insert is null, the insertion operation will not be performed.
    参数:
    
    position - Indicates the position where the rich text will be inserted.
    
    richText - Indicates the rich text to insert.
    
    textStart - Indicates the start position in the rich text to insert.
    
    textEnd - Indicates the end position in the rich text to insert.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if an input parameter is invalid.
    
    从以下版本开始:
    
    7

类 RichText

嵌套类概要

构造器概要

方法概要

从接口继承的方法 java.lang.CharSequence

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

构造器详细资料

RichText

RichText

RichText

方法详细资料

charAt

length

subSequence

toString

append

append

append

addTouchEventListener

setLeadingMargin

getLeadingMargin

getRangedRichStylesByTypeId

getRangedRichStylesByCapability

getRangedRichStyle

setRichStyle

setRichStyle

findNextTransitionPointByTypeId

findNextTransitionPointByCapability

findAllTransitionPointsByTypeId

findAllTransitionPointsByCapability

removeRichStyle

removeRichStyleByTypeId

removeRichStyleByCapability

replace

replace

replace

replace

deleteAll

deleteRichStyles

delete

insert

insert

insert

insert