鸿蒙OS Text

Text

java.lang.Object

|—ohos.agp.components.Component

|—|—ohos.agp.components.Text

public class Text
extends Component

显示组件中的文本。

文本是基本的 UI 元素。

Since:

3

嵌套类摘要

字段摘要

构造函数摘要

方法总结

字段详细信息

AUTO_CURSOR_POSITION

public static final int AUTO_CURSOR_POSITION

表示光标所在的位置。

AUTO_SCROLLING_FOREVER

public static final int AUTO_SCROLLING_FOREVER

表示文本将始终处于自动滚动状态。

构造函数详细信息

Text

public Text(Context context)

默认构造函数用于使用默认属性集和样式创建 Text 实例。

参数：

Text

public Text(Context context, AttrSet attrSet)

用于在 XML 文件解析后使用指定的属性集和默认样式创建 Text 实例的构造函数。

参数：

Text

public Text(Context context, AttrSet attrSet, String styleName)

用于在 XML 文件解析后使用指定的属性集和指定的样式创建 Text 实例的构造函数。

参数：

方法详情

addTextObserver

public void addTextObserver(Text.TextObserver observer)

添加文本观察器 TextObserver 以检测文本是否更改。

在使用 TextObserver 之前，您必须实现 TextObserver#onTextUpdated。

参数：

removeTextObserver

public void removeTextObserver(Text.TextObserver observer)

删除文本观察者 TextObserver。

参数：

setEditorActionListener

public void setEditorActionListener(Text.EditorActionListener listener)

为组件中的编辑器操作注册一个侦听器。

参数：

setFont

public void setFont(Font font)

设置文本字体。

参数：

Throws:

getFont

public Font getFont()

获取文本字体。

返回:

返回文本字体。

setTruncationMode

public void setTruncationMode(Text.TruncationMode mode)

当文本内容长于组件宽度时设置截断模式。

当文本组件不能在一行中显示所有文本内容时，可以选择以下模式：（1）文本的开头、中间或结尾被截断，截断部分显示为省略号，（2 ) 文本将滚动显示完整内容或 (3) 直接截断，无需任何特殊处理。

参数：

getTruncationMode

public Text.TruncationMode getTruncationMode()

获取截断模式。

返回:

返回截断模式； 如果未设置模式，则返回 TruncationMode#NONE。

setInputMethodOption

public void setInputMethodOption(int option)

设置文本的输入法选项。

参数：

getInputMethodOption

public int getInputMethodOption()

获取文本的输入法选项。

返回:

返回文本的输入法选项。

setAutoFontSizeRule

public void setAutoFontSizeRule(int minFontSize, int maxFontSize, int autoFontStep)

设置自动字体大小的范围和步长。

最小字体大小必须小于最大字体大小，并且字体大小步长必须大于 0。

参数：

Throws:

setAutoFontSizeRule

public void setAutoFontSizeRule(int[] preSet)

设置所有可能的自动字体大小的数组。

参数：

getAutoFontSizeRule

public int[] getAutoFontSizeRule()

获取自动调整大小的规则。

返回:

返回规则。

Since:

7

isAutoFontSize

public boolean isAutoFontSize()

获取是否自动调整文本大小以填充在组件内。

返回:

如果自动调整文本大小以填充组件，则返回 true； 否则返回 false。

getMinAutoFontSize

public int getMinAutoFontSize()

获取自动调整大小所允许的最小文本大小。

返回:

如果获得，则返回最小文本大小（以像素为单位）； 如果未配置自动调整大小，则返回 0。

Since:

7

getMaxAutoFontSize

public int getMaxAutoFontSize()

获取自动调整大小允许的最大文本大小。

返回:

如果获得，则返回最大文本大小（以像素为单位）； 如果未配置自动调整大小，则返回 0。

Since:

7

getAutoFontSizeStep

public int getAutoFontSizeStep()

获取自动调整大小的步骤。

返回:

如果获得，则返回步骤； 如果未配置自动调整大小，则返回 0。

Since:

7

getTextHorizontalScale

public float getTextHorizontalScale()

获取此 Text 的水平乘数。

默认水平乘数为 1.0。

返回:

返回水平乘数。

Since:

7

setTextHorizontalScale

public void setTextHorizontalScale(float ratio)

设置此文本的水平乘数。

默认水平乘数为 1.0。

参数：

Since:

7

setTextWidth

public void setTextWidth(int width)

设置此文本的确切宽度。

设置此值会覆盖之前的最小或最大宽度配置。

参数：

Since:

7

setMinTextWidth

public void setMinTextWidth(int minWidth)

设置此文本的最小宽度。

参数：

Since:

7

getMinTextWidth

public int getMinTextWidth()

获取此 Text 的最小宽度。

返回:

