TextInput  - AS3 Flex

指定是否应删除包含 HTML 文本的 TextInput 控件中的额外空白（空格、换行符等）。

condenseWhite 属性仅会对使用 htmlText 属性设置的文本产生影响，而不会对使用 text 属性设置的文本产生影响。如果使用 text 属性设置文本，则忽略 condenseWhite。

如果将 condenseWhite 属性设置为 true，您必须使用标准 HTML 命令（如 <br> 和 <p>）在文本字段中放置换行符。

默认值为 false;。

此属性可用作数据绑定的源。修改此属性后，将调度 condenseWhiteChanged 事件。

用于在项呈示器或项目编辑器中使用组件时将值传递给该组件。您通常使用数据绑定将 data 属性的字段绑定到此组件的某个属性。

将控件用作嵌入式项呈示器或嵌入式项目编辑器时，Flex 自动将项目的当前值写入此控件的 text 属性。

不要以 MXML 方式设置此属性。

默认值为 null。

此属性可用作数据绑定的源。修改此属性后，将调度 dataChange 事件。

相关 API 元素

指示此控件是否用于输入密码。如果值 true，则该字段将不显示输入的文本，输入到该控件中的每个文本字符都将显示为字符“*”。

默认值为 false。

此属性可用作数据绑定的源。修改此属性后，将调度 displayAsPasswordChanged 事件。

指示用户是否可以编辑此控件中的文本。如果值为 true，则表示用户可以编辑文本。

此属性可用作数据绑定的源。修改此属性后，将调度 editableChanged 事件。

一个标志，用于指示当组件获得焦点时是否应启用 IME。

为此组件提供字体上下文的模块工厂。

当前显示的最左端像素的内容区域中的像素位置。（内容区域包括控件的所有内容，不是仅包括当前显示的部分。）该属性始终设置为 0，并且如果将 wordWrap 设置为 true，将忽略更改。

此属性可用作数据绑定的源。修改此属性后，将调度 horizontalScrollPositionChanged 事件。

指定 TextInput 控件显示的文本，包括用于表示文本样式的 HTML 标记。在此属性中指定 HTML 文本时，可以使用 Flash TextField 控件支持的 HTML 标记子集。

设置此属性时，会在应用 TextInput 实例的 CSS 样式后应用 HTML 标记。获取此属性时，HTML 标记包括 CSS 样式。

例如，如果将此属性设置为 "This is an example of <b>bold</b> markup" 之类的字符串，则文本“This is an example of bold markup”将以通常应用的 CSS 样式在 TextInput 中进行显示。此外，由于存在 <b> 标记，“bold”一词将显示为粗体。

HTML 标记使用 < and > 等字符，这些字符在 XML 中具有特殊意义（在 MXML 中也同样如此）。所以，以下代码不能编译：

      <mx:TextInput htmlText="This is an example of <b>bold</b> markup"/>
      

有三种方法可以解决此问题。

• 在作为 initialize 处理函数调用的 ActionScript 方法中设置 htmlText 属性：

        <mx:TextInput id="myTextInput" initialize="myTextInput_initialize()"/>
        

  其中 myTextInput_initialize 方法位于脚本 CDATA 节：

        <fx:Script>
        <![CDATA[
        private function myTextInput_initialize():void {
            myTextInput.htmlText = "This is an example of <b>bold</b> markup";
        }
        ]]>
        </fx:Script>
        
        

  由于 HTML 标记依然简单易读，因此这是最简单的方法。请注意，必须为 TextInput 分配 id，以便在 initialize 处理函数中引用它。

• 使用带有 CDATA 节的子标签指定 htmlText 属性。XML 中的 CDATA 节包含字符数据，其中 < 和 > 等字符不具有特殊意义。

        <mx:TextInput>
            <mx:htmlText><![CDATA[This is an example of <b>bold</b> markup]]></mx:htmlText>
        <mx:TextInput/>
        

  您必须将 htmlText 属性编写为子标签，而不是 <mx:TextInput> 标签上的某一属性，因为 XML 不允许属性值中含有 CDATA。请注意，该标记可读性依然很好，但由于涉及到 CDATA 节，该方法比较复杂。

