blob: e6c4d183b9c55329862b767f3d58c307dc8e31fd [file] [log] [blame]
{ "type": "class",
"qname": "mx.controls.TextInput",
"baseClassname": "mx.core.UIComponent"
,
"description": "The TextInput control is a single-line text field that is optionally editable. All text in this control must use the same styling unless it is HTML text. The TextInput control supports the HTML rendering capabilities of Flash Player and AIR. <p>TextInput controls do not include a label, although you can add one by using a Label control or by nesting the TextInput control in a FormItem control in a Form container. When used in a FormItem control, a TextInput control indicates whether a value is required. TextInput controls have a number of states, including filled, selected, disabled, and error. TextInput controls support formatting, validation, and keyboard equivalents; they also dispatch change and enter events.</p> <p>If you disable a TextInput control, it displays its contents in the color specified by the <code>disabledColor</code> style. To disallow editing the text, you set the <code>editable</code> property to <code>false</code>. To conceal the input text by displaying asterisks instead of the characters entered, you set the <code>displayAsPassword</code> property to <code>true</code>.</p> <p>The TextInput control is used as a subcomponent in several other controls, such as the RichTextEditor, NumericStepper, and ComboBox controls. As a result, if you assign style properties to a TextInput control by using a CSS type selector, Flex applies those styles to the TextInput when it appears in the other controls unless you explicitly override them.</p> <p>The TextInput control has the following default sizing characteristics:</p> <table class=&quot;innertable&quot;> <tr> <th>Characteristic</th> <th>Description</th> </tr> <tr> <td>Default size</td> <td>The size of the text with a default minimum size of 22 pixels high and 160 pixels wide</td> </tr> <tr> <td>Minimum size</td> <td>0 pixels</td> </tr> <tr> <td>Maximum size</td> <td>10000 by 10000 pixels</td> </tr> </table> <p>The <code>&lt;mx:TextInput&gt;</code> tag inherits the attributes of its superclass and adds the following attributes:</p> <pre>\\n &lt;mx:TextInput\\n <b>Properties</b>\\n condenseWhite=&quot;false|true&quot;\\n data=&quot;undefined&quot;\\n displayAsPassword=&quot;false|true&quot;\\n editable=&quot;true|false&quot;\\n horizontalScrollPosition=&quot;0&quot;\\n htmlText=&quot;&quot;\\n imeMode=&quot;null&quot;\\n length=&quot;0&quot;\\n listData=&quot;null&quot;\\n maxChars=&quot;0&quot;\\n parentDrawsFocus=&quot;false&quot;\\n restrict=&quot;null&quot;\\n selectionBeginIndex=&quot;0&quot;\\n selectionEndIndex=&quot;0&quot;\\n text=&quot;&quot;\\n textHeight=&quot;0&quot;\\n textWidth=&quot;0&quot;\\n &nbsp;\\n <b>Styles</b>\\n backgroundAlpha=&quot;1.0&quot;\\n backgroundColor=&quot;undefined&quot;\\n backgroundImage=&quot;undefined&quot;\\n backgroundSize=&quot;auto&quot;\\n borderColor=&quot;0xAAB3B3&quot;\\n borderSides=&quot;left top right bottom&quot;\\n borderSkin=&quot;mx.skins.halo.HaloBorder&quot;\\n borderStyle=&quot;inset&quot;\\n borderThickness=&quot;1&quot;\\n color=&quot;0x0B333C&quot;\\n cornerRadius=&quot;0&quot;\\n disabledColor=&quot;0xAAB3B3&quot;\\n dropShadowColor=&quot;0x000000&quot;\\n dropShadowEnabled=&quot;false&quot;\\n focusAlpha=&quot;0.5&quot;\\n focusRoundedCorners&quot;tl tr bl br&quot;\\n fontAntiAliasType=&quot;advanced|normal&quot;\\n fontFamily=&quot;Verdana&quot;\\n fontGridFitType=&quot;pixel|none|subpixel&quot;\\n fontSharpness=&quot;0&quot;\\n fontSize=&quot;10&quot;\\n fontStyle=&quot;normal|italic&quot;\\n fontThickness=&quot;0&quot;\\n fontWeight=&quot;normal|bold&quot;\\n paddingLeft=&quot;0&quot;\\n paddingRight=&quot;0&quot;\\n shadowDirection=&quot;center&quot;\\n shadowDistance=&quot;2&quot;\\n textAlign=&quot;left|right|center&quot;\\n textDecoration=&quot;none|underline&quot;\\n textIndent=&quot;0&quot;\\n &nbsp;\\n <b>Events</b>\\n change=&quot;<i>No default</i>&quot;\\n dataChange=&quot;<i>No default</i>&quot;\\n enter=&quot;<i>No default</i>&quot;\\n textInput=&quot;<i>No default</i>&quot;\\n /&gt;\\n </pre>",
"tags": [
{ "tagName": "includeExample",
"values": ["examples/TextInputExample.mxml"]},
{ "tagName": "see",
"values": ["mx.controls.Label", "mx.controls.Text", "mx.controls.TextArea", "mx.controls.RichTextEditor", "mx.controls.textClasses.TextRange"]},
{ "tagName": "helpid",
"values": ["3188"]},
{ "tagName": "tiptext",
"values": ["TextInput is a single-line, editable text field."]},
{ "tagName": "mxml",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"members": [
{ "type": "method",
"qname": "mx.controls.TextInput",
"namespace": "",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Constructor.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "",
"params": []}
,
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "enabled",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1", "Flash 9", "AIR 1.1", "Flash 9", "AIR 1.1", "Flash 9", "AIR 1.1", "Flash 9", "AIR 1.1", "Flash 9", "AIR 1.1", "Flash 9", "AIR 1.1", "Flash 9", "AIR 1.1", "Flash 9", "AIR 1.1"]},
{ "tagName": "copy",
"values": ["mx.core.IUIComponent#enabled", "mx.core.IUIComponent#enabled", "mx.core.IUIComponent#enabled", "mx.core.IUIComponent#enabled", "mx.core.IUIComponent#enabled", "mx.core.IUIComponent#enabled", "mx.core.IUIComponent#enabled", "mx.core.IUIComponent#enabled", "mx.core.IUIComponent#enabled"]},
{ "tagName": "productversion",
"values": ["Flex 3", "Flex 3", "Flex 3", "Flex 3", "Flex 3", "Flex 3", "Flex 3", "Flex 3", "Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0", "3.0", "3.0", "3.0", "3.0", "3.0", "3.0", "3.0", "3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "uint",
"qname": "contentBackgroundColor",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {}},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "borderVisible",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {}},
{ "type": "accessor",
"access": "read-write",
"return": "Object",
"qname": "data",
"namespace": "public",
"bindable": ["dataChange"],
"details": [],
"deprecated": {},
"description": "Lets you pass a value to the component when you use it in an item renderer or item editor. You typically use data binding to bind a field of the <code>data</code> property to a property of this component. <p>When you use the control as a drop-in item renderer or drop-in item editor, Flex automatically writes the current value of the item to the <code>text</code> property of this control.</p> <p>You do not set this property in MXML.</p>",
"tags": [
{ "tagName": "default",
"values": ["null"]},
{ "tagName": "see",
"values": ["mx.core.IDataRenderer"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "displayAsPassword",
"namespace": "public",
"bindable": ["displayAsPasswordChanged"],
"details": [],
"deprecated": {},
"description": "Indicates whether this control is used for entering passwords. If <code>true</code>, the field does not display entered text, instead, each text character entered into the control appears as the character &quot;&#42;&quot;. instead of the actual characters",
"tags": [
{ "tagName": "default",
"values": ["false"]},
{ "tagName": "helpid",
"values": ["3197"]},
{ "tagName": "tiptext",
"values": ["Specifies whether to display '*'"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "editable",
"namespace": "public",
"bindable": ["editableChanged"],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Number",
"qname": "horizontalScrollPosition",
"namespace": "public",
"bindable": ["horizontalScrollPositionChanged"],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "String",
"qname": "htmlText",
"namespace": "public",
"bindable": ["htmlTextChanged"],
"details": [],
"deprecated": {},
"description": "Specifies the text displayed by the TextInput control, including HTML markup that expresses the styles of that text. When you specify HTML text in this property, you can use the subset of HTML tags that is supported by the Flash TextField control. <p> When you set this property, the HTML markup is applied after the CSS styles for the TextInput instance are applied. When you get this property, the HTML markup includes the CSS styles.</p> <p>For example, if you set this to be a string such as, <code>&quot;This is an example of &lt;b&gt;bold&lt;/b&gt; markup&quot;</code>, the text &quot;This is an example of <b>bold</b> markup&quot; appears in the TextInput with whatever CSS styles normally apply. Also, the word &quot;bold&quot; appears in boldface font because of the <code>&lt;b&gt;</code> markup.</p> <p>HTML markup uses characters such as &lt; and &gt;, which have special meaning in XML (and therefore in MXML). So, code such as the following does not compile:</p> <pre>\\n &lt;mx:TextInput htmlText=&quot;This is an example of &lt;b&gt;bold&lt;/b&gt; markup&quot;/&gt;\\n </pre> <p>There are three ways around this problem.</p> <ul> <li> <p>Set the <code>htmlText</code> property in an ActionScript method called as an <code>initialize</code> handler:</p> <pre>\\n &lt;mx:TextInput id=&quot;myTextInput&quot; initialize=&quot;myTextInput_initialize()&quot;/&gt;\\n </pre> <p>where the <code>myTextInput_initialize</code> method is in a script CDATA section:</p> <pre>\\n &lt;fx:Script&gt;\\n &lt;![CDATA[\\n private function myTextInput_initialize():void {\\n myTextInput.htmlText = &quot;This is an example of &lt;b&gt;bold&lt;/b&gt; markup&quot;;\\n }\\n ]]&gt;\\n &lt;/fx:Script&gt;\\n \\n </pre> <p>This is the simplest approach because the HTML markup remains easily readable. Notice that you must assign an <code>id</code> to the TextInput so you can refer to it in the <code>initialize</code> handler.</p> </li> <li> <p>Specify the <code>htmlText</code> property by using a child tag with a CDATA section. A CDATA section in XML contains character data where characters like &lt; and &gt; aren't given a special meaning.</p> <pre>\\n &lt;mx:TextInput&gt;\\n &lt;mx:htmlText&gt;&lt;![CDATA[This is an example of &lt;b&gt;bold&lt;/b&gt; markup]]&gt;&lt;/mx:htmlText&gt;\\n &lt;mx:TextInput/&gt;\\n </pre> <p>You must write the <code>htmlText</code> property as a child tag rather than as an attribute on the <code>&lt;mx:TextInput&gt;</code> tag because XML doesn't allow CDATA for the value of an attribute. Notice that the markup is readable, but the CDATA section makes this approach more complicated.</p> </li> <li> <p>Use an <code>hmtlText</code> attribute where any occurences of the HTML markup characters &lt; and &gt; in the attribute value are written instead as the XML &quot;entities&quot; <code>&amp;lt;</code> and <code>&amp;gt;</code>:</p> <pre>\\n &lt;mx:TextInput htmlText=&quot;This is an example of &amp;lt;b&amp;gt;bold&amp;lt;/b&amp;gt; markup&quot;/&amp;gt;\\n </pre> Adobe does not recommend this approach because the HTML markup becomes nearly impossible to read. </li> </ul> <p>If the <code>condenseWhite</code> property is <code>true</code> when you set the <code>htmlText</code> property, multiple white-space characters are condensed, as in HTML-based browsers; for example, three consecutive spaces are displayed as a single space. The default value for <code>condenseWhite</code> is <code>false</code>, so you must set <code>condenseWhite</code> to <code>true</code> to collapse the white space.</p> <p>If you read back the <code>htmlText</code> property quickly after setting it, you get the same string that you set. However, after the LayoutManager runs, the value changes to include additional markup that includes the CSS styles.</p> <p>Setting the <code>htmlText</code> property affects the <code>text</code> property in several ways. If you read the <code>text</code> property quickly after setting the <code>htmlText</code> property, you get <code>null</code>, which indicates that the <code>text</code> corresponding to the new <code>htmlText</code> has not yet been determined. However, after the LayoutManager runs, the <code>text</code> property value changes to the <code>htmlText</code> string with all the HTML markup removed; that is, the value is the characters that the TextInput actually displays.</p> <p>Conversely, if you set the <code>text</code> property, any previously set <code>htmlText</code> is irrelevant. If you read the <code>htmlText</code> property quickly after setting the <code>text</code> property, you get <code>null</code>, which indicates that the <code>htmlText</code> that corresponds to the new <code>text</code> has not yet been determined. However, after the LayoutManager runs, the <code>htmlText</code> property value changes to the new text plus the HTML markup for the CSS styles.</p> <p>To make the LayoutManager run immediately, you can call the <code>validateNow()</code> method on the TextInput. For example, you could set some <code>htmlText</code>, call the <code>validateNow()</code> method, and immediately obtain the corresponding <code>text</code> that doesn't have the HTML markup.</p> <p>If you set both <code>text</code> and <code>htmlText</code> properties in ActionScript, whichever is set last takes effect. Do not set both in MXML, because MXML does not guarantee that the properties of an instance get set in any particular order.</p> <p>Setting either <code>text</code> or <code>htmlText</code> property inside a loop is a fast operation, because the underlying TextField that actually renders the text is not updated until the LayoutManager runs.</p> <p>If you try to set this property to <code>null</code>, it is set, instead, to the empty string. If the property temporarily has the value <code>null</code>, it indicates that the <code>text</code> has been recently set and the corresponding <code>htmlText</code> has not yet been determined.</p>",
"tags": [
{ "tagName": "default",
"values": [""""]},
{ "tagName": "see",
"values": ["flash.text.TextField#htmlText"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-only",
"return": "int",
"qname": "length",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The number of characters of text displayed in the TextArea.",
"tags": [
{ "tagName": "default",
"values": ["0"]},
{ "tagName": "helpid",
"values": ["3192"]},
{ "tagName": "tiptext",
"values": ["The number of characters in the TextInput."]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Object",
"qname": "listData",
"namespace": "public",
"bindable": ["dataChange"],
"details": [],
"deprecated": {},
"description": "When a component is used as a drop-in item renderer or drop-in item editor, Flex initializes the <code>listData</code> property of the component with the appropriate data from the list control. The component can then use the <code>listData</code> property to initialize the <code>data</code> property of the drop-in item renderer or drop-in item editor. <p>You do not set this property in MXML or ActionScript; Flex sets it when the component is used as a drop-in item renderer or drop-in item editor.</p>",
"tags": [
{ "tagName": "default",
"values": ["null"]},
{ "tagName": "see",
"values": ["mx.controls.listClasses.IDropInListItemRenderer"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "int",
"qname": "maxChars",
"namespace": "public",
"bindable": ["maxCharsChanged"],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-only",
"return": "Number",
"qname": "maxHorizontalScrollPosition",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Maximum value of <code>horizontalScrollPosition</code>. <p>The default value is 0, which means that horizontal scrolling is not required.</p> <p>The value of the <code>maxHorizontalScrollPosition</code> property is computed from the data and size of component, and must not be set by the application code.</p>",
"tags": [
{ "tagName": "private",
"values": []} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "parentDrawsFocus",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "String",
"qname": "restrict",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {}},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "selectable",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "int",
"qname": "selectionBeginIndex",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The zero-based character index value of the first character in the current selection. For example, the first character is 0, the second character is 1, and so on. When the control gets the focus, the selection is visible if the <code>selectionBeginIndex</code> and <code>selectionEndIndex</code> properties are both set. in the selection.",
"tags": [
{ "tagName": "default",
"values": ["0"]},
{ "tagName": "tiptext",
"values": ["The zero-based index value of the first character"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "int",
"qname": "selectionEndIndex",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The zero-based index of the position <i>after</i> the last character in the current selection (equivalent to the one-based index of the last character). If the last character in the selection, for example, is the fifth character, this property has the value 5. When the control gets the focus, the selection is visible if the <code>selectionBeginIndex</code> and <code>selectionEndIndex</code> properties are both set. in the selection.",
"tags": [
{ "tagName": "default",
"values": ["0"]},
{ "tagName": "tiptext",
"values": ["The zero-based index value of the last character"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "String",
"qname": "text",
"namespace": "public",
"bindable": ["change"],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "royaleignorecoercion",
"values": ["HTMLInputElement"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "method",
"qname": "getExplicitOrMeasuredWidth",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"return": "Number",
"params": []}
,
{ "type": "method",
"qname": "getExplicitOrMeasuredHeight",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"return": "Number",
"params": []}
,
{ "type": "method",
"qname": "textChangeHandler",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "dispatch change event in response to a textChange event",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "event", "type": "org.apache.royale.events.Event"}]}
,
{ "type": "method",
"qname": "createBorder",
"namespace": "protected",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Creates the border for this component. Normally the border is determined by the <code>borderStyle</code> and <code>borderSkin</code> styles. It must set the border property to the instance of the border.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": []}
,
{ "type": "method",
"qname": "setSelection",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Selects the text in the range specified by the parameters. If the control is not in focus, the selection highlight will not show until the control gains focus. Also, if the focus is gained by clicking on the control, any previous selection would be lost. If the two parameter values are the same, the new selection is an insertion point. selection; that is, the first character is 0, the second character is 1, and so on. the last character in the selection (equivalent to the one-based index of the last character). If the parameter is 5, the last character in the selection, for example, is the fifth character. When the TextInput control gets the focus, the selection is visible if the <code>selectionBeginIndex</code> and <code>selectionEndIndex</code> properties are both set.",
"tags": [
{ "tagName": "param",
"values": ["beginIndex The zero-based index of the first character in the", "endIndex The zero-based index of the position <i>after</i>"]},
{ "tagName": "tiptext",
"values": ["Sets a new text selection."]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "royaleignorecoercion",
"values": ["HTMLInputElement"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "beginIndex", "type": "int"},
{ "name": "endIndex", "type": "int"}]}
,
{ "type": "accessor",
"access": "read-only",
"return": "int",
"qname": "selectionActivePosition",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-only",
"return": "int",
"qname": "selectionAnchorPosition",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "method",
"qname": "selectRange",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Selects the text in the range specified by the parameters. Unlike <code>setSelection</code> this is done immediately. of the selection that stays fixed when the selection is extended. the end of the selection that moves when the selection is extended.",
"tags": [
{ "tagName": "param",
"values": ["anchorIndex The zero-based character index specifying the beginning", "activeIndex The zero-based character index specifying"]},
{ "tagName": "playerversion",
"values": ["Flash 10", "AIR 1.5"]},
{ "tagName": "productversion",
"values": ["Flex 4"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "anchorIndex", "type": "int"},
{ "name": "activeIndex", "type": "int"}]}
]
,
"events": [
{ "qname": "change",
"type": "org.apache.royale.events.Event"
,
"description": "Dispatched when text in the TextInput control changes through user input. This event does not occur if you use data binding or ActionScript code to change the text. <p>Even though the default value of the <code>Event.bubbles</code> property is <code>true</code>, this control dispatches the event with the <code>Event.bubbles</code> property set to <code>false</code>.</p>",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "eventType",
"values": ["flash.events.Event.CHANGE"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "qname": "dataChange",
"type": "mx.events.FlexEvent"
,
"description": "Dispatched when the <code>data</code> property changes. <p>When you use a component as an item renderer, the <code>data</code> property contains the data to display. You can listen for this event and update the component when the <code>data</code> property changes.</p>",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "eventType",
"values": ["mx.events.FlexEvent.DATA_CHANGE"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "qname": "enter",
"type": "mx.events.FlexEvent"
,
"description": "Dispatched when the user presses the Enter key.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "eventType",
"values": ["mx.events.FlexEvent.ENTER"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "qname": "textInput",
"type": "mx.events.TextEvent"
,
"description": "Dispatched when the user types, deletes, or pastes text into the control. No event is dispatched when the user presses the Delete key, or Backspace key. <p>Even though the default value of the <code>TextEvent.bubbles</code> property is <code>true</code>, this control dispatches the event with the <code>TextEvent.bubbles</code> property set to <code>false</code>.</p>",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "eventType",
"values": ["flash.events.TextEvent.TEXT_INPUT"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]}]
}