返回此文本的最小宽度。

Since:

7

setAutoScrollingDuration

public void setAutoScrollingDuration(long duration)

设置长文本的自动滚动持续时间。

在启用自动滚动之前，您必须在文本上使用此方法。 自动滚动持续时间必须大于或等于 0，以毫秒为单位。 如果持续时间设置为 0，则使用默认滚动速度。

参数：

Throws:

getAutoScrollingDuration

public long getAutoScrollingDuration()

获取文本的自动滚动时长。

返回:

如果可用，则返回为此文本设置的自动滚动持续时间； 否则返回 0。

setAutoScrollingCount

public void setAutoScrollingCount(int count)

设置文本的自动滚动计数。

在启用自动滚动之前，您必须在文本上使用此方法。

参数：

Throws:

getAutoScrollingCount

public int getAutoScrollingCount()

获取文本的自动滚动次数。

返回:

返回文本的自动滚动计数。

startAutoScrolling

public void startAutoScrolling()

开始文本自动滚动。

stopAutoScrolling

public void stopAutoScrolling()

停止文本自动滚动。

setCursorElement

public void setCursorElement(Element element)

设置此 Text 中光标的 Element 对象。

参数：

setCursorElement

public void setCursorElement(int resId)

为文本中的光标设置元素对象。

参数：

Since:

7

setAutoCursorAdjustmentEnabled

public void setAutoCursorAdjustmentEnabled(boolean isAutoMove)

将光标设置为自动移动。

参数：

Since:

7

getCursorElement

public Element getCursorElement()

获取文本中光标的元素对象。

返回:

返回文本中光标的元素对象。

setAroundElements

public void setAroundElements(Element left, Element top, Element right, Element bottom)

围绕文本设置元素对象。

此方法将元素对象放置在文本的左侧、顶部、右侧和底部。 元素对象的边由文本的阅读方式决定。

注意：如果未设置元素的边界，则此方法将其设置为最佳尺寸。

参数：

getAroundElements

public Element[] getAroundElements()

获取文本周围的元素对象。

文本左侧、顶部、右侧和底部的元素对象按顺序返回。

返回:

返回文本周围的元素对象。

getLeftElement

public Element getLeftElement()

获取文本左侧的元素。

元素是指围绕文本的图形材料。

返回:

返回左侧元素。

Since:

4

getRightElement

public Element getRightElement()

获取文本右侧的元素。

元素是指围绕文本的图形材料。

返回:

返回正确的元素。

Since:

4

getTopElement

public Element getTopElement()

获取文本顶部的元素。

元素是指围绕文本的图形材料。

返回:

返回顶部元素。

Since:

4

getBottonElement

@Deprecated public Element getBottonElement()

已弃用。 此更改从 API 版本 8 开始生效。由 getBottomElement() 替换。

获取文本底部的元素。

元素是指围绕文本的图形材料。

返回:

返回底部元素。

Since:

4

getBottomElement

public Element getBottomElement()

获取文本底部的元素。

元素是指围绕文本的图形材料。

返回:

返回底部元素。

Since:

7

getStartElement

public Element getStartElement()

获取文本周围的起始元素。

元素是指围绕文本的图形材料。

返回:

返回起始元素。

Since:

4

getEndElement

public Element getEndElement()

获取文本周围的结束元素。

元素是指围绕文本的图形材料。

返回:

返回结束元素。

Since:

4

setAroundElementsRelative

public void setAroundElementsRelative(Element start, Element top, Element end, Element bottom)

围绕文本设置元素对象。

注意：如果未设置元素的边界，则此方法将其设置为最佳尺寸。

参数：

getAroundElementsRelative

public Element[] getAroundElementsRelative()

获取文本周围的元素对象。

文本开头、顶部、末尾和底部的元素对象按顺序返回。

返回:

返回文本周围的元素对象。

setAroundElementsPadding

public void setAroundElementsPadding(int padding)

设置文本和元素对象之间的填充。

参数：

Throws:

getAroundElementsPadding

public int getAroundElementsPadding()

获取文本和元素对象之间的填充。

返回:

返回文本和元素对象之间的填充。

setTextInputType

public void setTextInputType(int inputType)

设置 Text 的文本输入类型。

参数：

getTextInputType

public int getTextInputType()

获取Text的文本输入类型。

返回:

返回文本输入类型，如 InputAttribute 中所枚举。

setRichText

public void setRichText(RichText richText)

设置要在文本组件中显示的富文本。

文本组件可以显示富文本或普通文本。 最新配置生效。

参数：

Since:

3

getRichText

public RichText getRichText()

获取文本组件中显示的富文本。

返回:

返回文本组件中显示的富文本。

Since:

3

setText

public void setText(String text)

设置要在文本组件中显示的文本。

参数：

