TextForm

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

所有已实现的接口:

Cloneable

已过时。
This change is effective since API version 8. Replaced by RichStyle.
```
@Deprecated
public class TextForm
extends Object
implements Cloneable
```
Represents the rich text form. The TextForm object is used for creating a RichTextBuilder object.

从以下版本开始:

3

另请参阅:

RichTextBuilder

构造器概要

构造器
构造器说明

TextForm()
已过时。

构造器
构造器	说明
`TextForm()`	已过时。

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法	说明
`Object`	`clone()`	已过时。
`float`	`getLineHeight()`	已过时。
`float`	`getRelativeTextSize()`	已过时。
`float`	`getScaleX()`	已过时。
`boolean`	`getStrikethrough()`	已过时。
`boolean`	`getSubscript()`	已过时。
`boolean`	`getSuperscript()`	已过时。
`int`	`getTextBackgroundColor()`	已过时。
`int`	`getTextColor()`	已过时。
`Font`	`getTextFont()`	已过时。
`int`	`getTextSize()`	已过时。
`boolean`	`getUnderline()`	已过时。
`TextForm`	`setLineHeight(float height)`	已过时。
`TextForm`	`setRelativeTextSize(float relativeTextSize)`	已过时。
`TextForm`	`setScaleX(float scaleX)`	已过时。
`TextForm`	`setStrikethrough(boolean strikethrough)`	已过时。
`TextForm`	`setSubscript(boolean subscript)`	已过时。
`TextForm`	`setSuperscript(boolean superscript)`	已过时。
`TextForm`	`setTextBackgroundColor(int color)`	已过时。
`TextForm`	`setTextColor(int color)`	已过时。
`TextForm`	`setTextFont(Font font)`	已过时。
`TextForm`	`setTextSize(int size)`	已过时。
`TextForm`	`setUnderline(boolean underline)`	已过时。

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

- 构造器详细资料
  - TextForm
```
@Deprecated
public TextForm()
```
    已过时。
    
    Default constructor used to create a TextForm instance.
- 方法详细资料
  - setTextSize
```
@Deprecated
public TextForm setTextSize(int size)
```
    已过时。
    
    Sets the text size.
    
    参数:
    
    size - Indicates the text size to set, in pixels. The value must be greater than 0.
    
    返回:
    
    Returns this TextForm object with the specified text size.
    
    从以下版本开始:
    
    3
  - getTextSize
```
@Deprecated
public int getTextSize()
```
    已过时。
    
    Obtains the text size.
    
    返回:
    
    Returns the text size.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    setTextSize(int)
  - setTextColor
```
@Deprecated
public TextForm setTextColor(int color)
```
    已过时。
    
    Sets the text color.
    
    参数:
    
    color - Indicates the text color to set, in ARGB format.
    
    返回:
    
    Returns this TextForm object with the specified text color.
    
    从以下版本开始:
    
    3
  - getTextColor
```
@Deprecated
public int getTextColor()
```
    已过时。
    
    Obtains the text color.
    
    返回:
    
    Returns the text color.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    setTextColor(int)
  - setTextFont
```
@Deprecated
public TextForm setTextFont(Font font)
```
    已过时。
    
    Sets the text font.
    
    参数:
    
    font - the text font to set.
    
    返回:
    
    Returns this TextForm object with the specified text font.
    
    从以下版本开始:
    
    3
  - getTextFont
```
@Deprecated
public Font getTextFont()
```
    已过时。
    
    Obtains the text font.
    
    返回:
    
    Returns the text font.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    setTextFont(Font)
  - setScaleX
```
@Deprecated
public TextForm setScaleX(float scaleX)
```
    已过时。
    
    Sets the horizontal scale ratio for this text.
    
    参数:
    
    scaleX - scaleX Indicates the horizontal scale ratio to set, which must be greater than 0.
    
    返回:
    
    Returns the current TextForm object.
    
    从以下版本开始:
    
    3
  - getScaleX
```
@Deprecated
public float getScaleX()
```
    已过时。
    
    Obtains the horizontal scale ratio of this text.
    
    返回:
    
    Returns the horizontal scale ratio.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    setScaleX(float)
  - setStrikethrough
```
@Deprecated
public TextForm setStrikethrough(boolean strikethrough)
```
    已过时。
    
    Sets whether to add a strikethrough for this text.
    
    参数:
    
    strikethrough - Specifies whether to add a strikethrough. The value true means to add a strikethrough, and false (default value) means the opposite.
    
    返回:
    
    Returns the current TextForm object.
    
    从以下版本开始:
    
    3
  - getStrikethrough
```
@Deprecated
public boolean getStrikethrough()
```
    已过时。
    
    Checks whether a strikethrough is added for this text.
    
    返回:
    
    Returns true if a strikethrough is added for this text; returns false otherwise.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    setStrikethrough(boolean)
  - setTextBackgroundColor
