Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
StyleableTextField

Package | spark.components.supportClasses
Class | public class StyleableTextField
Inheritance | StyleableTextField FlexTextField flash.text.TextField
Implements | IEditableText, ISimpleStyleClient, IVisualElement
Subclasses | MobileGridTextCellRenderer

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

The StyleableTextField class is a text primitive for use in ActionScript skins and item renderers. It cannot be used in MXML markup and is not compatible with effects.

Public Properties

| Property | Defined By
--- | --- | ---
|  | editable : Boolean Specifies whether the text is editable, true, or not, false. | StyleableTextField
|  | enabled : Boolean Whether the component can accept user interaction. | StyleableTextField
|  | focusEnabled : Boolean Indicates whether the component can receive focus when tabbed to. | StyleableTextField
|  | horizontalScrollPosition : Number The horizontal scroll position of the text. | StyleableTextField
|  | isTruncated : Boolean [read-only] Indicates whether the text has been truncated, true, or not, false. | StyleableTextField
|  | lineBreak : String Controls word wrapping within the text. | StyleableTextField
|  | minHeight : Number The minimum recommended height of the component to be considered by the parent during layout. | StyleableTextField
|  | minWidth : Number The minimum recommended width of the component to be considered by the parent during layout. | StyleableTextField
|  | selectionActivePosition : int [read-only] The active, or last clicked position, of the selection. | StyleableTextField
|  | selectionAnchorPosition : int [read-only] The anchor, or first clicked position, of the selection. | StyleableTextField
|  | styleDeclaration : CSSStyleDeclaration Storage for the inline inheriting styles on this object. | StyleableTextField
|  | styleName : Object The class style used by this component. | StyleableTextField
|  | text : String [override] The text displayed by this text component. | StyleableTextField
|  | verticalScrollPosition : Number The vertical scroll position of the text. | StyleableTextField

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | StyleableTextField() Constructor. | StyleableTextField
|  | appendText(text:String):void [override] Appends the specified text to the end of the text component, as if you had clicked at the end and typed. | StyleableTextField
|  | commitStyles():void Commit the styles into the TextField. | StyleableTextField
|  | getStyle(styleProp:String):* Gets a style property that has been set anywhere in this component's style lookup chain. | StyleableTextField
|  | insertText(text:String):void Inserts the specified text into the text component as if you had typed it. | StyleableTextField
|  | scrollToRange(anchorPosition:int, activePosition:int):void Scroll so the specified range is in view. | StyleableTextField
|  | selectAll():void Selects all of the text. | StyleableTextField
|  | selectRange(anchorIndex:int, activeIndex:int):void Selects a specified range of characters. | StyleableTextField
|  | setFocus():void Set focus to this text field. | StyleableTextField
|  | setStyle(styleProp:String, value:*):void Sets a style property on this component instance. | StyleableTextField
|  | styleChanged(styleProp:String):void Detects changes to style properties. | StyleableTextField
|  | toString():String [override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application. | FlexTextField
|  | truncateToFit(truncationIndicator:String = ...):Boolean Truncate text to make it fit horizontally in the area defined for the control, and append an ellipsis, three periods (...), to the text. | StyleableTextField

Styles

| Style | Description | Defined By
--- | --- | --- | ---
|  | color | Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. The default value for the Halo theme is `0x0B333C`. The default value for the Spark theme is `0x000000`. The default value for the Mobile theme is `0xFFFFFF`. | StyleableTextField
|  | fontFamily | Type: String CSS Inheritance: yes Name of the font to use. Unlike in a full CSS implementation, comma-separated lists are not supported. You can use any font family name. If you specify a generic font name, it is converted to an appropriate device font. The default font for the Halo theme is `"Verdana"`. The default font for the Spark theme is `"Arial"`. The default font for the Mobile theme is `"_sans"`. | StyleableTextField
|  | fontSize | Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. In the Halo theme, the default value is 10 for all controls except the ColorPicker control. For the Halo themed ColorPicker control, the default value is 11. In the Spark theme, the default value is 12 for all controls except the ColorPicker control. For the Spark themed ColorPicker control, the default value is 11. The default value for the Mobile theme is 24. | StyleableTextField
|  | fontStyle | Type: String CSS Inheritance: yes Determines whether the text is italic font. Recognized values are `"normal"` and `"italic"`. The default value is`"normal"`. | StyleableTextField
|  | fontWeight | Type: String CSS Inheritance: yes Determines whether the text is boldface. Recognized values are `normal` and `bold`. The default value for Button controls is `bold`. The default value for all other controls is `normal`. | StyleableTextField
|  | leading | Type: Number Format: Length CSS Inheritance: yes Additional vertical space between lines of text. The default value is 0. | StyleableTextField
|  | letterSpacing | Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. A positive value increases the character spacing beyond the normal spacing, while a negative value decreases it. The default value is`0`. | StyleableTextField
|  | textAlign | Type: String CSS Inheritance: yes Alignment of text within a container. Possible values are `"left"`, `"right"`, or `"center"`. The default value for most components is `"left"`. For the FormItem component, the default value is `"right"`. For the Button, LinkButton, and AccordionHeader components, the default value is `"center"`, and this property is only recognized when the `labelPlacement` property is set to `"left"` or `"right"`. If `labelPlacement` is set to `"top"` or `"bottom"`, the text and any icon are centered. | StyleableTextField
|  | textDecoration | Type: String CSS Inheritance: yes Determines whether the text is underlined. Possible values are `"none"` and `"underline"`. The default value is`"none"`. | StyleableTextField
|  | textIndent | Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. This property cannot be a negative number when used with the mobile theme. The default value is`0`. | StyleableTextField

Property Detail

editable | property

`editable:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Specifies whether the text is editable, `true`, or not, `false`.

The default value is `true if type is TextFieldType.INPUT, otherwise false.`.

Implementation
`public function get editable():Boolean`
`public function set editable(value:Boolean):void`

enabled | property |

`enabled:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Whether the component can accept user interaction. After setting the `enabled` property to `false`, some components still respond to mouse interactions such as `mouseOver`. As a result, to fully disable the component, you should also set the value of the `mouseEnabled` property to `false`.

Implementation
`public function get enabled():Boolean`
`public function set enabled(value:Boolean):void`

focusEnabled | property |

`focusEnabled:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Indicates whether the component can receive focus when tabbed to. You can set `focusEnabled` to `false` when a component is used as a subcomponent of another component so that the outer component becomes the focusable entity. If this property is `false`, focus is transferred to the first parent that has `focusEnable` set to `true`.

The default value is `true`.

Implementation
`public function get focusEnabled():Boolean`
`public function set focusEnabled(value:Boolean):void`

horizontalScrollPosition | property |

`horizontalScrollPosition:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

The horizontal scroll position of the text.

Implementation
`public function get horizontalScrollPosition():Number`
`public function set horizontalScrollPosition(value:Number):void`

isTruncated | property |

`isTruncated:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Indicates whether the text has been truncated, `true`, or not, `false`.

Implementation
`public function get isTruncated():Boolean`

lineBreak | property |

`lineBreak:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Controls word wrapping within the text. This property corresponds to the `lineBreak` style.

Text may be set to fit the width of the container (`LineBreak.TO_FIT`), or can be set to break only at explicit return or line feed characters (`LineBreak.EXPLICIT`).

Legal values are `flashx.textLayout.formats.LineBreak.EXPLICIT`, `flashx.textLayout.formats.LineBreak.TO_FIT`, and `flashx.textLayout.formats.FormatValue.INHERIT`.

Implementation
`public function get lineBreak():String`
`public function set lineBreak(value:String):void`

minHeight | property |

`public var minHeight:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

The minimum recommended height of the component to be considered by the parent during layout. This value is in the component's coordinates, in pixels. The default value depends on the component's implementation.

If the application developer sets the value of minHeight, the new value is stored in explicitMinHeight. The default value of minHeight does not change. As a result, at layout time, if minHeight was explicitly set by the application developer, then the value of explicitMinHeight is used for the component's minimum recommended height. If minHeight is not set explicitly by the application developer, then the value of measuredMinHeight is used.

This value is used by the container in calculating the size and position of the component. It is not used by the component itself in determining its default size. Thus this property may not have any effect if parented by Container, or containers that don't factor in this property. Because the value is in component coordinates, the true `minHeight` with respect to its parent is affected by the `scaleY` property.

minWidth | property |

`public var minWidth:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

The minimum recommended width of the component to be considered by the parent during layout. This value is in the component's coordinates, in pixels. The default value depends on the component's implementation.

If the application developer sets the value of minWidth, the new value is stored in explicitMinWidth. The default value of minWidth does not change. As a result, at layout time, if minWidth was explicitly set by the application developer, then the value of explicitMinWidth is used for the component's minimum recommended width. If minWidth is not set explicitly by the application developer, then the value of measuredMinWidth is used.

This value is used by the container in calculating the size and position of the component. It is not used by the component itself in determining its default size. Thus this property may not have any effect if parented by Container, or containers that don't factor in this property. Because the value is in component coordinates, the true `minWidth` with respect to its parent is affected by the `scaleX` property.

selectionActivePosition | property |

`selectionActivePosition:int` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

The active, or last clicked position, of the selection. If the implementation does not support selection anchor this is the last character of the selection.

Implementation
`public function get selectionActivePosition():int`

selectionAnchorPosition | property |

`selectionAnchorPosition:int` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

The anchor, or first clicked position, of the selection. If the implementation does not support selection anchor this is the first character of the selection.

Implementation
`public function get selectionAnchorPosition():int`

styleDeclaration | property |

`styleDeclaration:CSSStyleDeclaration`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Storage for the inline inheriting styles on this object. This CSSStyleDeclaration is created the first time that the `setStyle()` method is called on this component to set an inheriting style. Developers typically never need to access this property directly.

Implementation
`public function get styleDeclaration():CSSStyleDeclaration`
`public function set styleDeclaration(value:CSSStyleDeclaration):void`

styleName | property |

`styleName:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

The class style used by this component. This should be an IStyleClient.

Implementation
`public function get styleName():Object`
`public function set styleName(value:Object):void`

text | property |

`text:String`[override]

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

The text displayed by this text component.

The formatting of this text is controlled by CSS styles. The supported styles depend on the subclass.

The default value is `""`.

Implementation
`public function get text():String`
`public function set text(value:String):void`

verticalScrollPosition | property |

`verticalScrollPosition:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

The vertical scroll position of the text.

Implementation
`public function get verticalScrollPosition():Number`
`public function set verticalScrollPosition(value:Number):void`
Constructor Detail

StyleableTextField | () | Constructor

`public function StyleableTextField()`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Constructor.

Method Detail

appendText | () | method

`override public function appendText(text:String):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Appends the specified text to the end of the text component, as if you had clicked at the end and typed.

An insertion point is then set after the new text. If necessary, the text will scroll to ensure that the insertion point is visible.

Parameters

| `text:String` — The text to be appended.

commitStyles | () | method |

`public function commitStyles():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Commit the styles into the TextField. This method must be called before the text is displayed, and any time the styles have changed. This method does nothing if the styles have already been committed.

getStyle | () | method |

`public function getStyle(styleProp:String):*`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Gets a style property that has been set anywhere in this component's style lookup chain.

This same method is used to get any kind of style property, so the value returned can be a Boolean, String, Number, int, uint (for an RGB color), Class (for a skin), or any kind of object. Therefore the return type is simply specified as *.

If you are getting a particular style property, you know its type and often want to store the result in a variable of that type. No casting from * to that type is necessary.

`var backgroundColor:uint = getStyle("backgroundColor");`

If the style property has not been set anywhere in the style lookup chain, the value returned by `getStyle()` is `undefined`. Note that `undefined` is a special value that is not the same as `false`, `""`, `NaN`, `0`, or `null`. No valid style value is ever `undefined`. You can use the method `IStyleManager2.isValidStyleValue()` to test whether the value was set.

Parameters

| `styleProp:String` — Name of the style property.

Returns

| `*` — Style value.

insertText | () | method |

`public function insertText(text:String):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Inserts the specified text into the text component as if you had typed it.

If a range was selected, the new text replaces the selected text. If there was an insertion point, the new text is inserted there.

An insertion point is then set after the new text. If necessary, the text will scroll to ensure that the insertion point is visible.

Parameters

| `text:String` — The text to be inserted.

Throws

| `Error` — This method or property cannot be used on a text field with a style sheet.

scrollToRange | () | method |

`public function scrollToRange(anchorPosition:int, activePosition:int):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Scroll so the specified range is in view.

Parameters

| `anchorPosition:int` — The anchor position of the selection range.
| `activePosition:int` — The active position of the selection range.

selectAll | () | method |

`public function selectAll():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Selects all of the text.

selectRange | () | method |

`public function selectRange(anchorIndex:int, activeIndex:int):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Selects a specified range of characters.

If either position is negative, it will deselect the text range.

Parameters

| `anchorIndex:int` — The character position specifying the end of the selection that stays fixed when the selection is extended.
| `activeIndex:int` — The character position specifying the end of the selection that moves when the selection is extended.

setFocus | () | method |

`public function setFocus():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Set focus to this text field.

setStyle | () | method |

`public function setStyle(styleProp:String, value:*):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Sets a style property on this component instance.

This can override a style that was set globally.

Calling the `setStyle()` method can result in decreased performance. Use it only when necessary.

Parameters

| `styleProp:String` — Name of the style property.
| `value:*` — New value for the style.

styleChanged | () | method |

`public function styleChanged(styleProp:String):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Detects changes to style properties. When any style property is set, Flex calls the `styleChanged()` method, passing to it the name of the style being set.

This is an advanced method that you might override when creating a subclass of UIComponent. When you create a custom component, you can override the `styleChanged()` method to check the style name passed to it, and handle the change accordingly. This lets you override the default behavior of an existing style, or add your own custom style properties.

If you handle the style property, your override of the `styleChanged()` method should call the `invalidateDisplayList()` method to cause Flex to execute the component's `updateDisplayList()` method at the next screen update.

Parameters

| `styleProp:String` — The name of the style property, or null if all styles for this component have changed.

truncateToFit | () | method |

`public function truncateToFit(truncationIndicator:String = ...):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Truncate text to make it fit horizontally in the area defined for the control, and append an ellipsis, three periods (...), to the text. This function only works for single line text.

Parameters

| `truncationIndicator:String` (default = `...`)`` — The text to be appended after truncation. If you pass `null`, a localizable string such as `"..."` will be used.

Returns

| `Boolean` — `true` if the text needed truncation.

Sun Mar 5 2017, 03:42 PM +11:00