setText

public void setText(int resId)

设置要显示的文本的资源 ID。

参数：

Since:

3

getText

public String getText()

获取文本组件中显示的文本。

返回:

返回文本组件中显示的文本。

setHint

public void setHint(String hint)

设置文本为空时显示的提示文本。

参数：

setHint

public void setHint(int resId)

设置此 Text 为空时显示的提示文本。

参数：

Since:

7

getHint

public String getHint()

获取文本为空时显示的提示文本。

返回:

返回文本为空时要显示的提示文本。

getEditableString

public String getEditableString()

获取可编辑文本组件中的文本。 如果文本组件不可编辑，则返回 null。

返回:

返回可编辑文本组件中的文本。

Since:

4

isEditable

public boolean isEditable()

检查此文本是否可编辑。

返回:

如果文本是可编辑的，则返回 true； 否则返回 false。

Since:

7

setTextSize

public void setTextSize(int size)

为文本设置指定的字体大小。

参数：

Throws:

Since:

3

setTextSize

public void setTextSize(int size, Text.TextSizeType textSizeType)

为具有指定文本大小类型的文本组件设置文本大小。

参数：

Throws:

Since:

4

getTextSize

public int getTextSize()

获取文本组件的文本大小。

返回:

返回文本大小。

getTextSize

public int getTextSize(Text.TextSizeType textSizeType)

获取文本的字体大小。

参数：

返回:

返回字体大小。

Since:

4

setTextColor

public void setTextColor(Color color)

设置文本组件的文本颜色。

参数：

getTextColor

public Color getTextColor()

获取文本组件的文本颜色。

返回:

返回文本颜色。

setHintColor

public void setHintColor(Color color)

设置文本组件中提示文本的颜色。

参数：

Since:

4

getHintColor

public Color getHintColor()

获取文本组件中提示文本的颜色。

返回:

返回文本组件中提示文本的颜色。

Since:

4

setTextAlignment

public void setTextAlignment(int textAlignment)

设置文本组件中的文本对齐方式。

参数：

Throws:

getTextAlignment

public int getTextAlignment()

获取文本组件中的文本对齐方式。

返回:

返回文本对齐方式 TextAlignment。

setTextCursorVisible

public void setTextCursorVisible(boolean visible)

设置光标对于可编辑文本组件是否可见。

参数：

Since:

4

isTextCursorVisible

public boolean isTextCursorVisible()

获取光标对于可编辑文本组件是否可见。

返回:

如果光标对可编辑文本组件可见，则返回 true； 否则返回 false。

Since:

4

length

public int length()

获取文本组件中允许的文本长度。

返回:

返回文本组件中允许的文本长度。

append

public void append(String text)

将文本字符串附加到文本组件中的现有文本。

参数：

insert

public void insert(String text)

在光标所在位置插入文本。

参数：

Since:

2

insert

public void insert(String text, int pos)

在指定位置插入文本。 如果 pos 为 AUTO_CURSOR_POSITION，则将文本插入到光标所在的位置。

参数：

Since:

2

delete

public void delete(int length)

删除光标前的文本。

参数：

Since:

2

delete

public void delete(int length, boolean back)

删除光标之前或之后的文本。

参数：

Since:

2

delete

public void delete(int length, boolean back, int pos)

从指定位置删除文本。

参数：

Throws:

Since:

2

setMultipleLine

public void setMultipleLine(boolean multiple)

设置文本是否在文本组件中多行显示。

参数：

isMultipleLine

public boolean isMultipleLine()

获取文本是否在文本组件中多行显示。

返回:

如果文本以多行显示，则返回 true； 否则返回 false。

setMaxTextLines

public void setMaxTextLines(int maxLines)

设置文本组件中允许的最大行数。

参数：

Throws:

Since:

4

getMaxTextLines

public int getMaxTextLines()

获取文本组件中允许的最大行数。

返回:

返回文本组件中允许的最大行数。

Since:

4

setScrollable

public void setScrollable(boolean scrollable)

设置文本是否可滚动。

参数：

isScrollable

public boolean isScrollable()

获取文本在文本组件中是否可滚动。 true 表示文本是可滚动的； false 表示文本不可滚动。

返回:

如果文本是可滚动的，则返回 true； 否则返回 false。

setAutoFontSize

public void setAutoFontSize(boolean autoFontSize)

设置是否自动调整文本大小以填充组件。

参数：

setAutoFontSize

public void setAutoFontSize(boolean autoFontSize, boolean userSizeFirst)

设置是否自动调整字体大小以填充组件内，以及是否在启用自动字体大小适应之前尝试指定的字体大小。

建议您在启用 userSizeFirst 之前启用 autoFontSize。

参数：

Since:

3

setLineSpacing

public void setLineSpacing(float add, float mult)