```
@Deprecated
public TextForm setTextBackgroundColor(int color)
```
    已过时。
    
    Sets the background color for this text.
    
    参数:
    
    color - Indicates the background color to set. For example, the value Color.YELLOW.getValue() means to set the background color to yellow.
    
    返回:
    
    Returns the current TextForm object.
    
    从以下版本开始:
    
    3
  - getTextBackgroundColor
```
@Deprecated
public int getTextBackgroundColor()
```
    已过时。
    
    Obtains the background color of this text.
    
    返回:
    
    Returns the background color.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    setTextBackgroundColor(int)
  - setLineHeight
```
@Deprecated
public TextForm setLineHeight(float height)
```
    已过时。
    
    Sets the line height for this text.
    
    参数:
    
    height - Indicates the line height to set, in px.
    
    返回:
    
    Returns the current TextForm object.
    
    从以下版本开始:
    
    3
  - getLineHeight
```
@Deprecated
public float getLineHeight()
```
    已过时。
    
    Obtains the line height of this text.
    
    返回:
    
    Returns the line height.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    setLineHeight(float)
  - setUnderline
```
@Deprecated
public TextForm setUnderline(boolean underline)
```
    已过时。
    
    Sets whether to add an underline for this text.
    
    参数:
    
    underline - Specifies whether to add an underline. The value true means to add an underline, and false (default value) means the opposite.
    
    返回:
    
    Returns the current TextForm object.
    
    从以下版本开始:
    
    3
  - getUnderline
```
@Deprecated
public boolean getUnderline()
```
    已过时。
    
    Checks whether an underline is added for this text.
    
    返回:
    
    Returns true if an underline is added for this text; returns false otherwise.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    setUnderline(boolean)
  - setRelativeTextSize
```
@Deprecated
public TextForm setRelativeTextSize(float relativeTextSize)
```
    已过时。
    
    Sets the relative size for this text.
    
    参数:
    
    relativeTextSize - Indicates the relative size to set, which must be greater than 0.
    
    返回:
    
    Returns the current TextForm object.
    
    从以下版本开始:
    
    3
  - getRelativeTextSize
```
@Deprecated
public float getRelativeTextSize()
```
    已过时。
    
    Obtains the relative size of this text.
    
    返回:
    
    Returns the relative text size.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    setRelativeTextSize(float)
  - setSuperscript
```
@Deprecated
public TextForm setSuperscript(boolean superscript)
```
    已过时。
    
    Sets whether to make this text a superscript.
    
    参数:
    
    superscript - Specifies whether to make this text a superscript. The value true means to make this text a superscript, and false (default value) means the opposite.
    
    返回:
    
    Returns the current TextForm object.
    
    从以下版本开始:
    
    3
  - getSuperscript
```
@Deprecated
public boolean getSuperscript()
```
    已过时。
    
    Checks whether this text is a superscript.
    
    返回:
    
    Returns true if this text is a superscript; returns false otherwise.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    setSuperscript(boolean)
  - setSubscript
```
@Deprecated
public TextForm setSubscript(boolean subscript)
```
    已过时。
    
    Sets whether to make this text a subscript.
    
    参数:
    
    subscript - Specifies whether to make this text a subscript. The value true means to make this text a subscript, and false (default value) means the opposite.
    
    返回:
    
    Returns the current TextForm object.
    
    从以下版本开始:
    
    3
  - getSubscript
```
@Deprecated
public boolean getSubscript()
```
    已过时。
    
    Checks whether this text is a subscript.
    
    返回:
    
    Returns true if this text is a subscript; returns false otherwise.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    setSubscript(boolean)
  - clone
```
@Deprecated
public Object clone()
             throws CloneNotSupportedException
```
    已过时。
    Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:
    x.clone() != x
    will be true, and that the expression:
    x.clone().getClass() == x.getClass()
    will be true, but these are not absolute requirements. While it is typically the case that:
    x.clone().equals(x)
    will be true, this is not an absolute requirement.
    By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().
    By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.
    The method clone for class Object performs a specific cloning operation. First, if the class of this object does not implement the interface Cloneable, then a CloneNotSupportedException is thrown. Note that all arrays are considered to implement the interface Cloneable and that the return type of the clone method of an array type T[] is T[] where T is any reference or primitive type. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of this object, not a "deep copy" operation.
    The class Object does not itself implement the interface Cloneable, so calling the clone method on an object whose class is Object will result in throwing an exception at run time.
    覆盖:
    
    clone 在类中 Object
    
    返回:
    
    a clone of this instance.
    
    抛出:
    
    CloneNotSupportedException - if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.
    
    另请参阅:
    
    Cloneable

类 TextForm

构造器概要

方法概要

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

构造器详细资料

TextForm

方法详细资料

setTextSize

getTextSize

setTextColor

getTextColor

setTextFont

getTextFont

setScaleX

getScaleX

setStrikethrough

getStrikethrough

setTextBackgroundColor

getTextBackgroundColor

setLineHeight

getLineHeight

setUnderline

getUnderline

setRelativeTextSize

getRelativeTextSize

setSuperscript

getSuperscript

setSubscript

getSubscript

clone