Layout

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

直接已知子类:

RichTextLayout, SimpleTextLayout

已过时。
This change is effective since API version 8. Replaced by TextLayout.
```
@Deprecated
public abstract class Layout
extends Object
```
Represents an abstract class that manages text layout in visual elements on the screen. This class is implemented by SimpleTextLayout and RichTextLayout.
For simple text, use SimpleTextLayout; for rich text with multiple forms, use RichTextLayout.

从以下版本开始:

3

字段概要

字段
限定符和类型字段说明

protected long mNativeLayoutHandle
已过时。

字段
限定符和类型	字段	说明
`protected long`	`mNativeLayoutHandle`	已过时。

构造器概要

构造器
构造器说明

Layout()
已过时。

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

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法	说明
`void`	`drawHighlight(Canvas canvas, Path HighlightPath, Paint highlightPaint, int offSetInVertical)`	已过时。
`void`	`drawText(Canvas canvas)`	已过时。
`int`	`getAscent(int line)`	已过时。
`int`	`getBaseline(int line)`	已过时。
`int`	`getBeginCharIndex(int line)`	已过时。
`int`	`getBottom(int line)`	已过时。
`int`	`getCharIndexByCoordinate(int line, float horizCoordinate)`	已过时。
`float`	`getCoordinateForVertical(int point)`	已过时。
`float`	`getCoordinateInMainDir(int offset)`	已过时。
`float`	`getCoordinateInSecondDir(int offset)`	已过时。
`int`	`getDescent(int line)`	已过时。
`int`	`getEndCharIndex(int line)`	已过时。
`int`	`getHeight()`	已过时。
`int`	`getLimitWidth(int line)`	已过时。
`int`	`getLineCount()`	已过时。
`float`	`getLineEnd(int line)`	已过时。
`int`	`getLineIndexByCharIndex(int offset)`	已过时。
`int`	`getLineIndexByCoordinate(int verticalCoordinate)`	已过时。
`float`	`getLineStart(int line)`	已过时。
`float`	`getNumOfFontHeight()`	已过时。
`float`	`getTextWidth(int line)`	已过时。
`int`	`getTop(int line)`	已过时。
`int`	`getWidth()`	已过时。

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

- 字段详细资料
  - mNativeLayoutHandle
```
@Deprecated
protected long mNativeLayoutHandle
```
    已过时。
    
    Indicates the pointer to the C++ native layout object.
- 构造器详细资料
  - Layout
```
@Deprecated
public Layout()
```
    已过时。
- 方法详细资料
  - drawText
```
@Deprecated
public void drawText(Canvas canvas)
```
    已过时。
    
    Draws text on a specified Canvas object after the layout is complete.
    
    参数:
    
    canvas - Indicates the Canvas object.
    
    从以下版本开始:
    
    3
  - drawHighlight
```
@Deprecated
public void drawHighlight(Canvas canvas,
                          Path HighlightPath,
                          Paint highlightPaint,
                          int offSetInVertical)
```
    已过时。
    
    Draws text on a specified Canvas object with the given highlight paint and by following the highlight path drawn between the background and the text.
    
    参数:
    
    canvas - Indicates the Canvas object.
    
    HighlightPath - Indicates the highlight path.
    
    highlightPaint - Indicates the highlight paint.
    
    offSetInVertical - Indicates the offset to temporarily translate the canvas when rendering the highlight.
    
    从以下版本开始:
    
    3
  - getWidth
```
@Deprecated
public final int getWidth()
```
    已过时。
    
    Obtains the width of this layout.
    
    返回:
    
    Returns the width of this layout, in px.
    
    从以下版本开始:
    
    3
  - getHeight
```
@Deprecated
public int getHeight()
```
    已过时。
    
    Obtains the height of this layout.
    
    返回:
    
    Returns the height of this layout, in px.
    
    从以下版本开始:
    
    3
  - getAscent
```
@Deprecated
public int getAscent(int line)
```
    已过时。
    
    Obtains the ascent from a specified line.
    
    参数:
    
    line - Indicates the specified line.
    
    返回:
    
    Returns the ascent if obtained; returns 0 if the value of line is invalid.
    
    从以下版本开始:
    
    3
  - getDescent
```
@Deprecated
public int getDescent(int line)
```
    已过时。
    
    Obtains the descent from a specified li
    
    参数:
    
    line - Indicates the specified line.
    
    返回:
    
    Returns the descent if obtained; returns 0 if the value of line is invalid.
    
    从以下版本开始:
    
    3
  - getBaseline
```
@Deprecated
public int getBaseline(int line)
```
    已过时。
    
    Obtains the baseline of a specified line.
    
    参数:
    
    line - Indicates the specified line.
    
    返回:
    
    Returns the baseline if obtained; returns -1 if the value of line is invalid.
    
    从以下版本开始:
    
    3
  - getTop
```
@Deprecated
public int getTop(int line)
```
    已过时。
    
    Obtains the top of a specified line.
    
    参数:
    
    line - Indicates the specified line.
    
    返回:
    
    Returns the top if obtained; returns -1 if the value of line is invalid; returns the bottom of the last line if the value of line is equal to the line count obtained via getLineCount().
    
    从以下版本开始:
    
    3
  - getBottom
```
@Deprecated
public int getBottom(int line)
```
    已过时。
    
    Obtains the bottom of a specified line.
    
    参数:
    
    line - Indicates the specified line.
    
    返回:
    
    Returns the bottom if obtained; returns -1 if the value of line is invalid.
    
    从以下版本开始:
    
    3
  - getLineCount
```
@Deprecated
public int getLineCount()
```
    已过时。
    
    Obtains the number of lines.
    
    返回:
    
    Returns the number of lines.
    
    从以下版本开始:
    
    3
  - getBeginCharIndex