设置文本组件的行距。

每条线的高度乘以 mult，并加上 add。 例如，当height为1，mult为2，add为3时，行距为5。

参数：

getNumOfFontHeight

public float getNumOfFontHeight()

获取行距乘数，它在文本组件中的行之间提供额外的间距。

返回:

返回行距乘数。

Since:

4

getAdditionalLineSpacing

public float getAdditionalLineSpacing()

获取添加到文本组件中每行高度的额外间距。

返回:

返回添加到每行高度的额外间距。

Since:

4

isAdjustInputPanel

public boolean isAdjustInputPanel()

获取在弹出输入法面板时是否开启自动文本组件重新布局。

返回:

如果启用了自动文本组件重新布局，则返回 true； 否则返回 false。

Since:

3

setAdjustInputPanel

public void setAdjustInputPanel(boolean adjust)

设置当软输入面板弹出或隐藏时布局是否应调整大小。

参数：

setMaxTextHeight

public void setMaxTextHeight(int maxTextHeight)

设置文本的最大高度。

此方法用于将文本高度设置为 MATCH_CONTENT 的情况。

参数：

Throws:

Since:

4

getMaxTextHeight

public int getMaxTextHeight()

获取文本的最大高度。

返回:

返回文本的最大高度。

Since:

4

setMinTextHeight

public void setMinTextHeight(int minHeight)

设置此文本的最小高度。

参数：

Since:

7

setMaxTextWidth

public void setMaxTextWidth(int maxTextWidth)

设置文本的最大宽度。

此方法用于将文本宽度设置为 MATCH_CONTENT 的情况。

参数：

Throws:

Since:

4

getMaxTextWidth

public int getMaxTextWidth()

获取文本的最大宽度。

返回:

返回文本的最大宽度。

Since:

4

onRtlChanged

protected void onRtlChanged(Component.LayoutDirection layoutDirection)

从类复制的描述：组件

在更改任何 RTL 属性时调用。

覆盖：

类组件中的 onRtlChanged

参数：

setBubbleSize

public void setBubbleSize(int width, int height)

设置显示文本的气泡框的宽度和高度。

参数：

Since:

4

setBubbleWidth

public void setBubbleWidth(int width)

设置文本气泡框的宽度。

参数：

Since:

4

setBubbleHeight

public void setBubbleHeight(int height)

设置文本气泡框的高度。

参数：

Since:

4

getBubbleWidth

public int getBubbleWidth()

获取文本气泡框的宽度。

返回:

返回气泡框的宽度。

Since:

4

getBubbleHeight

public int getBubbleHeight()

获取文本气泡框的高度。

返回:

返回气泡框的高度。

Since:

4

setLeftBubbleSize

public void setLeftBubbleSize(int width, int height)

设置显示文本的气泡框左侧填充区域的宽度和高度。

参数：

Since:

4

setLeftBubbleWidth

public void setLeftBubbleWidth(int width)

设置文本左侧气泡框的宽度。

参数：

Since:

4

setLeftBubbleHeight

public void setLeftBubbleHeight(int height)

设置文本左侧气泡框的高度。

参数：

Since:

4

getSelectionLeftBubbleWidth

public int getSelectionLeftBubbleWidth()

获取所选气泡框左侧填充区域的宽度。

返回:

返回宽度。

Since:

4

getSelectionLeftBubbleHeight

public int getSelectionLeftBubbleHeight()

获取所选气泡框左侧填充区域的高度。

返回:

返回高度。

Since:

4

setRightBubbleSize

public void setRightBubbleSize(int width, int height)

设置显示文本的气泡框右侧填充区域的宽度和高度。

参数：

Since:

4

setRightBubbleWidth

public void setRightBubbleWidth(int width)

设置文本右侧气泡框的宽度。

参数：

Since:

4

setRightBubbleHeight

public void setRightBubbleHeight(int height)

设置文本右侧气泡框的高度。

参数：

Since:

4

getSelectionRightBubbleWidth

public int getSelectionRightBubbleWidth()

获取所选气泡框右侧填充区域的宽度。

返回:

返回宽度。

Since:

4

getSelectionRightBubbleHeight

public int getSelectionRightBubbleHeight()

获取所选气泡框右侧填充区域的高度。

返回:

返回高度。

Since:

4

setSelectionColor

public void setSelectionColor(Color color)

设置选定文本的颜色。

参数：

Since:

4

getSelectionColor

public Color getSelectionColor()

获取选定文本的颜色。

返回:

返回所选文本的颜色。

Since:

4

getSelectionStart

public int getSelectionStart()

获取选择边的起点。

返回:

返回选择边缘的起点。

Since:

7

getSelectionEnd

public int getSelectionEnd()

获得选择边的结束。

返回:

返回选择边缘的结束。

Since:

7

setSelection

public boolean setSelection(int start, int end)

设置此文本的选择范围。

参数：

返回:

如果选择范围设置成功，则返回 true； 否则返回 false。

Since:

7

setBubbleElement

public void setBubbleElement(Element element)

为光标所在的气泡设置一个 Element 对象。

参数：

Since:

4

setBubbleElement

public void setBubbleElement(int resId)

为光标所在的气泡设置一个 Element 对象。

参数：

Since:

7

setSelectionLeftBubbleElement

public void setSelectionLeftBubbleElement(Element element)

设置要为左侧气泡显示的元素对象。

参数：

Since:

4

setSelectionLeftBubbleElement

public void setSelectionLeftBubbleElement(int resId)

设置要为左侧气泡显示的元素对象。

参数：

Since:

7

setSelectionRightBubbleElement

public void setSelectionRightBubbleElement(Element element)

设置要为右侧气泡显示的元素对象。

参数：

Since:

4

setSelectionRightBubbleElement

public void setSelectionRightBubbleElement(int resId)

设置要为右侧气泡显示的元素对象。

参数：

Since:

7

getBubbleElement

public Element getBubbleElement()

获取光标所在气泡框的Element对象。

返回:

返回元素对象。

Since:

4

getSelectionLeftBubbleElement

public Element getSelectionLeftBubbleElement()

获取显示在选中气泡框左侧内边距区域的 Element 对象。

返回:

返回元素对象。

Since:

4

getSelectionRightBubbleElement

public Element getSelectionRightBubbleElement()

获取显示在选中气泡框右侧内边距区域的 Element 对象。

返回:

返回元素对象。

Since:

4

setCursorPosition

public boolean setCursorPosition(int position)

设置文本的光标位置。

参数：

返回:

成功设置为 true，否则为 false。

Since:

7

setFadeEffectBoundaryWidth

public void setFadeEffectBoundaryWidth(int width)

设置文本的淡入淡出效果区域的边界宽度。

覆盖：

类 Component 中的 setFadeEffectBoundaryWidth

参数：

Since:

4

getFadeEffectBoundaryWidth

public int getFadeEffectBoundaryWidth()

获取文本淡化效果区域的边界宽度。

覆盖：

类 Component 中的 getFadeEffectBoundaryWidth

返回:

返回文本淡入淡出区域的边界宽度。

Since:

4

setPaddingForText

public void setPaddingForText(boolean hasPadding)

设置文本是否有额外的填充空间。

此方法仅对单行文本有效。

参数：

Since:

4

getPaddingForText

public boolean getPaddingForText()

检查文本是否有额外的填充空间。

返回:

如果文本的高度在上下边框之间，则返回 true； 如果高度在字体上升和下降之间，则返回 false。

Since:

4

getFontVariations

public String getFontVariations()

获取字体变化设置。

返回:

如果获得，则返回当前的字体变化设置； 如果未指定任何字符串，则返回一个空字符串。

Since:

5

setFontVariations

public boolean setFontVariations(String variation)

设置 TrueType 或 OpenType 字体变体设置。 设置字符串由多对标签和样式值组成。 标签必须包含精确的四个 ASCII 字符，并且必须用单引号或双引号括起来。 如果包含 U+0020..U+007E 以外的字符，则无效。 如果指定的标签名称尚未在字体中定义，则设置将被忽略。

下面显示了将字体宽度和粗细设置为 100 的示例代码。

    text.setFontVariations("'wdth' 100,'wght' 100");  

参数:

返回:

如果传递的变体对当前字体有效，则返回 true； 如果传递的变体是空字符串或不符合定义的规范，则返回 false。

Since:

5

getLineCount

public int getLineCount()

获取此文本中的行数。

返回:

返回行数。

Since:

7

getLineHeight

public int getLineHeight()

获取此 Text 的行间高度。

返回:

返回行之间的高度。

Since:

7

getCombinedPaddingStart

public int getCombinedPaddingStart()

获取此文本开头的组合填充。

如果文本以组件开头，则组合内边距包括组件的宽度和组件内边距。

返回:

返回文本开头的组合填充，以像素为单位。

Since:

7

getCombinedPaddingTop

public int getCombinedPaddingTop()

获取此文本顶部的组合填充。

如果文本顶部有组件，则组合的 padding 包括组件的高度和组件的 padding。

返回:

返回文本顶部的组合填充，以像素为单位。

Since:

7

getCombinedPaddingEnd

public int getCombinedPaddingEnd()

获取文本末尾的组合填充。

如果文本末尾有组件，则组合填充包括组件的宽度和组件填充。

返回:

返回文本末尾的组合填充，以像素为单位。

Since:

7

getCombinedPaddingBottom