• 使用 hmtlText 属性，其中只要是 HTML 标记字符 < 和 >，在属性值中就会显示为 XML“实体”< 和 >：

        <mx:TextInput htmlText="This is an example of <b>bold</b> markup"/>
        

  由于使用此方法时 HTML 标记的可读性很差，因此 Adobe 不建议使用此方法。

设置 htmlText 属性时，如果 condenseWhite 属性为 true，将压缩多个空白字符（与基于 HTML 的浏览器中的情况类似），例如，三个连续的空格显示为一个空格。condenseWhite 的默认值为 false，因此，若要压缩空白字符，必须将 condenseWhite 设置为 true。

如果设置 htmlText 属性后立即重新读取该属性，将会看到设置的字符串。但是，如果 LayoutManager 开始运行，该值将发生更改，以包括包含 CSS 样式的其他标记。

设置 htmlText 属性将影响 text 属性的多个方面。如果设置 htmlText 属性后立即读取 text 属性，则您将收到 null，这表明尚未确定与新的 htmlText 相对应的 text。但是，如果 LayoutManager 开始运行，则 text 属性值将更改为删除了所有 HTML 标记的 htmlText 字符串，即此值为 TextInput 实际显示的字符。

反之，如果设置 text 属性，则先前设置的任何 htmlText 都将是不相关的。如果设置 text 属性后立即读取 htmlText 属性，则您将收到 null，这表明尚未确定与新的 text 相对应的 htmlText。但是，如果 LayoutManager 开始运行，htmlText 属性值更改为新的文本以及 CSS 样式的 HTML 标记。

要使 LayoutManager 立即运行，您可以调用 TextInput 的 validateNow() 方法。例如，您可以设置一些 htmlText，调用 validateNow() 方法，然后立即获得相应的不包含 HTML 标记的 text。

如果在 ActionScript 中设置 text 和 htmlText 两种属性，则最后设置的属性会生效。切勿在 MXML 中同时设置这两种属性，因为 MXML 不保证能够以特定顺序对实例的属性进行设置。

在某个循环内设置 text 或 htmlText 属性的操作完成得很快，因为实际呈示文本的基础 TextField 在 LayoutManager 运行后才更新。

如果尝试将此属性设置为 null，则该属性将设置为空字符串。如果属性值暂时为 null，则表明刚刚设置了 text，但尚未确定相应的 htmlText。

默认值为 ""。

此属性可用作数据绑定的源。修改此属性后，将调度 htmlTextChanged 事件。

相关 API 元素

指定 IME（输入法编辑器）模式。IME 使用户能够用中文、日文和韩文输入文本。当控件获得焦点时，Flex 设置指定的 IME 模式；当该控件失去焦点时，则将其设置回为先前的值。

flash.system.IMEConversionMode 类定义此属性的有效值的常量。您还可以指定 null 不指定任何 IME 模式。

默认值为 null。

相关 API 元素

TextArea 中显示的文本的字符数。

默认值为 0。

使用组件作为嵌入式项呈示器或嵌入式项目编辑器时，Flex 将使用 list 控件中的相应数据初始化该组件的 listData 属性。然后，组件可使用 listData 属性初始化嵌入式项呈示器或嵌入式项目编辑器的 data 属性。

您无需在 MXML 或 ActionScript 中设置此属性；将组件用作嵌入式项呈示器或嵌入式项目编辑器时，Flex 会对其进行设置。

默认值为 null。

此属性可用作数据绑定的源。修改此属性后，将调度 dataChange 事件。

相关 API 元素

用户可以在文本字段中输入的最大字符数。此属性对通过设置控件的 text 或 htmlText 属性指定的文本的长度没有限制。

默认值为 0，这是一种特殊情况，表示字符数不受限制。

此属性可用作数据绑定的源。修改此属性后，将调度 maxCharsChanged 事件。

如果为 true，则对此控件的 drawFocus() 方法的调用会转到其父项的 drawFocus() 方法上。这用于当 TextInput 为复合控件（如 NumericStepper 或 ComboBox）的一部分时。

