包	spark.components
类	public class TextArea
继承	TextArea SkinnableTextBase SkinnableComponent UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object

语言版本:

ActionScript 3.0

产品版本:

Flex 4

运行时版本:

Flash Player 10, AIR 1.5

TextArea 是一个文本输入控件，让用户输入和编辑多行格式化文本。 Spark 主题的外观使用 RichEditableText 类。这意味着，Spark TextArea 控件支持基于 Flash 文本引擎 (FTE) 的 Text Layout Framework (TLF) 库。 组合后，可以在这些层上使用高质量的国际印刷效果和布局编辑文本。外观包括一个可以显示水平滚动条和垂直滚动条（用于滚动文本）的 Scroller，并支持使用鼠标滚轮垂直滚动。可以通过 textDisplay 形式访问 RichEditableText，通过 scroller 形式访问 Scroller。

Mobile 主题的外观使用 StyleableStageText 类。 由于 StyleableStageText 使用本机文本字段，它可以在移动设备上实现更好的文本输入和操作体验，但您应该注意它有一些 限制和差异 。由于 StageText 不能度量文本，必须对 TextArea 给出显式、百分比形式或基于约束的 width 和 height 。StyleableStageText 可以作为 textDisplay 访问。如果您希望使用基于 TextField 的外观而不是基于 StageText 的外观，请将 skinClass 属性设置为 “spark.skins.mobile.TextAreaSkin” 。

可以使用 text 属性设置要显示的文本或获取用户已输入的文本。

使用 CSS 样式（例如 fontFamily 和 fontSize ）设置文本格式。

对于 Spark 主题，可以通过 widthInChars 和 heightInLines 属性以随字体大小缩放的方式指定 TextArea 的宽度和高度，也可以使用 typicalText 属性。请注意，如果使用 typicalText ，则 widthInChars 和 heightInLines 属性将被忽略。对于所有主题，您也可以指定一个显式宽度或高度（以像素为单位），或者使用宽度和高度的百分比形式或约束，例如 left 和 right 或者 top 和 bottom 。

可以使用 maxChars 属性限制用户可以输入的字符数，使用 restrict 限制用户可以输入的字符。要使用该控件输入密码，请将 displayAsPassword 属性设置为 true 。

对于 Mobile 主题，特定于软键盘的属性 autoCapitalize 、 autoCorrect 、 returnKeyLabel 和 softKeyboardType 属性指定键盘提示。如果软键盘存在但它不支持提示表示的功能，则提示被忽略。在只有硬件键盘的移动环境中，这些提示将被忽略。 Spark 主题的文本区域

Spark TextArea 控件和 MX TextArea 控件之间的最重要区别如下所示：

Spark TextArea 可提供更佳的印刷效果和文本布局，且能更好地支持各国语言。

Spark TextArea 有面向对象模型的富文本，但 MX 版本却没有。

在显示大量文本时，Spark TextArea 性能表现得更好。

Spark TextArea 嵌入字体的方式与 MX 版本不同。要了解如何在嵌入字体时使用 embedAsCFF 属性，请参阅“字体”文档。

Spark TextArea 控件使用 TLF 面向对象模型的富文本，其中，诸如分段、段落、范围、超链接和图像等文本布局元素在运行时由 ActionScript 对象表示。可以通过编程方式访问或操纵这些对象。TLF 中用于表示富文本的中心对象是 TextFlow。通过将 TextArea 控件的 textFlow 属性设置为 TextFlow 实例，来指定该控件的富文本。

如果不需要显示含有多种格式的文本，请将 TextArea 的 text 属性设置为纯文本字符串。有关 text 属性和 textFlow 属性如何进行交互（例如，可以设置一个属性，然后获取另一个属性）的信息，请参阅这两个属性的描述。

编译时，可以将 TLF 标记标签放在 TextArea 标签内，如下例所示： <s:TextArea>Hello <s:span fontWeight="bold">World!</s:span></s:TextArea> 在此示例中，MXML 编译器设置了 TextArea content 属性，从而导致基于所指定的 FlowElement 创建 TextFlow 对象。

TextArea 控件不包含任何用于更改文本格式的用户界面，但是包含可以用于以编程方式设置文本格式的 API。例如，可以创建一个按钮，当单击该按钮时，选定文本可变为粗体。

默认文本格式由 CSS 样式确定，例如 fontFamily 和 fontSize 。TextFlow 对象中的任何格式信息都会覆盖 CSS 样式确定的默认格式。

可以使用样式控制 TextArea 内容的许多特征。以下是一些常用示例：

使用 lineHeight 样式控制行间距。

使用 paragraphSpaceBefore 和 paragraphSpaceAfter 样式控制段间距。

使用 textAlign 和 textAlignLast 样式将文本对齐或两端对齐。

使用 paddingLeft 、 paddingTop 、 paddingRight 和 paddingBottom 样式从控件的边框插入文本。