public int getCombinedPaddingBottom()

获取此文本底部的组合填充。

如果文本底部有组件，则组合的 padding 包括组件的高度和组件的 padding。

返回:

返回文本底部的组合填充，以像素为单位。

Since:

7

getCombinedPaddingLeft

public int getCombinedPaddingLeft()

获取此文本左侧的组合填充。

如果文本左侧有组件，则合并的 padding 包括组件的宽度和组件的 padding。

返回:

返回文本左侧的组合填充，以像素为单位。

Since:

7

getCombinedPaddingRight

public int getCombinedPaddingRight()

获取此文本右侧的组合填充。

如果文本右侧有组件，则组合的 padding 包括组件的宽度和组件的 padding。

返回:

返回文本右侧的组合填充，以像素为单位。

Since:

7

getTextToTopSpace

public int getTextToTopSpace()

获取显示的文本顶部到文本组件顶部的距离。

返回:

返回从显示文本顶部到文本组件顶部的距离，以像素为单位。

Since:

7

getTextToBottomSpace

public int getTextToBottomSpace()

获取显示的文本底部到文本组件底部的距离。

返回:

返回从显示文本底部到文本组件底部的距离，以像素为单位。

Since:

7

setHyperLinkColor

public void setHyperLinkColor(Color color)

设置文本中链接的颜色。

参数：

Since:

7

setHyperLinkClickable

public void setHyperLinkClickable(boolean isClickable)

设置此文本中超链接的可点击性。

参数：

Since:

7

isHyperLinkClickable

public boolean isHyperLinkClickable()

检查此文本中的超链接是否可单击。

返回:

如果超链接是可点击的，则返回 true； 否则返回 false。

Since:

7

getUrls

public ListUrlRichStyle getUrls()

获取此文本中的超链接列表。

返回:

返回超链接列表。

Since:

7

getPrimaryLocale

public Locale getPrimaryLocale()

获取此文本的默认语言环境。

返回:

返回此文本的默认语言环境。

Since:

7

setPrimaryLocale

public void setPrimaryLocale(Locale locale)

设置用于绘制此文本的区域设置。

参数：

Throws:

Since:

7

getLocales

public LocaleProfile getLocales()

获取此 Text 的默认 LocaleProfile。

返回:

返回此文本的默认 LocaleProfile。

Since:

7

setLocales

public void setLocales(LocaleProfile locales)

设置用于绘制此文本的 LocaleProfile。

参数：

Throws:

Since:

7

getInputMethodLocales

public LocaleProfile getInputMethodLocales()

获取此文本的建议 LocaleProfile。

返回:

如果获得，则返回建议的 LocaleProfile； 如果没有配置建议的 LocaleProfile，则返回 null。

Since:

7

setInputMethodLocales

public void setInputMethodLocales(LocaleProfile locales)

为此文本设置建议的 LocaleProfile。

当此文本具有焦点时，建议的语言环境信息将报告给输入法。

参数：

Since:

7

getFontFeatures

public String getFontFeatures()

获取字体功能设置。

格式与 CSS font-feature-settings 属性的格式相同。

返回:

返回当前字体功能设置。

Since:

7

setFontFeatures

public void setFontFeatures(String settings)

设置字体特征。

格式与 CSS font-feature-settings 属性的格式相同。

参数：

Since:

7

getTextShadowColor

public Color getTextShadowColor()

获取文本阴影的颜色。

返回:

文本阴影的颜色。

Since:

7

setTextShadow

public void setTextShadow(float offsetX, float offsetY, float radius, Color color)

设置此文本的阴影。

参数：

Since:

7

getTextShadowOffsetX

public float getTextShadowOffsetX()

获取文本阴影的水平偏移量。

返回:

文字阴影的水平偏移。

Since:

7

getTextShadowOffsetY

public float getTextShadowOffsetY()

获取文本阴影的垂直偏移量。

返回:

文字阴影的垂直偏移。

Since:

7

getTextShadowRadius

public float getTextShadowRadius()

获取文本阴影的模糊半径。

返回:

文字阴影的模糊半径。

Since:

7

setHyphenationStrategy

public void setHyphenationStrategy(TextLayout.HyphenationStrategy strategy)

设置此文本的自动断字策略。

参数：

Since:

7

getHyphenationStrategy

public TextLayout.HyphenationStrategy getHyphenationStrategy()

获取该文本的自动断字策略。

返回:

返回自动断字的策略。

Since:

7

moveToPosition

public boolean moveToPosition(int offset)

根据指定的偏移量将字符移动到可见位置。

此方法用于滚动文本。 如果文本没有滚动，则返回 false。

参数：

返回:

如果文本滚动，则返回 true； 否则返回 false。

Since:

7

getLetterSpacing

public float getLetterSpacing()

