| Package | spark.components |
| Class | public class TextArea |
| Inheritance | TextArea  SkinnableTextBase SkinnableComponent UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The skin for the Spark theme
uses the RichEditableText class. This means that the Spark TextArea control supports
the Text Layout Framework (TLF) library,
which builds on the Flash Text Engine (FTE).
In combination, these layers provide text editing with
high-quality international typography and layout.
The skin includes a scroller that can display horizontal and vertical scrollbars
for scrolling through the text and supports vertical scrolling with the mouse wheel.
The RichEditableText can be accessed as textDisplay
and the Scroller as scroller.
The skin for the mobile theme uses the StyleableStageText class.
Since StyleableStageText uses native text fields it allows for better text entry and
manipulation experiences on mobile devices however there are some
limitations and differences that you should consider.
Because StageText is not capable of measuring text, the TextArea must be given explicit,
percent-based, or constraint-based width and height.
The StyleableStageText can be accessed as textDisplay.
If you wish to use the TextField-based skin, rather than the
StageText-based skin, set the skinClass property to
"spark.skins.mobile.TextAreaSkin".
You can set the text to be displayed, or get the text that the user
has entered, using the text property.
The text is formatted using CSS styles such as fontFamily
and fontSize.
For the Spark theme, the widthInChars and heightInLines
properties let you specify the width and height of the TextArea
in a way that scales with the font size or you can use the typicalText property.
Note that if you use typicalText, the widthInChars and
heightInLines properties are ignored.
For all themes, you can also specify an explicit width or height in pixels,
or use a percent width and height or constraints such as
left and right
or top and bottom.
You can use the maxChars property to limit the number
of character that the user can enter, and the restrict
to limit which characters the user can enter.
To use this control for password input, set the
displayAsPassword property to true.
For the mobile theme, the soft-keyboard-specific properties, autoCapitalize,
autoCorrect, returnKeyLabel and softKeyboardType
properties specify keyboard hints.
If a soft-keyboard is present but does not support a feature represented by the
hint, the hint is ignored.
In mobile environments with only hardware keyboards, these hints are ignored.
Text Area for the Spark Theme
The most important differences between Spark TextArea and the MX TextArea control are as follows:
- Spark TextArea offers better typography, better support for international languages, and better text layout.
- Spark TextArea has an object-oriented model of rich text, while the MX version does not.
- Spark TextArea has better support for displaying large amounts of text.
- Spark TextArea requires that fonts be embedded
differently than the MX version.
To learn how to use the
embedAsCFFattribute when you embed a font, see the font documentation.
The Spark TextArea control uses the TLF object-oriented model of rich text,
in which text layout elements such as divisions, paragraphs, spans,
hyperlinks, and images are represented at runtime by ActionScript
objects. You can programmatically access and manipulate these objects.
The central object in TLF for representing rich text is a
TextFlow. Specify rich text for a TextArea control
by setting its textFlow property to a TextFlow instance.
If you don't need to display text that has multiple formats,
set the TextArea text property to a plain text string.
See the descriptions of the text and textFlow
properties for information about how they interact;
for example, you can set one and get the other.
At compile time, you can put TLF markup tags inside the TextArea tag, as the following example shows:
<s:TextArea>Hello <s:span fontWeight="bold">World!</s:span></s:TextArea>In this example, the MXML compiler sets the TextArea
content
property, causing a TextFlow object to be created from the FlowElements that you specify.
The TextArea control does not include any user interface for changing the formatting of the text but contains APIs that you can use to programmatically format text. For example, you can create a a button that, when clicked, makes the selected text bold.
The default text formatting is determined by CSS styles such as fontFamily and fontSize. Any formatting information in the TextFlow object overrides the default formatting provided by the CSS styles.
You can control many characteristics of TextArea content with styles. Here are a few popular ones:
- Control spacing between lines with the
lineHeightstyle. - Control the spacing between paragraphs with the
paragraphSpaceBeforeandparagraphSpaceAfterstyles. - Align or justify text using the
textAlignandtextAlignLaststyles. - Inset text from the border of the control using the
paddingLeft,paddingTop,paddingRight, andpaddingBottomstyles.
By default, the text wraps at the right edge of the control.
A vertical scrollbar automatically appears when there is more
text than fits in the TextArea.
If you set the lineBreak style to explicit,
new lines start only at explicit line breaks. This has the same effect as
if you use CR (\r), LF (\n),
or CR+LF (\r\n) in text,
or if you use <p> and <br/>
in TLF markup.
In those cases, a horizontal scrollbar automatically appears
if any lines of text are wider than the control.
The Spark TextArea
can display left-to-right (LTR) text, such as French,
right-to-left (RTL) text, such as Arabic, and bidirectional text,
such as a French phrase inside of an Arabic one.
If the predominant text direction is right-to-left,
set the direction style to rtl.
The textAlign style defaults to start,
which makes the text left-aligned when direction
is ltr and right-aligned when direction
is rtl. To get the opposite alignment,
set textAlign to end.
The Spark TextArea also supports unlimited undo/redo within one editing session. An editing session starts when the control gets keyboard focus and ends when the control loses focus.
To use this component in a list-based component, such as a List or DataGrid, create an item renderer. For information about creating an item renderer, see Custom Spark item renderers.
For the Spark theme, the TextArea control has the following default characteristics:
| Characteristic | Description |
|---|---|
| Default size | 188 pixels wide by 149 pixels high |
| Minimum size | 36 pixels wide and 36 pixels high |
| Maximum size | 10000 pixels wide and 10000 pixels high |
| Default skin class | spark.skins.spark.TextAreaSkin |
For the Mobile theme, the TextArea control has the following default characteristics:
| Characteristic | Description |
|---|---|
| Default skin class | spark.skins.mobile.StageTextAreaSkin |
Show MXML Syntax
Hide MXML SyntaxThe <s:TextArea> tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
<s:TextArea
Properties
heightInLines="Calculated default" [Spark theme only]
textFlow="TextFlow" [Spark theme only]
typicalText=null [Spark theme only]
widthInChars="Calculated default" [Spark theme only]
Styles
horizontalScrollPolicy="auto" [Spark theme only]
symbolColor=""
verticalScrollPolicy="auto" [Spark theme only]
/>
Default MXML Propertycontent
More examples
Creating a TextArea control
Sizing the TextArea control
Using TLF with the TextArea control
Styling the TextArea control
Setting character ranges
Use a TextArea control in a mobile application
Set styles on text input controls in a mobile application
Restrict keys in a text input control
Use events with a soft keyboard in a mobile application
Sizing the TextArea control
Using TLF with the TextArea control
Styling the TextArea control
Setting character ranges
Use a TextArea control in a mobile application
Set styles on text input controls in a mobile application
Restrict keys in a text input control
Use events with a soft keyboard in a mobile application
Learn more
About the Spark text controls
TextArea control
Adding content to text controls
Selecting text
Using Text Layout Framework
Markup tags supported in TextFlow objects
Mirroring and bidirectional text
Using prompts with text controls
Embed fonts
Mirroring with text controls
Guidelines for text in a mobile application
Open a soft keyboard in a mobile Flex application
Use native features with a soft keyboard
Embed fonts in a mobile application
TextArea control
Adding content to text controls
Selecting text
Using Text Layout Framework
Markup tags supported in TextFlow objects
Mirroring and bidirectional text
Using prompts with text controls
Embed fonts
Mirroring with text controls
Guidelines for text in a mobile application
Open a soft keyboard in a mobile Flex application
Use native features with a soft keyboard
Embed fonts in a mobile application
Related API Elements
text
textFlow
spark.components.TextInput
spark.components.RichText
spark.components.RichEditableText
spark.components.Scroller
spark.components.Label
spark.skins.mobile.StageTextAreaSkin
spark.skins.mobile.TextAreaSkin
spark.skins.spark.TextAreaSkin
textFlow
spark.components.TextInput
spark.components.RichText
spark.components.RichEditableText
spark.components.Scroller
spark.components.Label
spark.skins.mobile.StageTextAreaSkin
spark.skins.mobile.TextAreaSkin
spark.skins.spark.TextAreaSkin
Public Properties
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | |
| accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | |
| alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | |
| autoCapitalize : String
Hint indicating what captialization behavior soft keyboards should
use. | SkinnableTextBase | |
| autoCorrect : Boolean
Hint indicating whether a soft keyboard should use its auto-correct
behavior, if supported. | SkinnableTextBase | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality. | UIComponent | |
| automationEnabled : Boolean [read-only]
True if this component is enabled for automation, false
otherwise. | UIComponent | |
| automationName : String
Name that can be used as an identifier for this object. | UIComponent | |
| automationOwner : DisplayObjectContainer [read-only]
The owner of this component for automation purposes. | UIComponent | |
| automationParent : DisplayObjectContainer [read-only]
The parent of this component for automation purposes. | UIComponent | |
| automationTabularData : Object [read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : Array [read-only]
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application. | UIComponent | |
| automationVisible : Boolean [read-only]
True if this component is visible for automation, false
otherwise. | UIComponent | |
| baseline : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| baselinePosition : Number [override] [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | SkinnableComponent | |
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | |
| blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | |
| bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | DisplayObject | |
| cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | DisplayObject | |
| cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | |
| className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| content : Object
This property is intended for use in MXML at compile time;
to get or set rich text content at runtime,
use the textFlow property instead. | TextArea | ||
| contentMouseX : Number [read-only]
Returns the x position of the mouse, in the content coordinate system. | UIComponent | |
| contentMouseY : Number [read-only]
Returns the y position of the mouse, in the content coordinate system. | UIComponent | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | |
| currentState : String
The current view state of the component. | UIComponent | |
| cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers. | UIComponent | |
| depth : Number
Determines the order in which items inside of containers
are rendered. | UIComponent | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | UIComponent | |
| displayAsPassword : Boolean
Specifies whether the text field is a password text field. | SkinnableTextBase | |
| document : Object
A reference to the document object associated with this UIComponent. | UIComponent | |
| doubleClickEnabled : Boolean [override]
Specifies whether the UIComponent object receives doubleClick events. | UIComponent | |
| dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | |
| editable : Boolean
Specifies whether the text is editable. | SkinnableTextBase | |
| enabled : Boolean
Whether the component can accept user interaction. | UIComponent | |
| enableIME : Boolean [read-only]
A flag that indicates whether the IME should
be enabled when the component receives focus. | SkinnableTextBase | |
| errorString : String
The text that displayed by a component's error tip when a
component is monitored by a Validator and validation fails. | UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UIComponent | |
| explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | |
| focusPane : Sprite
The focus pane associated with this object. | UIComponent | |
| focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | |
| graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | |
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | |
| hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | UIComponent | |
| height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| heightInLines : Number
The default height of the control, measured in lines. | TextArea | ||
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| id : String
ID of the component. | UIComponent | |
| imeMode : String
Specifies the IME (input method editor) mode. | SkinnableTextBase | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles. | UIComponent | |
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required). | UIComponent | |
| instanceIndex : int [read-only]
The index of a repeated component. | UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document. | UIComponent | |
| is3D : Boolean [read-only]
Contains true when the element is in 3D. | UIComponent | |
| isDocument : Boolean [read-only]
Contains true if this UIComponent instance is a document object. | UIComponent | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | |
| left : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | |
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | |
| maxChars : int
The maximum number of characters that the text field can contain, as entered by a user. | SkinnableTextBase | |
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| maxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels. | UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels. | UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels. | UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels. | UIComponent | |
| minHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| moduleFactory : IFlexModuleFactory
A module factory is used as context for using embedded fonts and for
finding the style manager that controls the styles for this
component. | UIComponent | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject. | DisplayObject | |
| needsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
when this InteractiveObject instance receives focus. | InteractiveObject | |
| nestLevel : int
Depth of this object in the containment hierarchy. | UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | UIComponent | |
| numAutomationChildren : int [read-only]
The number of automation children this container has. | UIComponent | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | UIComponent | |
| parent : DisplayObjectContainer [override] [read-only]
The parent container or component for this component. | UIComponent | |
| parentApplication : Object [read-only]
A reference to the Application object that contains this UIComponent
instance. | UIComponent | |
| parentDocument : Object [read-only]
A reference to the parent document object for this UIComponent. | UIComponent | |
| percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | UIComponent | |
| percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | UIComponent | |
| postLayoutTransformOffsets : mx.geom:TransformOffsets
Defines a set of adjustments that can be applied to the object's
transform in a way that is invisible to its parent's layout. | UIComponent | |
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| prompt : String
Text to be displayed if/when the actual text property is an empty string. | SkinnableTextBase | |
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| repeater : IRepeater [read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent. | UIComponent | |
| repeaterIndex : int [read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent. | UIComponent | |
| repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent. | UIComponent | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent. | UIComponent | |
| restrict : String
Indicates the set of characters that a user can enter into the text field. | SkinnableTextBase | |
| returnKeyLabel : String
Hint indicating what label should be displayed for the return key on
soft keyboards. | SkinnableTextBase | |
| right : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | |
| rotation : Number [override]
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | UIComponent | |
| rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationZ : Number [override]
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent | |
| scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | |
| scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | |
| scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | |
| scaleZ : Number [override]
Number that specifies the scaling factor along the z axis. | UIComponent | |
| screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | |
| selectable : Boolean
A flag indicating whether the content is selectable. | SkinnableTextBase | |
| selectionActivePosition : int [read-only]
A character position, relative to the beginning of the
text String, specifying the end of the selection
that moves when the selection is extended with the arrow keys. | SkinnableTextBase | |
| selectionAnchorPosition : int [read-only]
A character position, relative to the beginning of the
text String, specifying the end of the selection
that stays fixed when the selection is extended with the arrow keys. | SkinnableTextBase | |
| selectionHighlighting : String
Determines when the text selection is highlighted. | SkinnableTextBase | |
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| skin : UIComponent [read-only]
The instance of the skin class for this component instance. | SkinnableComponent | |
| softKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed. | InteractiveObject | |
| softKeyboardType : String
Hint indicating what kind of soft keyboard should be displayed for
this component. | SkinnableTextBase | |
| soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | |
| stage : Stage [read-only]
The Stage of the display object. | DisplayObject | |
| states : Array
The view states that are defined for this component. | UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | UIComponent | |
| styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | UIComponent | |
| styleName : Object
The class style used by this component. | UIComponent | |
| styleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors. | UIComponent | |
| suggestedFocusSkinExclusions : Array [read-only]
Lists the skin parts that are
excluded from bitmaps captured and used to
show focus. | SkinnableComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | |
| tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | |
| tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | |
| tabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus
via the TAB key
This is similar to the tabEnabled property
used by the Flash Player.
This is usually true for components that
handle keyboard input, but some components in controlbars
have them set to false because they should not steal
focus from another component like an editor. | UIComponent | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | |
| text : String
The text displayed by this text component. | SkinnableTextBase | |
| textFlow : flashx.textLayout.elements:TextFlow
The TextFlow representing the rich text displayed by this component. | TextArea | ||
| textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | |
| toolTip : String
Text to display in the ToolTip. | UIComponent | |
| top : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| transform : flash.geom:Transform [override]
An object with properties pertaining to a display object's matrix, color transform,
and pixel bounds. | UIComponent | |
| transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | |
| transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | |
| transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object. | UIComponent | |
| typicalText : String
Text that is used to determine
the default width and height of the control,
without actually being displayed. | SkinnableTextBase | |
| uid : String
A unique identifier for the object. | UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required). | UIComponent | |
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls
over a sprite in which the buttonMode property is set to true. | Sprite | |
| validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | |
| verticalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| visible : Boolean [override]
Whether or not the display object is visible. | UIComponent | |
| width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| widthInChars : Number
The default width of the control, measured in em units. | TextArea | ||
| x : Number [override]
Number that specifies the component's horizontal position,
in pixels, within its parent container. | UIComponent | |
| y : Number [override]
Number that specifies the component's vertical position,
in pixels, within its parent container. | UIComponent | |
| z : Number [override]
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | UIComponent | |
Protected Properties
Public Methods
| Method | Defined By | ||
|---|---|---|---|
TextArea()
Constructor. | TextArea | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Adds a non-visual style client to this component instance. | UIComponent | |
|
Appends the specified text to the end of the text component,
as if you had clicked at the end and typed. | SkinnableTextBase | |
|
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | |
|
Queues a function to be called later. | UIComponent | |
|
Deletes a style property from this component instance. | UIComponent | |
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | |
|
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
|
Converts a Point object from content to local coordinates. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| [override]
Dispatches an event into the event flow. | UIComponent | |
|
Shows or hides the focus indicator around this component. | UIComponent | |
| drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | |
|
Called by the effect instance when it stops playing on the component. | UIComponent | |
|
Called by the effect instance when it starts playing on the component. | UIComponent | |
|
Ends all currently playing effects on the component. | UIComponent | |
|
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
|
Called after printing is complete. | UIComponent | |
|
Provides the automation object at the specified index. | UIComponent | |
|
Provides the automation object list . | UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the child display object that exists with the specified name. | DisplayObjectContainer | |
|
Finds the type selectors for this UIComponent instance. | UIComponent | |
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
Gets the object that currently has focus. | UIComponent | |
getFormatOfRange(requestedFormats:Vector.<String> = null, anchorPosition:int = -1, activePosition:int = -1):flashx.textLayout.formats:TextLayoutFormat
Returns a TextLayoutFormat object specifying the computed formats
for the specified range of characters. | TextArea | ||
|
Returns the element's layout height. | UIComponent | |
|
Returns the element's layout width. | UIComponent | |
|
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
|
Returns the layout transform Matrix3D for this element. | UIComponent | |
|
Returns the element's maximum height. | UIComponent | |
|
Returns the element's maximum width. | UIComponent | |
|
Returns the element's minimum height. | UIComponent | |
|
Returns the element's minimum width. | UIComponent | |
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Returns the element's preferred height. | UIComponent | |
|
Returns the element's preferred width. | UIComponent | |
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | |
|
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
|
Converts a Point object from global to content coordinates. | UIComponent | |
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
|
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | |
|
Returns true if currentCSSState is not null. | UIComponent | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
|
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
Initializes the internal structure of this component. | UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
|
Inserts the specified text into the text component
as if you had typed it. | SkinnableTextBase | |
|
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
|
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
|
Marks the component so that the new state of the skin is set
during a later screen update. | SkinnableComponent | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | |
|
Converts a Point object from local to content coordinates. | UIComponent | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
Returns true if cssState matches currentCSSState. | UIComponent | |
|
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
|
Measures the specified HTML text, which can contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Measures the specified text, assuming that it is displayed
in a single-line UITextField (or UIFTETextField) using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Moves the component to a specified position within its parent. | UIComponent | |
|
Propagates style changes to the children. | UIComponent | |
|
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
|
Prepares an IFlexDisplayObject for printing. | UIComponent | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
|
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
|
Removes one or more child DisplayObject instances from the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Removes a non-visual style client from this component instance. | UIComponent | |
|
Replays the specified event. | UIComponent | |
|
Raises a virtual keyboard. | InteractiveObject | |
|
Resolves a child by using the id provided. | UIComponent | |
| [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
Scrolls so that the text range is visible in the container. | TextArea | ||
|
Selects all of the text. | SkinnableTextBase | |
|
Selects a specified range of characters. | SkinnableTextBase | |
|
Sizes the object. | UIComponent | |
|
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
|
Set the current state. | UIComponent | |
|
Sets the focus to this component. | UIComponent | |
setFormatOfRange(format:flashx.textLayout.formats:TextLayoutFormat, anchorPosition:int = -1, activePosition:int = -1):void
Applies the specified formats to each element in the specified
range that correspond to the given format. | TextArea | ||
|
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
|
Sets the layout size of the element. | UIComponent | |
|
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sets a style property on this component instance. | UIComponent | |
|
Called when the visible property changes. | UIComponent | |
|
Lets the user drag the specified sprite. | Sprite | |
|
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | |
|
Ends the startDrag() method. | Sprite | |
|
Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite | |
|
Detects changes to style properties. | UIComponent | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIComponent | |
|
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIComponent | |
|
Validates the position and size of children and draws other
visuals. | UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
|
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
|
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
Returns the primitive value of the specified object. | Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
Styles
Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.
Common Styles
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: String CSS Inheritance: yes Specifies the baseline to which the dominant baseline aligns. | SkinnableTextBase | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
| Type: Object CSS Inheritance: yes Amount to shift the baseline. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes Specifies a vertical or horizontal progression of line placement. | SkinnableTextBase | ||
| Type: String CSS Inheritance: no The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. | UIComponent | ||
| Type: String CSS Inheritance: yes Controls where lines are allowed to break when breaking wrapping text into multiple lines. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes The type of CFF hinting used for this text. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes Controls how text wraps around a float. | SkinnableTextBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the text. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes The type of digit case used for this text. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes Type of digit width used for this text. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes Specifies the default bidirectional embedding level of the text. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line. | SkinnableTextBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
| Type: Class Name of the skin class to use for this component when a validation error occurs. | SkinnableComponent | ||
| Type: Object CSS Inheritance: yes Specifies the baseline position of the first line in the container. | SkinnableTextBase | ||
| Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes The color of text when the component is enabled and has focus. | SkinnableTextBase | ||
| Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: no Thickness, in pixels, of the focus rectangle outline. | UIComponent | ||
| Type: String CSS Inheritance: yes The name of the font to use, or a comma-separated list of font names. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes Font lookup to use. | SkinnableTextBase | ||
| Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes Determines whether the text is italic font. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes Determines whether the text is boldface. | SkinnableTextBase | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
horizontalScrollPolicy | Type: String CSS Inheritance: no Indicates under what conditions the horizontal scroll bar is displayed. For the Mobile theme, this is not supported. Indicates under what conditions the horizontal scroll bar is displayed.
The scroll policy affects the measured size of the Scroller component. | TextArea | ||
| Type: uint Format: Color CSS Inheritance: yes The color of text when the component is disabled. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes The primary interaction mode for this component. | UIComponent | ||
| Type: String CSS Inheritance: yes Rule used to justify text in a paragraph. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes The style used for justification of the paragraph. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes The style used for justification of the paragraph. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. | UIComponent | ||
| Type: String CSS Inheritance: yes Specifies the leading model, which is a combination of leading basis and leading direction. | SkinnableTextBase | ||
| Type: String CSS Inheritance: no The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | UIComponent | ||
| Type: String CSS Inheritance: yes Controls which of the ligatures that are defined in the font may be used in the text. | SkinnableTextBase | ||
| Type: String CSS Inheritance: no Controls word wrapping within the container. | SkinnableTextBase | ||
| Type: Object CSS Inheritance: yes Leading controls for the text. | SkinnableTextBase | ||
| Type: Boolean CSS Inheritance: yes If true, applies strikethrough, a line drawn through the middle of the text. | SkinnableTextBase | ||
| Type: Number Format: length CSS Inheritance: yes This specifies an auto indent for the start edge of lists when the padding value of the list on that side is auto. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes This controls the placement of a list item marker relative to the list item. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes This controls the appearance of items in a list. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes The locale of the text. | SkinnableTextBase | ||
| Type: Number Format: Length CSS Inheritance: no Bottom inset, in pixels. | SkinnableTextBase | ||
| Type: Number Format: Length CSS Inheritance: no Left inset, in pixels. | SkinnableTextBase | ||
| Type: Number Format: Length CSS Inheritance: no Right inset, in pixels. | SkinnableTextBase | ||
| Type: Number Format: Length CSS Inheritance: no Top inset, in pixels. | SkinnableTextBase | ||
| Type: Number Format: length CSS Inheritance: yes The amount to indent the paragraph's end edge. | SkinnableTextBase | ||
| Type: Number Format: length CSS Inheritance: yes The amount of space to leave after the paragraph. | SkinnableTextBase | ||
| Type: Number Format: length CSS Inheritance: yes The amount of space to leave before the paragraph. | SkinnableTextBase | ||
| Type: Number Format: length CSS Inheritance: yes The amount to indent the paragraph's start edge. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes The rendering mode used for this text which applies only to embedded fonts. | SkinnableTextBase | ||
| Type: String CSS Inheritance: no The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. | UIComponent | ||
| Type: Boolean CSS Inheritance: yes Show the error border or skin when this component is invalid | UIComponent | ||
| Type: Boolean CSS Inheritance: yes Show the error tip when this component is invalid and the user rolls over it | UIComponent | ||
| Type: Class Name of the skin class to use for this component. | SkinnableComponent | ||
| Type: String CSS Inheritance: yes Specifies the tab stops associated with the paragraph. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes Alignment of text within a container. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes Alignment of the last line in the paragraph relative to the container in justified text. | SkinnableTextBase | ||
| Type: Number CSS Inheritance: yes Alpha (transparency) value for the text. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes Determines whether the text is underlined. | SkinnableTextBase | ||
| Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes Specifies options for justifying text. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes Determines the number of degrees to rotate this text. | SkinnableTextBase | ||
| Type: String CSS Inheritance: no The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent | ||
| Type: Object CSS Inheritance: yes The amount of tracking (manual kerning) to be applied to the left of each character. | SkinnableTextBase | ||
| Type: Object CSS Inheritance: yes The amount of tracking (manual kerning) to be applied to the right of each character. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes The type of typographic case used for this text. | SkinnableTextBase | ||
| Type: uint Format: Color CSS Inheritance: yes The color of text when the component is enabled but does not have focus. | SkinnableTextBase | ||
| Type: String CSS Inheritance: no Vertical alignment or justification. | SkinnableTextBase | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
verticalScrollPolicy | Type: String CSS Inheritance: no Indicates under what conditions the vertical scroll bar is displayed. For the Mobile theme, this is not supported. Indicates under what conditions the vertical scroll bar is displayed.
The scroll policy affects the measured size of the Scroller component. | TextArea | ||
| Type: String CSS Inheritance: yes Collapses or preserves whitespace when importing text into a TextFlow. | SkinnableTextBase | ||
| Type: Object CSS Inheritance: yes Specifies the spacing between words to use during justification. | SkinnableTextBase | ||
Spark Theme Styles
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: Number CSS Inheritance: no Theme: spark The alpha of the border for this component. | SkinnableTextBase | ||
| Type: uint Format: Color CSS Inheritance: no Theme: spark The color of the border for this component. | SkinnableTextBase | ||
| Type: Boolean CSS Inheritance: no Theme: spark, mobile Controls the visibility of the border for this component. | SkinnableTextBase | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile The main color for a component. | SkinnableComponent | ||
| Type: Number CSS Inheritance: yes Theme: spark, mobile The alpha of the content background for this component. | SkinnableTextBase | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile The color of the content background for this component. | SkinnableTextBase | ||
| Type: Number CSS Inheritance: no Theme: spark, mobile The alpha of the focus ring for this component. | SkinnableTextBase | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile Color of focus ring when the component is in focus. | SkinnableTextBase | ||
symbolColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of any symbol of a component. Examples include the check mark of a CheckBox or the arrow of a scroll button. | TextArea | ||
Mobile Theme Styles
Skin Parts
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
| Skin Part | Description | Defined By | ||
|---|---|---|---|---|
| Required: false Part Type: Static The Label or other IDisplayText that might be present in any skin assigned to this component. | SkinnableTextBase | ||
scroller:Scroller | Required: false Part Type: Static The optional Scroller in the skin, used to scroll the RichEditableText. | TextArea | ||
| Required: false Part Type: Static The IEditableText that may be present in any skin assigned to this component. This is RichEditableText for the Spark theme and StyleableStageText for the Mobile theme. | SkinnableTextBase | ||
Skin States
To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.
Public Constants
Property Detail
content | property |
content:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This property is intended for use in MXML at compile time;
to get or set rich text content at runtime,
use the textFlow property instead. Adobe recommends using
textFlow property to get and set rich text content at runtime,
because it is strongly typed as a TextFlow rather than as an Object.
A TextFlow is the canonical representation
for rich text content in the Text Layout Framework.
The content property is the default property
for TextArea, so that you can write MXML, as the following example shows:
<s:TextArea>Hello <s:span fontWeight="bold">World</s:span></s:TextArea>
In this example, the String and SpanElement that you specify
as the content are used to create a TextFlow.
This property is typed as Object because you can set it to to a String, a FlowElement, or an Array of Strings and FlowElements. In the example above, the content is a 2-element array. The first array element is the String "Hello". The second array element is a SpanElement object with the text "World" in boldface.
No matter how you specify the content, the content is converted to a TextFlow object. When you get the value of this property, you get the resulting TextFlow object.
For the Mobile theme, this is not supported.
Implementation
public function get content():Object public function set content(value:Object):voidheightInLines | property |
heightInLines:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The default height of the control, measured in lines.
For the Spark theme, see spark.components.RichEditableText.heightInLines
For the Mobile theme, this is not supported.
The default value is NaN.
Implementation
public function get heightInLines():Number public function set heightInLines(value:Number):voidRelated API Elements
textFlow | property |
textFlow:flashx.textLayout.elements:TextFlow| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The TextFlow representing the rich text displayed by this component.
For the Spark theme, see spark.components.RichEditableText.textFlow
For the Mobile theme, this is not supported.
The default value is null.
Implementation
public function get textFlow():flashx.textLayout.elements:TextFlow public function set textFlow(value:flashx.textLayout.elements:TextFlow):voidRelated API Elements
widthInChars | property |
widthInChars:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The default width of the control, measured in em units.
For the Spark theme, see spark.components.RichEditableText.widthInChars
For the Mobile theme, this is not supported.
The default value is NaN.
Implementation
public function get widthInChars():Number public function set widthInChars(value:Number):voidRelated API Elements
Constructor Detail
TextArea | () | Constructor |
public function TextArea()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Constructor.
Method Detail
getFormatOfRange | () | method |
public function getFormatOfRange(requestedFormats:Vector.<String> = null, anchorPosition:int = -1, activePosition:int = -1):flashx.textLayout.formats:TextLayoutFormat| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns a TextLayoutFormat object specifying the computed formats for the specified range of characters.
If a format is not consistently set across the entire range,
its value will be undefined.
You can specify a Vector of Strings containing the names of the formats that you care about; if you don't, all formats will be computed.
If you don't specify a range, the selected range is used.
Parameters
requestedFormats:Vector.<String> (default = null)null to request all formats.
| |
anchorPosition:int (default = -1) | |
activePosition:int (default = -1) |
flashx.textLayout.formats:TextLayoutFormat — A TextLayoutFormat object.
|
scrollToRange | () | method |
public function scrollToRange(anchorPosition:int = 0, activePosition:int):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Scrolls so that the text range is visible in the container.
Parameters
anchorPosition:int (default = 0) | |
activePosition:int (default = NaN) |
setFormatOfRange | () | method |
public function setFormatOfRange(format:flashx.textLayout.formats:TextLayoutFormat, anchorPosition:int = -1, activePosition:int = -1):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Applies the specified formats to each element in the specified range that correspond to the given format. It applies the character formats to the text in the specified range (no change is made if the specified range is a single point). It applies the paragraph formats to any paragraphs at least partially within the range (or a single paragraph if the range is a single point). It applies the container formats to the container.
The supported formats are those in TextLayoutFormat.
A value of undefined does not get applied.
If you don't specify a range, the selected range is used.
The following example sets the fontSize and color of the selection:
var textLayoutFormat:TextLayoutFormat = new TextLayoutFormat();
textLayoutFormat.fontSize = 12;
textLayoutFormat.color = 0xFF0000;
myRET.setFormatOfRange(textLayoutFormat);
If you use the results of getFormatOfRange() to
specify the format, note that every format in the
TextLayoutFormat has a
computed value, which will be applied to each element that
corresponds to the given format.
If you would like to specify a format to be applied to all the text
it would be better to use setStyle(format, value)
on the component itself.
The following example sets the fontSize and color of all the text:
myRET.setStyle("fontSize", 12);
myRET.setStyle("color", 0xFF0000);
Parameters
format:flashx.textLayout.formats:TextLayoutFormat — The TextLayoutFormat to apply to the selection.
| |
anchorPosition:int (default = -1) | |
activePosition:int (default = -1) |
Examples How to use this example
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>
Mon Nov 28 2011, 06:48 AM -08:00