```
@Deprecated
public int getBeginCharIndex(int line)
```
    已过时。
    
    Obtains the index to the first character of a specified line.
    
    参数:
    
    line - Indicates the specified line.
    
    返回:
    
    Returns the index if obtained; returns -1 if the value of line is invalid.
    
    从以下版本开始:
    
    3
  - getEndCharIndex
```
@Deprecated
public int getEndCharIndex(int line)
```
    已过时。
    
    Obtains the index of the last character of a specified line.
    
    参数:
    
    line - Indicates the specified line.
    
    返回:
    
    Returns the index if obtained; returns -1 if the value of line is invalid.
    
    从以下版本开始:
    
    3
  - getLineIndexByCharIndex
```
@Deprecated
public int getLineIndexByCharIndex(int offset)
```
    已过时。
    
    Obtains the index to the line where a specified indexed character is located.
    
    参数:
    
    offset - Indicates the index of the character.
    
    返回:
    
    Returns the index of the line if obtained; returns -1 if the value of offset is invalid.
    
    从以下版本开始:
    
    3
  - getLineStart
```
@Deprecated
public float getLineStart(int line)
```
    已过时。
    
    Obtains the horizontal coordinate of the start of a specified line.
    
    参数:
    
    line - Indicates the specified line.
    
    返回:
    
    Returns the horizontal coordinate if obtained; returns -1 if the value of line is invalid.
    
    从以下版本开始:
    
    3
  - getLineEnd
```
@Deprecated
public float getLineEnd(int line)
```
    已过时。
    
    Obtains the horizontal coordinate of the end of a specified line.
    
    参数:
    
    line - Indicates the specified line.
    
    返回:
    
    Returns the horizontal coordinate if obtained; returns -1 if the value of line is invalid.
    
    从以下版本开始:
    
    3
  - getTextWidth
```
@Deprecated
public float getTextWidth(int line)
```
    已过时。
    
    Obtains the text width of a specified line, including the leading margin indent but excluding the trailing whitespace.
    
    参数:
    
    line - Indicates the specified line.
    
    返回:
    
    Returns the text width if obtained; returns -1 if the value of line is invalid.
    
    从以下版本开始:
    
    3
  - getLimitWidth
```
@Deprecated
public int getLimitWidth(int line)
```
    已过时。
    
    Obtains the text width of a specified line, including the leading margin indent and trailing whitespace.
    
    参数:
    
    line - Indicates the specified line.
    
    返回:
    
    Returns the text width if obtained; returns -1 if the value of line is invalid.
    
    从以下版本开始:
    
    3
  - getCharIndexByCoordinate
```
@Deprecated
public int getCharIndexByCoordinate(int line,
                                    float horizCoordinate)
```
    已过时。
    
    Obtains the index of the character that is closest to the given horizontal coordinate in a specified line.
    
    参数:
    
    line - Indicates the specified line.
    
    horizCoordinate - Indicates the given horizontal position.
    
    返回:
    
    Returns the character index if obtained; returns -1 if the value of line is invalid.
    
    从以下版本开始:
    
    3
  - getCoordinateInSecondDir
```
@Deprecated
public float getCoordinateInSecondDir(int offset)
```
    已过时。
    
    Obtains the secondary horizontal position of a specified text offset. It is where a new character will be inserted in the direction other than the paragraph's primary direction.
    
    参数:
    
    offset - Indicates the text offset.
    
    返回:
    
    Returns the secondary horizontal position of the specified text offset.
    
    从以下版本开始:
    
    3
  - getCoordinateInMainDir
```
@Deprecated
public float getCoordinateInMainDir(int offset)
```
    已过时。
    
    Obtains the primary horizontal position of a specified text offset. It is where a new character will be inserted in the paragraph's primary direction.
    
    参数:
    
    offset - Indicates the text offset.
    
    返回:
    
    Returns the primary horizontal position of the specified text offset.
    
    从以下版本开始:
    
    3
  - getNumOfFontHeight
```
@Deprecated
public float getNumOfFontHeight()
```
    已过时。
    
    Obtains the value for multiline text spacing.
    
    返回:
    
    Returns the value for multiple text spacing.
    
    从以下版本开始:
    
    3
  - getCoordinateForVertical
```
@Deprecated
public float getCoordinateForVertical(int point)
```
    已过时。
    
    Obtains the position of the vertical coordinate where a specified indexed character is located.
    
    参数:
    
    point - Indicates the index of the character.
    
    返回:
    
    Returns the position of the vertical coordinate if obtained; returns -1 if the value of point is invalid.
    
    从以下版本开始:
    
    3
  - getLineIndexByCoordinate
```
@Deprecated
public int getLineIndexByCoordinate(int verticalCoordinate)
```
    已过时。
    
    Obtains the index of the line that is located at a specified vertical coordinate.
    
    参数:
    
    verticalCoordinate - Indicates the vertical coordinate.
    
    返回:
    
    Returns the line index if obtained; returns -1 if the value of verticalCoordinate is invalid.
    
    从以下版本开始:
    
    3

类 Layout

字段概要

构造器概要

方法概要

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

字段详细资料

mNativeLayoutHandle

构造器详细资料

Layout

方法详细资料

drawText

drawHighlight

getWidth

getHeight

getAscent

getDescent

getBaseline

getTop

getBottom

getLineCount

getBeginCharIndex

getEndCharIndex

getLineIndexByCharIndex

getLineStart

getLineEnd

getTextWidth

getLimitWidth

getCharIndexByCoordinate

getCoordinateInSecondDir

getCoordinateInMainDir

getNumOfFontHeight

getCoordinateForVertical

getLineIndexByCoordinate