获取文本字母之间的间距。

返回:

返回文本字母之间的间距。

Since:

7

getBaseLine

public int getBaseLine(int line)

获取目标线基线的 y 坐标。

参数：

返回:

返回目标线基线的 y 坐标。

Since:

7

getBoundingRect

public void getBoundingRect(int line, Rect bounding)

获取目标线的边界矩形。

参数：

Since:

7

getMinTextHeight

public int getMinTextHeight()

获取此 Text 的最小高度。

返回:

返回此文本的最小高度。

Since:

7

setMinTextLines

public void setMinTextLines(int minLines)

设置此文本的最小行数。

参数：

Since:

7

getMinTextLines

public int getMinTextLines()

获取此文本中的最小行数。

返回:

如果获得，则返回最小行数； 否则返回 -1。

Since:

7

getOffsetByCoordinates

public int getOffsetByCoordinates(float x, float y)

获取距离指定位置最近的字符偏移量。

参数：

返回:

返回最接近指定位置的字符偏移量。

Since:

7

getFontFamilyType

public Text.FontFamilyType getFontFamilyType()

获取此 Text 的字体系列类型。

返回:

返回此文本的字体系列类型。

Since:

7

setFontFamilyType

public void setFontFamilyType(Text.FontFamilyType type)

设置此文本的字体系列。

参数：

Since:

7

getMaxWidthInEms

public int getMaxWidthInEms()

获取此文本的最大宽度，以 em 为单位。

返回:

如果获得，则返回最大宽度（以 em 为单位）； 如果未配置最大宽度，则返回 -1。

Since:

7

getMinWidthInEms

public int getMinWidthInEms()

获取此文本的最小宽度，以 em 为单位。

返回:

如果获得，则返回最小宽度（以 em 为单位）； 如果未配置最小宽度，则返回 -1。

Since:

7

setTextWidthInEms

public void setTextWidthInEms(int ems)

设置此文本的宽度，以 em 为单位。

参数：

Since:

7

setMaxWidthInEms

public void setMaxWidthInEms(int maxEms)

设置此文本的最大宽度，以 em 为单位。

参数：

Since:

7

setMinWidthInEms

public void setMinWidthInEms(int minEms)

设置此文本的最小宽度，以 em 为单位。

参数：

Since:

7

getJustifyStrategy

public TextLayout.JustifyStrategy getJustifyStrategy()

获取文本对齐策略。

返回:

返回文本对齐策略。

Since:

7

setJustifyStrategy

public void setJustifyStrategy(TextLayout.JustifyStrategy strategy)

设置文本对齐策略。

参数：

Since:

7

setLetterSpacing

public void setLetterSpacing(float spacing)

设置文本字母之间的间距。

参数：

Since:

7

setLineHeight

public void setLineHeight(int lineHeight)

设置此文本的行之间的高度。

参数：

Since:

7

setTextHeight

public void setTextHeight(int pixels)

设置此文本的固定高度。

参数：

Since:

7

setLines

public void setLines(int lines)

设置此文本的行数。

参数：

Since:

7

getLineBreakStrategy

public TextLayout.LineBreakStrategy getLineBreakStrategy()

获取该文本的换行策略。

返回:

返回换行策略。

Since:

7

setLineBreakStrategy

public void setLineBreakStrategy(TextLayout.LineBreakStrategy strategy)

设置此文本的换行策略。

参数：

Since:

7

lockEditingState

public void lockEditingState()

锁定输入法并开始文本编辑。

Since:

7

unlockEditingState

public void unlockEditingState()

解锁输入法并结束文本编辑。

Since:

7

onLockEditingState

public void onLockEditingState()

当输入法被锁定时调用。

Since:

7

onUnlockEditingState

public void onUnlockEditingState()

当输入法解锁时调用。

Since:

7

isFocusedByTouch

public boolean isFocusedByTouch()

当你触摸它时检查这个文本是否有焦点。

返回:

如果此 Text 具有焦点，则返回 true； 否则返回 false。

Since:

7

isTextSelectable

public boolean isTextSelectable()

检查是否可以选择此文本。

返回:

如果可以选择文本，则返回 true； 否则返回 false。

Since:

7

adjustCursorPosition

public boolean adjustCursorPosition()

检查光标是否可以移动到可见位置。

返回:

如果光标可以移动到可见位置，则返回 true； 否则返回 false。

Since:

7

isAutoSelectEnabled

public boolean isAutoSelectEnabled()

获取文本获得焦点时是否选择所有文本。

返回:

如果文本获得焦点时将选择所有文本，则返回 true； 否则返回 false。

Since:

7

setAutoSelectEnabled

public void setAutoSelectEnabled(boolean isSelectAll)

设置 thisText 有焦点时是否选择所有文本。

参数：