默认情况下，文本在控件的右边缘换行。如果文本超出了 TextArea 范围，会自动显示垂直滚动条。如果将 lineBreak 样式设置为 explicit ，则仅在显式换行符处开始新行。如果在 text 中使用 CR ( \r )、LF ( \n ) 或 CR+LF ( \r\n )，或者在 TLF 标记中使用 <p> 和 <br/> ，也会产生相同的效果。在这些情况下，如果任何文本行宽于控件，都会自动显示水平滚动条。

Spark TextArea 可以显示从左到右 (LTR) 书写的文本（如法语）、从右到左 (RTL) 书写的文本（如阿拉伯语）以及双向书写的文本（如阿拉伯语语句中的法语语句）。如果文本的主要书写方向为从右到左，请将 direction 样式设置为 rtl 。 textAlign 样式默认为 start ，这样，当 direction 为 ltr 时，文本左对齐；当 direction 为 rtl 时，文本右对齐。要获得反向对齐，请将 textAlign 设置为 end 。

Spark TextArea 还支持在一个编辑会话内执行无限次撤消/重做操作。编辑会话在控件获得键盘焦点时启动，在控件失去焦点时结束。

要在基于列表的组件（如 List 或 DataGrid）中使用此组件，请创建项呈示器。有关创建项呈示器的信息，请参阅 自定义 Spark 项呈示器 。

对于 Spark 主题，TextArea 控件具有以下默认特性：

特征	说明
默认大小	188 个像素宽 × 149 个像素高
最小大小	36 个像素宽 × 36 个像素高
最大大小	10000 个像素宽 × 10000 个像素高
默认外观类	spark.skins.spark.TextAreaSkin

对于 Mobile 主题，TextArea 控件具有以下默认特性：

特征	说明
默认外观类	spark.skins.mobile.StageTextAreaSkin

MXML 语法 显示 MXML 语法
隐藏 MXML 语法

默认 MXML 属性 content

查看示例

相关 API 元素

---

content

属性

content: Object

语言版本:

ActionScript 3.0

产品版本:

Flex 4

运行时版本:

Flash Player 10, AIR 1.5

该属性旨在编译时用于 MXML；在运行时获得或设置富文本内容并改用 textFlow 属性。Adobe 建议运行时使用 textFlow 属性获得或设置富文本内容，因为它是 TextFlow（而不是 Object）的强类型。在 Text Layout Framework 中，TextFlow 是富文本内容的规范表示。

content 属性是 TextArea 的默认属性，因此可以编写 MXML，如以下示例所示： <s:TextArea>Hello <s:span fontWeight="bold">World</s:span></s:TextArea> 在此示例中，指定为内容的 String 和 SpanElement 用于创建 TextFlow。

该属性的类型为 Object，因为可以将其设置为 String、FlowElement 或 String 和 FlowElement 的 Array。在上述示例中，内容为二元数组。第一个数组元素是字符串“Hello”。第二个数组元素是含有粗体文本“World”的 SpanElement 对象。

无论指定内容的方式为何，内容都会转换为 TextFlow 对象。当获得该属性的值时，即获得生成的 TextFlow 对象。

对于 Mobile 主题，它不受支持。

实现
public function get content(): Object
public function set content(value: Object ): void

heightInLines

属性

heightInLines: Number

语言版本:

ActionScript 3.0

产品版本:

Flex 4

运行时版本:

Flash Player 10, AIR 1.5

控件的默认高度（以行为单位测量）。

有关 Spark 主题，请参阅 spark.components.RichEditableText.heightInLines 。

对于 Mobile 主题，它不受支持。

默认值为 NaN。

实现
public function get heightInLines(): Number
public function set heightInLines(value: Number ): void

相关 API 元素

spark.components.RichEditableText.heightInLines

textFlow

属性

textFlow: flashx.textLayout.elements:TextFlow

语言版本:

ActionScript 3.0

产品版本:

Flex 4

运行时版本:

Flash Player 10, AIR 1.5

用于表示该组件显示的富文本的 TextFlow。

有关 Spark 主题，请参阅 spark.components.RichEditableText.textFlow 。

对于 Mobile 主题，它不受支持。

默认值为 null。

实现
public function get textFlow(): flashx.textLayout.elements:TextFlow
public function set textFlow(value: flashx.textLayout.elements:TextFlow ): void

相关 API 元素

spark.components.RichEditableText.textFlow

widthInChars

属性

widthInChars: Number

语言版本:

ActionScript 3.0

产品版本:

Flex 4

运行时版本:

Flash Player 10, AIR 1.5

控件的默认宽度（使用 em 单位测量）。

有关 Spark 主题，请参阅 spark.components.RichEditableText.widthInChars 。

对于 Mobile 主题，它不受支持。

默认值为 NaN。

实现
public function get widthInChars(): Number
public function set widthInChars(value: Number ): void

相关 API 元素

spark.components.RichEditableText.widthInChars

TextArea

()

构造函数