指示用户可以输入到控件的字符集。如果 restrict 属性的值为 null，则可以输入任何字符。如果 restrict 属性的值为空字符串，则不能输入任何字符。此属性只限制用户交互；脚本可以将任何文本放入文本字段中。如果 restrict 属性的值为字符串，则只能在文本字段中输入该字符串中的字符。

Flex 按从左到右的顺序浏览字符串。可以使用连字符 (-) 指定一个范围。如果字符串以尖号 (^) 开头，则先接受所有字符，然后从接受字符集中排除字符串中 ^ 之后的字符。如果字符串不以尖号 (^) 开头，则最初不接受任何字符，然后将字符串中的字符包括在接受字符集中。

由于某些字符在 restrict 属性中使用时具有特殊的意义，因此必须使用反斜杠字符指定文本字符 -、^ 和 \。将 restrict 属性用作 MXML 标签中的属性时，请使用单一反斜杠，如下例所示：\^\-\\。当您在 ActionScript 表达式中设置 restrict 时，请使用两个反斜杠，如下例所示：\\^\\-\\\。

此属性可用作数据绑定的源。修改此属性后，将调度 restrictChanged 事件。

一个标志，指示是否可以选择 TextInput 中的文本。

当前所选内容中最后一个字符后的位置从零开始的索引（与最后一个字符的从一开始的索引相等）。例如，如果所选内容中的最后一个字符是第五个字符，则此属性的值为 5。当控件获得焦点时，如果已经设置 selectionAnchorIndex 和 selectionActiveIndex 这两种属性，则将能够看到选定内容。

当前所选内容中第一个字符从零开始的字符索引值。例如，第一个字符的索引值是 0，第二个字符的索引值是 1，依此类推。当控件获得焦点时，如果已经设置 selectionAnchorIndex 和 selectionActiveIndex 这两种属性，则将能够看到选定内容。

当前所选内容中第一个字符从零开始的字符索引值。例如，第一个字符的索引值是 0，第二个字符的索引值是 1，依此类推。当控件获得焦点时，如果已经设置了 selectionBeginIndex 和 selectionEndIndex 这两种属性，则将能够看到所选内容。

默认值为 0。

当前所选内容中最后一个字符后的位置从零开始的索引（与最后一个字符的从一开始的索引相等）。例如，如果所选内容中的最后一个字符是第五个字符，则此属性的值为 5。当控件获得焦点时，如果已经设置了 selectionBeginIndex 和 selectionEndIndex 这两种属性，则将能够看到所选内容。

默认值为 0。

控件中出现的纯文本。其外观由此 Lable 控件的 CSS 样式确定。

文本字符串中的任何 HTML 标签都将被忽略，其显示效果就像以字符串形式输入的一样。要显示使用 HTML 标签进行格式设置的文本，请改用 htmlText 属性。如果设置了 htmlText 属性，则 HTML 将替换使用此属性设置的所有文本，并且 text 属性将返回 HTML 文本的纯文本版本，而从中去除了所有 HTML 标签。有关详细信息，请参阅 htmlText 属性。

要在文本中包括特殊字符左尖括号 (<)、右尖括号 (>) 或和号 (&)，请将文本字符串包含在 CDATA 标签中。此外，您可以使用 HTML 字符实体表示特殊字符，例如 <。

如果尝试将此属性设置为 null，则该属性将设置为空字符串。text 属性可暂时使用值 null，此值表示刚刚设置了 htmlText 值，但相应的 text 值尚未确定。

此属性可用作数据绑定的源。修改此属性后，将调度 textChanged 事件。

呈示此 TextInput 文本的内部 UITextField。

文本高度。

只有在组件经过验证后，textHeight 属性的值才是正确的。如果您在设置 text 后立即请求 textHeight，则接收到的值可能不正确。您应等待组件经过验证或调用 validateNow() 方法后，再获取此值。此行为与 flash.text.TextField 控件有所不同，后者会立即更新此值。

相关 API 元素