Since:

7

setTextSelectable

public void setTextSelectable(boolean isSelectable)

设置此文本是否可选。

参数：

Since:

7

getInputFilters

public InputFilter[] getInputFilters()

获取输入过滤器列表。

返回:

返回输入过滤器列表。

Since:

7

setInputFilters

public void setInputFilters(InputFilter[] filters)

设置文本的输入过滤器列表。

参数：

Throws:

Since:

7

getEditorAction

public int getEditorAction()

获取编辑器动作。

返回:

返回编辑器操作。

Since:

7

getEditorActionText

public CharSequence getEditorActionText()

获取编辑器操作文本。

返回:

返回编辑器操作文本。

Since:

7

setEditorActionText

public void setEditorActionText(CharSequence text, int action)

设置编辑器操作文本。

当文本字段获得焦点时，该信息将报告给输入法。

参数：

Since:

7

setExtraInputData

public void setExtraInputData(PacMap data)

为此文本设置额外的输入数据。

当文本获得焦点时，会通过数据上报给输入法。

参数：

Since:

7

getCustomInputMethodOptions

public String getCustomInputMethodOptions()

获取自定义输入法选项。

返回:

返回自定义输入法选项。

Since:

7

setCustomInputMethodOptions

public void setCustomInputMethodOptions(String options)

设置此文本的自定义输入法选项。

如果文本连接到输入法，自定义输入法选项将被发送到输入法。

参数：

Since:

7

setTextConversion

public void setTextConversion(Text.ConversionType conversionType)

设置此文本的 ConversionType。

转换仅用于文本显示，不会改变文本内容。

参数：

Since:

7

getTextConversion

public Text.ConversionType getTextConversion()

获取此文本的 ConversionType。

默认转换类型为 ConversionType#NONE。

返回:

返回转换类型。

Since:

7

isAllUpperCase

public boolean isAllUpperCase()

检查应用于此文本的 ConversionType 是否设置为 ConversionType#ALL_UPPERCASE。

返回:

如果 ConversionType 设置为 ConversionType#ALL_UPPERCASE，则返回 true； 否则返回 false。

Since:

7

isInputMethodActive

public boolean isInputMethodActive()

检查此 Text 是否是当前输入法的目标。

返回:

如果文本是当前输入法的目标，则返回 true； 否则为 false。

Since:

7

onTextEditorAction

public boolean onTextEditorAction(int actionCode)

在处理指定编辑器操作的更改事件时调用。

参数：

返回:

如果事件被处理，则返回 true； 否则返回 false。

Since:

7

isSoftInputVisibleOnFocus

public boolean isSoftInputVisibleOnFocus()

检查当此文本获得焦点时软输入是否可见。

默认值是true。

返回:

如果软输入可见，则返回 true； 否则返回 false。

Since:

7

setSoftInputVisibleOnFocus

public void setSoftInputVisibleOnFocus(boolean isShow)

设置当此文本获得焦点时是否使软输入可见。

参数：

Since:

7

getEditingText

public boolean getEditingText(EditingCapability request, EditingText text)

获取可编辑的文本。

参数：

返回:

如果获取到可编辑文本，则返回 true； 否则返回 false。

Since:

7

setEditable

public void setEditable(boolean isEditable)

设置此文本的可编辑性。

参数：

Since:

7

getExtraInputData

public PacMap getExtraInputData(boolean isCreate)

获取发送到输入法的额外输入数据。

参数：

返回:

如果获得，则返回提供给输入法的 PacMap 对象； 否则返回 null。

Since:

7

onCustomInputMethodCommand

public boolean onCustomInputMethodCommand(String action, PacMap data)

由框架调用以响应来自输入法的自定义命令。

默认情况下，此方法不执行任何操作。

参数：

返回:

如果对命令执行操作，则返回 true； 否则返回 false。

Since:

7

setMaxCharacters

public void setMaxCharacters(int maxValue)

设置此文本的最大字符数。

参数：

Since:

7

isFallbackFontMetricsEnabled

public boolean isFallbackFontMetricsEnabled()

检查是否为后备字体启用了上升或下降指标。

默认值是true。

返回:

如果为后备字体启用上升或下降指标，则返回 true； 否则返回 false。

Since:

7

setFallbackFontMetricsEnabled

public void setFallbackFontMetricsEnabled(boolean isEnable)

设置是否为后备字体启用上升或下降指标。

参数：

Since:

7

setTextDirectionStrategy

public void setTextDirectionStrategy(BidiAnalyzer.BidiStrategy strategy)

设置文本方向策略。

参数：

Since:

7

getTextDirectionStrategy

public BidiAnalyzer.BidiStrategy getTextDirectionStrategy()

获取文本方向策略。

返回:

返回文本方向策略。

Since:

7