public function TextArea()

语言版本:

ActionScript 3.0

产品版本:

Flex 4

运行时版本:

Flash Player 10, AIR 1.5

构造函数。

getFormatOfRange

()

方法

public function getFormatOfRange(requestedFormats: Vector .< String > = null, anchorPosition: int = -1, activePosition: int = -1): flashx.textLayout.formats:TextLayoutFormat

语言版本:

ActionScript 3.0

产品版本:

Flex 4

运行时版本:

Flash Player 10, AIR 1.5

返回 TextLayoutFormat 对象，用于为指定范围的字符指定计算格式。

如果格式在整个范围上设置不一致，则其值将为 undefined 。

可以为包含所需格式名称的 String 指定 Vector；如果不指定，将计算所有格式。

如果不指定范围，则将使用选定范围。

参数

	requestedFormats : Vector .< String > (default = null ) — String 的 Vector（用于指定所请求格式的名称），或 null （用于请求所有格式）。
	anchorPosition : int (default = -1 ) — 一个字符位置，用于指定所选内容的固定末尾。
	activePosition : int (default = -1 ) — 一个字符位置，用于指定所选内容的可移动末尾。

返回

flashx.textLayout.formats:TextLayoutFormat — TextLayoutFormat 对象。

scrollToRange

()

方法

public function scrollToRange(anchorPosition: int = 0, activePosition: int ): void

语言版本:

ActionScript 3.0

产品版本:

Flex 4

运行时版本:

Flash Player 10, AIR 1.5

允许滚动，使文本范围在容器中可见。

参数

	anchorPosition : int (default = 0 ) — 当您扩展选择时随之改变的所选内容的末尾。可以是所选内容的开始或末尾，表示为距文本流起始位置的偏移。
	activePosition : int (default = NaN ) — 当扩展选择时所选内容的固定末尾。可以是所选内容的起始或末尾。

setFormatOfRange

()

方法

public function setFormatOfRange(format: flashx.textLayout.formats:TextLayoutFormat , anchorPosition: int = -1, activePosition: int = -1): void

语言版本:

ActionScript 3.0

产品版本:

Flex 4

运行时版本:

Flash Player 10, AIR 1.5

将指定的格式应用于指定范围中的每个元素，以与所给定的格式相对应。将字符格式应用于指定范围中的文本（如果指定的范围为单个点，则不进行任何更改）。将段落格式应用于至少部分在该范围内的任何段落（如果范围为单个点，则应用于单个段落）。将容器格式应用于容器。

支持的格式是 TextLayoutFormat 中的那些格式。不应用 undefined 值。如果不指定范围，则将使用选定范围。

下面的示例设置所选项目的 fontSize 和 color ： var textLayoutFormat:TextLayoutFormat = new TextLayoutFormat(); textLayoutFormat.fontSize = 12; textLayoutFormat.color = 0xFF0000; myRET.setFormatOfRange(textLayoutFormat);

如果您使用 getFormatOfRange() 的结果来指定 format ，请注意， TextLayoutFormat 中的每个格式都具有一个计算值，该计算值将应用于与给定格式相对应的每个元素。

如果您希望指定一个要应用于所有文本的格式，最好对组件本身使用 setStyle(format, value) 。

下面的示例设置所有文本的 fontSize 和 color ： myRET.setStyle("fontSize", 12); myRET.setStyle("color", 0xFF0000);

参数

	format : flashx.textLayout.formats:TextLayoutFormat — 要应用到选区的 TextLayoutFormat。
	anchorPosition : int (default = -1 ) — 相对于 text 字符串开头的字符位置，用于指定用箭头键扩展选区时该选区保持固定的终点。
	activePosition : int (default = -1 ) — 相对于 text 字符串开头的字符位置，用于指定用箭头键扩展选区时该选区的终点。

TextAreaExample.mxml

<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the Spark TextArea control. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
        xmlns:s="library://ns.adobe.com/flex/spark">
    <s:layout>
        <s:BasicLayout />
    </s:layout>
    <s:Panel title="Spark TextArea Control Example"
            horizontalCenter="0"
            verticalCenter="0">
        <s:VGroup left="10" right="10" top="10" bottom="10">
            <s:TextArea width="400" height="100">
                <s:text>This is a multiline, editable Spark TextArea control. If you need a non-editable multiline control, use the Text control.</s:text>
            </s:TextArea>
            <s:TextArea width="400" height="100">
                <s:content>This is <s:span color="#FF0000">HTML text</s:span>
                    in an <s:span fontWeight="bold">Spark TextArea control</s:span>.
                    Use the <s:span textDecoration="underline">content</s:span> property
                    of the <s:span color="#008800">Spark TextArea control</s:span> 
                    to include basic HTML markup in your text, including
                    <s:a href="http://www.adobe.com" target="_blank">links</s:a>.</s:content>
            </s:TextArea>
        </s:VGroup>
    </s:Panel>
</s:Application>

---