ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
spark.components.supportClasses 

SkinnableTextBase  - AS3 Flex

Packagespark.components.supportClasses
Classpublic class SkinnableTextBase
InheritanceSkinnableTextBase Inheritance SkinnableComponent Inheritance UIComponent Inheritance FlexSprite Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Implements IFocusManagerComponent, IIMESupport, ISoftKeyboardHintClient
Subclasses TextArea, TextInput

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The base class for skinnable components, such as the Spark TextInput and TextArea, that include an instance of IEditableText in their skin to provide text display, scrolling, selection, and editing. By default, IEditableText is RichEditableText for the Spark theme and StyleableStageText for the Mobile theme. StyleableTextField is also available for the Mobile theme.

MXML SyntaxexpandedHide MXML Syntax

The <s:SkinnableTextBase> tag inherits all of the tag attributes of its superclass and adds the following tag attributes:

  <s:SkinnableTextBase
    autoCapitalize="none"  [Mobile theme only]
    autoCorrect="true"  [Mobile theme only]
    displayAsPassword="false"
    editable="true"
    imeMode="null"  [Spark theme only]
    maxChars="0"
    prompt="null"
    restrict="null"
    returnLabelKey="default"  [Mobile theme only]
    selectable="true"
    selectionHighlighting="whenFocused"  [Spark theme only]
    softKeyboardType="default"  [Mobile theme only]
    text=""
    typicalText="null"  [Spark theme only]
  
    Styles
    borderAlpha="1.0"
    borderColor="0x696969"
    borderVisible="true"
    contentBackgroundAlpha="1.0" 
    contentBackgroundColor="0xFFFFFF"
    focusAlpha="0.55"
    focusColor="0x70B2EE"
    showPromptWhenFocused="true"
 
    Events
    change="No default"
    changing="No default"  [Spark theme only]
    selectionChange="No default"  [Spark theme only]
    textInput="No default"  [Spark theme only]
  />
  


Public Properties
 PropertyDefined By
 InheritedaccessibilityDescription : String
A convenience accessor for the description property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityEnabled : Boolean
A convenience accessor for the silent property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance.
InteractiveObject
 InheritedaccessibilityName : String
A convenience accessor for the name property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
DisplayObject
 InheritedaccessibilityShortcut : String
A convenience accessor for the shortcut property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedactiveEffects : Array
[read-only] The list of effects that are currently playing on the component, as an Array of EffectInstance instances.
UIComponent
 Inheritedalpha : 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
 InheritedautomationDelegate : Object
The delegate object that handles the automation-related functionality.
UIComponent
 InheritedautomationEnabled : Boolean
[read-only] True if this component is enabled for automation, false otherwise.
UIComponent
 InheritedautomationName : String
Name that can be used as an identifier for this object.
UIComponent
 InheritedautomationOwner : DisplayObjectContainer
[read-only] The owner of this component for automation purposes.
UIComponent
 InheritedautomationParent : DisplayObjectContainer
[read-only] The parent of this component for automation purposes.
UIComponent
 InheritedautomationTabularData : Object
[read-only] An implementation of the IAutomationTabularData interface, which can be used to retrieve the data.
UIComponent
 InheritedautomationValue : 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
 InheritedautomationVisible : Boolean
[read-only] True if this component is visible for automation, false otherwise.
UIComponent
 Inheritedbaseline : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 InheritedbaselinePosition : Number
[override] [read-only] The y-coordinate of the baseline of the first line of text of the component.
SkinnableComponent
 InheritedblendMode : String
A value from the BlendMode class that specifies which blend mode to use.
DisplayObject
 InheritedblendShader : Shader
[write-only] Sets a shader that is used for blending the foreground and background.
DisplayObject
 Inheritedbottom : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 InheritedbuttonMode : Boolean
Specifies the button mode of this sprite.
Sprite
 InheritedcacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the display object.
DisplayObject
 Inherited    cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true.
DisplayObject
 InheritedcacheHeuristic : Boolean
[write-only] Used by Flex to suggest bitmap caching for the object.
UIComponent
 InheritedcachePolicy : String
Specifies the bitmap caching policy for this object.
UIComponent
 InheritedclassName : String
[read-only] The name of this instance's class, such as "Button".
UIComponent
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcontentMouseX : Number
[read-only] Returns the x position of the mouse, in the content coordinate system.
UIComponent
 InheritedcontentMouseY : Number
[read-only] Returns the y position of the mouse, in the content coordinate system.
UIComponent
 InheritedcontextMenu : NativeMenu
Specifies the context menu associated with this object.
InteractiveObject
 InheritedcurrentState : String
The current view state of the component.
UIComponent
 InheritedcursorManager : ICursorManager
[read-only] Gets the CursorManager that controls the cursor for this component and its peers.
UIComponent
 Inheriteddepth : Number
Determines the order in which items inside of containers are rendered.
UIComponent
 Inheriteddescriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance.
UIComponent
 InheriteddesignLayer : 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
 Inheriteddocument : Object
A reference to the document object associated with this UIComponent.
UIComponent
 InheriteddoubleClickEnabled : Boolean
[override] Specifies whether the UIComponent object receives doubleClick events.
UIComponent
 InheriteddropTarget : 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
 Inheritedenabled : 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
 InheritederrorString : String
The text that displayed by a component's error tip when a component is monitored by a Validator and validation fails.
UIComponent
 InheritedexplicitHeight : Number
Number that specifies the explicit height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMinHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMinWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitWidth : Number
Number that specifies the explicit width of the component, in pixels, in the component's coordinates.
UIComponent
 Inheritedfilters : Array
An indexed array that contains each filter object currently associated with the display object.
DisplayObject
 InheritedflexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
UIComponent
 InheritedfocusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
UIComponent
 InheritedfocusManager : IFocusManager
Gets the FocusManager that controls focus for this component and its peers.
UIComponent
 InheritedfocusPane : Sprite
The focus pane associated with this object.
UIComponent
 InheritedfocusRect : Object
Specifies whether this object displays a focus rectangle.
InteractiveObject
 Inheritedgraphics : Graphics
[read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.
Sprite
 InheritedhasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus.
UIComponent
 InheritedhasLayoutMatrix3D : Boolean
[read-only] Contains true if the element has 3D Matrix.
UIComponent
 Inheritedheight : Number
[override] Number that specifies the height of the component, in pixels, in the parent's coordinates.
UIComponent
 InheritedhitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
Sprite
 InheritedhorizontalCenter : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 Inheritedid : String
ID of the component.
UIComponent
  imeMode : String
Specifies the IME (input method editor) mode.
SkinnableTextBase
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
UIComponent
 InheritedinheritingStyles : Object
The beginning of this component's chain of inheriting styles.
UIComponent
 Inheritedinitialized : 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
 InheritedinstanceIndex : int
[read-only] The index of a repeated component.
UIComponent
 InheritedinstanceIndices : Array
An Array containing the indices required to reference this UIComponent object from its parent document.
UIComponent
 Inheritedis3D : Boolean
[read-only] Contains true when the element is in 3D.
UIComponent
 InheritedisDocument : Boolean
[read-only] Contains true if this UIComponent instance is a document object.
UIComponent
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
UIComponent
 InheritedlayoutMatrix3D : Matrix3D
[write-only] The transform matrix that is used to calculate a component's layout relative to its siblings.
UIComponent
 Inheritedleft : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 InheritedloaderInfo : LoaderInfo
[read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.
DisplayObject
 InheritedmaintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the middle of its bounding box.
UIComponent
 Inheritedmask : 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
 InheritedmaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedmaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedmeasuredHeight : Number
The default height of the component, in pixels.
UIComponent
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
UIComponent
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
UIComponent
 InheritedmeasuredWidth : Number
The default width of the component, in pixels.
UIComponent
 InheritedmetaData : Object
Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.
DisplayObject
 InheritedminHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedminWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedmoduleFactory : 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
 InheritedmouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled.
DisplayObjectContainer
 InheritedmouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages.
InteractiveObject
 InheritedmouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
UIComponent
 InheritedmouseX : Number
[read-only] Indicates the x coordinate of the mouse or user input device position, in pixels.
DisplayObject
 InheritedmouseY : Number
[read-only] Indicates the y coordinate of the mouse or user input device position, in pixels.
DisplayObject
 Inheritedname : String
Indicates the instance name of the DisplayObject.
DisplayObject
 InheritedneedsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus.
InteractiveObject
 InheritednestLevel : int
Depth of this object in the containment hierarchy.
UIComponent
 InheritednonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
UIComponent
 InheritednumAutomationChildren : int
[read-only] The number of automation children this container has.
UIComponent
 InheritedopaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
DisplayObject
 Inheritedowner : DisplayObjectContainer
The owner of this IVisualElement object.
UIComponent
 Inheritedparent : DisplayObjectContainer
[override] [read-only] The parent container or component for this component.
UIComponent
 InheritedparentApplication : Object
[read-only] A reference to the Application object that contains this UIComponent instance.
UIComponent
 InheritedparentDocument : Object
[read-only] A reference to the parent document object for this UIComponent.
UIComponent
 InheritedpercentHeight : Number
Specifies the height of a component as a percentage of its parent's size.
UIComponent
 InheritedpercentWidth : Number
Specifies the width of a component as a percentage of its parent's size.
UIComponent
 InheritedpostLayoutTransformOffsets : 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
 InheritedprocessedDescriptors : 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
 Inheritedrepeater : IRepeater
[read-only] A reference to the Repeater object in the parent document that produced this UIComponent.
UIComponent
 InheritedrepeaterIndex : int
[read-only] The index of the item in the data provider of the Repeater that produced this UIComponent.
UIComponent
 InheritedrepeaterIndices : 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
 Inheritedrepeaters : 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
 Inheritedright : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 Inheritedroot : 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
 Inheritedrotation : Number
[override] Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
UIComponent
 InheritedrotationX : Number
[override] Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 InheritedrotationY : Number
[override] Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 InheritedrotationZ : Number
[override] Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 Inheritedscale9Grid : Rectangle
The current scaling grid that is in effect.
DisplayObject
 InheritedscaleX : Number
[override] Number that specifies the horizontal scaling factor.
UIComponent
 InheritedscaleY : Number
[override] Number that specifies the vertical scaling factor.
UIComponent
 InheritedscaleZ : Number
[override] Number that specifies the scaling factor along the z axis.
UIComponent
 Inheritedscreen : Rectangle
[read-only] Returns an object that contains the size and position of the base drawing surface for this object.
UIComponent
 InheritedscrollRect : 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
 InheritedshowInAutomationHierarchy : Boolean
A flag that determines if an automation object shows in the automation hierarchy.
UIComponent
 Inheritedskin : UIComponent
[read-only] The instance of the skin class for this component instance.
SkinnableComponent
 InheritedsoftKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS).
InteractiveObject
      softKeyboardType : String
Hint indicating what kind of soft keyboard should be displayed for this component.
SkinnableTextBase
 InheritedsoundTransform : flash.media:SoundTransform
Controls sound within this sprite.
Sprite
 Inheritedstage : Stage
[read-only] The Stage of the display object.
DisplayObject
 Inheritedstates : Array
The view states that are defined for this component.
UIComponent
 InheritedstyleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
UIComponent
 InheritedstyleManager : IStyleManager2
[read-only] Returns the StyleManager instance used by this component.
UIComponent
 InheritedstyleName : Object
The class style used by this component.
UIComponent
 InheritedstyleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors.
UIComponent
 InheritedsuggestedFocusSkinExclusions : Array
[read-only] Lists the skin parts that are excluded from bitmaps captured and used to show focus.
SkinnableComponent
 InheritedsystemManager : ISystemManager
Returns the SystemManager object used by this component.
UIComponent
 InheritedtabChildren : Boolean
Determines whether the children of the object are tab enabled.
DisplayObjectContainer
 InheritedtabEnabled : Boolean
Specifies whether this object is in the tab order.
InteractiveObject
 InheritedtabFocusEnabled : 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
 InheritedtabIndex : int
Specifies the tab ordering of objects in a SWF file.
InteractiveObject
  text : String
The text displayed by this text component.
SkinnableTextBase
 InheritedtextSnapshot : flash.text:TextSnapshot
[read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.
DisplayObjectContainer
 InheritedtoolTip : String
Text to display in the ToolTip.
UIComponent
 Inheritedtop : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 Inheritedtransform : flash.geom:Transform
[override] An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
UIComponent
 InheritedtransformX : Number
Sets the x coordinate for the transform center of the component.
UIComponent
 InheritedtransformY : Number
Sets the y coordinate for the transform center of the component.
UIComponent
 InheritedtransformZ : Number
Sets the z coordinate for the transform center of the component.
UIComponent
 Inheritedtransitions : Array
An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs.
UIComponent
 InheritedtweeningProperties : 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
 Inheriteduid : String
A unique identifier for the object.
UIComponent
 InheritedupdateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases of layout validation (provided that any were required).
UIComponent
 InheriteduseHandCursor : 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
 InheritedvalidationSubField : String
Used by a validator to associate a subfield with this component.
UIComponent
 InheritedverticalCenter : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 Inheritedvisible : Boolean
[override] Whether or not the display object is visible.
UIComponent
 Inheritedwidth : Number
[override] Number that specifies the width of the component, in pixels, in the parent's coordinates.
UIComponent
 Inheritedx : Number
[override] Number that specifies the component's horizontal position, in pixels, within its parent container.
UIComponent
 Inheritedy : Number
[override] Number that specifies the component's vertical position, in pixels, within its parent container.
UIComponent
 Inheritedz : Number
[override] Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.
UIComponent
Protected Properties
 PropertyDefined By
 InheritedcurrentCSSState : String
[override] [read-only] The state to be used when matching CSS pseudo-selectors.
SkinnableComponent
 InheritedhasComplexLayoutMatrix : Boolean
[read-only] Returns true if the UIComponent has any non-translation (x,y) transform properties.
UIComponent
 InheritedresourceManager : IResourceManager
[read-only] A reference to the object which manages all of the application's localized resources.
UIComponent
 InheritedunscaledHeight : Number
[read-only] A convenience method for determining the unscaled height of the component.
UIComponent
 InheritedunscaledWidth : Number
[read-only] A convenience method for determining the unscaled width of the component All of a component's drawing and child layout should be done within a bounding rectangle of this width, which is also passed as an argument to updateDisplayList().
UIComponent
Public Methods
 MethodDefined By
  
Constructor.
SkinnableTextBase
 Inherited
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
 Inherited
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
 Inherited
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
 Inherited
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
UIComponent
 Inherited
Deletes a style property from this component instance.
UIComponent
 Inherited
Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.
DisplayObjectContainer
 Inherited
Converts a Point object from content coordinates to global coordinates.
UIComponent
 Inherited
Converts a Point object from content to local coordinates.
UIComponent
 Inherited
Returns a set of properties that identify the child within this container.
UIComponent
 Inherited
Returns a set of properties that identify the child within this container.
UIComponent
 Inherited
Creates an id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Deletes the id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Returns a UITextFormat object corresponding to the text styles for this UIComponent.
UIComponent
 Inherited
[override] Dispatches an event into the event flow.
UIComponent
 Inherited
Shows or hides the focus indicator around this component.
UIComponent
 Inherited
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
 Inherited
Called by the effect instance when it stops playing on the component.
UIComponent
 Inherited
Called by the effect instance when it starts playing on the component.
UIComponent
 Inherited
Ends all currently playing effects on the component.
UIComponent
 Inherited
executeBindings(recurse:Boolean = false):void
Executes all the bindings for which the UIComponent object is the destination.
UIComponent
 Inherited
Called after printing is complete.
UIComponent
 Inherited
Provides the automation object at the specified index.
UIComponent
 Inherited
Provides the automation object list .
UIComponent
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.
DisplayObject
 Inherited
getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size.
UIComponent
 Inherited
getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size.
UIComponent
 Inherited
Returns the child display object that exists with the specified name.
DisplayObjectContainer
 Inherited
Finds the type selectors for this UIComponent instance.
UIComponent
 Inherited
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as getting the constraint style for this component.
UIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured height
UIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured width
UIComponent
 Inherited
Gets the object that currently has focus.
UIComponent
 Inherited
getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height.
UIComponent
 Inherited
getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width.
UIComponent
 Inherited
getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen.
UIComponent
 Inherited
getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen.
UIComponent
 Inherited
Returns the transform matrix that is used to calculate the component's layout relative to its siblings.
UIComponent
 Inherited
Returns the layout transform Matrix3D for this element.
UIComponent
 Inherited
getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height.
UIComponent
 Inherited
getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width.
UIComponent
 Inherited
getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height.
UIComponent
 Inherited
getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width.
UIComponent
 Inherited
Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height.
UIComponent
 Inherited
getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width.
UIComponent
 Inherited
getRect(targetCoordinateSpace:DisplayObject):Rectangle
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
 Inherited
getRepeaterItem(whichRepeater:int = -1):Object
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
 Inherited
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this component's style lookup chain.
UIComponent
 Inherited
Converts a Point object from global to content coordinates.
UIComponent
 Inherited
Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.
DisplayObject
 Inherited
Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.
DisplayObject
 Inherited
Returns true if currentCSSState is not null.
UIComponent
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Determines whether the specified state has been defined on this UIComponent.
UIComponent
 Inherited
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
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.
DisplayObject
 Inherited
Returns a box Matrix which can be passed to the drawRoundRect() method as the rot parameter when drawing a horizontal gradient.
UIComponent
 Inherited
Initializes the internal structure of this component.
UIComponent
 Inherited
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
 Inherited
Marks a component so that its updateDisplayList() method gets called during a later screen update.
UIComponent
 Inherited
Called by a component's items to indicate that their depth property has changed.
UIComponent
 Inherited
An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes.
UIComponent
 Inherited
Marks a component so that its commitProperties() method gets called during a later screen update.
UIComponent
 Inherited
Marks a component so that its measure() method gets called during a later screen update.
UIComponent
 Inherited
Marks the component so that the new state of the skin is set during a later screen update.
SkinnableComponent
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
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
 Inherited
Converts a Point object from local to content coordinates.
UIComponent
 Inherited
Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.
DisplayObject
 Inherited
Returns true if cssState matches currentCSSState.
UIComponent
 Inherited
Determines whether this instance is the same as, or is a subclass of, the given type.
UIComponent
 Inherited
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
 Inherited
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
 Inherited
Moves the component to a specified position within its parent.
UIComponent
 Inherited
Propagates style changes to the children.
UIComponent
 Inherited
Returns true if the chain of owner properties points from child to this UIComponent.
UIComponent
 Inherited
Called by Flex when a UIComponent object is added to or removed from a parent.
UIComponent
 Inherited
Prepares an IFlexDisplayObject for printing.
UIComponent
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
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
 Inherited
For each effect event, registers the EffectManager as one of the event listeners.
UIComponent
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void
Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Removes a non-visual style client from this component instance.
UIComponent
 Inherited
Replays the specified event.
UIComponent
 Inherited
Raises a virtual keyboard.
InteractiveObject
 Inherited
Resolves a child by using the id provided.
UIComponent
 Inherited
[static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing().
UIComponent
  
Selects all of the text.
SkinnableTextBase
  
selectRange(anchorIndex:int, activeIndex:int):void
Selects a specified range of characters.
SkinnableTextBase
 Inherited
Sizes the object.
UIComponent
 Inherited
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as setting the constraint style for this component.
UIComponent
 Inherited
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
UIComponent
 Inherited
Sets the focus to this component.
UIComponent
 Inherited
setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen.
UIComponent
 Inherited
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element.
UIComponent
 Inherited
setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void
Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings.
UIComponent
 Inherited
setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings.
UIComponent
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
UIComponent
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes.
UIComponent
 Inherited
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite.
Sprite
 Inherited
startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite on a touch-enabled device.
Sprite
 Inherited
Recursively stops the timeline execution of all MovieClips rooted at this object.
DisplayObjectContainer
 Inherited
Ends the startDrag() method.
Sprite
 Inherited
stopTouchDrag(touchPointID:int):void
Ends the startTouchDrag() method, for use with touch-enabled devices.
Sprite
 Inherited
Detects changes to style properties.
UIComponent
 Inherited
Flex calls the stylesInitialized() method when the styles for a component are first initialized.
UIComponent
 Inherited
[static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called.
UIComponent
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
[override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.
FlexSprite
 Inherited
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
 Inherited
transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
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
 Inherited
Validates the position and size of children and draws other visuals.
UIComponent
 Inherited
Validate and update the properties and layout of this object and redraw it, if necessary.
UIComponent
 Inherited
Used by layout logic to validate the properties of a component by calling the commitProperties() method.
UIComponent
 Inherited
validateSize(recursive:Boolean = false):void
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
 Inherited
Handles both the valid and invalid events from a validator assigned to this component.
UIComponent
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient.
UIComponent
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
 Inherited
Adjust the focus rectangle.
UIComponent
 Inherited
Commits the computed matrix built from the combination of the layout matrix and the transform offsets to the flash displayObject's transform.
UIComponent
 Inherited
This is an internal method used by the Flex framework to support the Dissolve effect.
UIComponent
 Inherited
Create the skin for the component.
SkinnableComponent
 Inherited
Determines if the call to the measure() method can be skipped.
UIComponent
 Inherited
Performs any final processing after child objects are created.
UIComponent
 Inherited
Clear out references to skin parts.
SkinnableComponent
 Inherited
Processes the properties set on the component.
UIComponent
 Inherited
Create child objects of the component.
UIComponent
 Inherited
Create an instance of a dynamic skin part.
SkinnableComponent
 Inherited
Creates a new object using a context based on the embedded font being used.
UIComponent
 Inherited
Creates the object using a given moduleFactory.
UIComponent
 Inherited
Destroys and removes the skin for this component.
SkinnableComponent
 Inherited
dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void
Helper method for dispatching a PropertyChangeEvent when a property is updated.
UIComponent
 Inherited
Find the skin parts in the skin class and assign them to the properties of the component.
SkinnableComponent
 Inherited
The event handler called when a UIComponent object gets focus.
UIComponent
 Inherited
The event handler called when a UIComponent object loses focus.
UIComponent
 Inherited
Returns the name of the state to be applied to the skin.
SkinnableComponent
 Inherited
Returns a specific instance of a dynamic part.
SkinnableComponent
 Inherited
Initializes the implementation and storage of some of the less frequently used advanced layout features of a component.
UIComponent
 Inherited
Finalizes the initialization of this component.
UIComponent
 Inherited
Initializes this component's accessibility code.
UIComponent
 Inherited
Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true).
UIComponent
 Inherited
Typically overridden by components containing UITextField objects, where the UITextField object gets focus.
UIComponent
 Inherited
The event handler called for a keyDown event.
UIComponent
 Inherited
The event handler called for a keyUp event.
UIComponent
 Inherited
Calculates the default size, and optionally the default minimum size, of the component.
UIComponent
 Inherited
Returns the number of instances of a dynamic part.
SkinnableComponent
 Inherited
partAdded(partName:String, instance:Object):void
Called when a skin part is added.
SkinnableComponent
 Inherited
partRemoved(partName:String, instance:Object):void
Called when an instance of a skin part is being removed.
SkinnableComponent
 Inherited
Remove an instance of a dynamic part.
SkinnableComponent
 Inherited
This method is called when a UIComponent is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way.
UIComponent
 Inherited
setStretchXY(stretchX:Number, stretchY:Number):void
Specifies a transform stretch factor in the horizontal and vertical direction.
UIComponent
 Inherited
stateChanged(oldState:String, newState:String, recursive:Boolean):void
This method is called when a state changes to check whether state-specific styles apply to this component.
UIComponent
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Draws the object and/or sizes and positions its children.
UIComponent
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 InheritedDispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method.UIComponent
 InheritedDispatched when a display object is added to the display list.DisplayObject
 InheritedDispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
  Dispatched after a user editing operation is complete.SkinnableTextBase
  Dispatched before a user editing operation occurs.SkinnableTextBase
 InheritedDispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
 InheritedDispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.InteractiveObject
 Inherited
    contextMenu
Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.InteractiveObject
 InheritedDispatched when the user activates the platform-specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.InteractiveObject
 InheritedDispatched when the component has finished its construction, property processing, measuring, layout, and drawing.UIComponent
 InheritedDispatched after the view state has changed.UIComponent
 InheritedDispatched after the currentState property changes, but before the view state changes.UIComponent
 InheritedDispatched when the user activates the platform-specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.InteractiveObject
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
 InheritedDispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true.InteractiveObject
 InheritedDispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop.UIComponent
 InheritedDispatched by the drop target when the user releases the mouse over it.UIComponent
 InheritedDispatched by a component when the user moves the mouse over the component during a drag operation.UIComponent
 InheritedDispatched by the component when the user drags outside the component, but does not drop the data onto the target.UIComponent
 InheritedDispatched by a component when the user moves the mouse while over the component during a drag operation.UIComponent
 InheritedDispatched by the drag initiator when starting a drag operation.UIComponent
 InheritedDispatched after an effect ends.UIComponent
 InheritedDispatched just before an effect starts.UIComponent
 InheritedDispatched after an effect is stopped, which happens only by a call to stop() on the effect.UIComponent
 Inherited[broadcast event] Dispatched when the playhead is entering a new frame.DisplayObject
 InheritedDispatched after the component has entered a view state.UIComponent
 Inherited[broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 InheritedDispatched just before the component exits a view state.UIComponent
 InheritedDispatched after a display object gains focus.InteractiveObject
 InheritedDispatched after a display object loses focus.InteractiveObject
 Inherited[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 InheritedDispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a finger from left to right over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when an object's state changes from visible to invisible.UIComponent
 InheritedThis event is dispatched to any client app that supports inline input with an IMEInteractiveObject
 InheritedDispatched when the component has finished its construction and has all initialization properties set.UIComponent
 InheritedDispatched when a component is monitored by a Validator and the validation failed.UIComponent
 InheritedDispatched when the user presses a key.InteractiveObject
 InheritedDispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 InheritedDispatched when the user releases a key.InteractiveObject
 InheritedDispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched from a component opened using the PopUpManager when the user clicks outside it.UIComponent
 InheritedDispatched when the user attempts to change focus by using a pointer device.InteractiveObject
 InheritedDispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 InheritedDispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.UIComponent
 InheritedDispatched when the object has moved.UIComponent
 InheritedDispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
 InheritedDispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop().InteractiveObject
 InheritedDispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject continually while a drag gesture remains within its boundary.InteractiveObject
 InheritedDispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched when the user activates the platform-specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu.InteractiveObject
 InheritedDispatched at the beginning of the component initialization sequence.UIComponent
 InheritedDispatched when the user lowers an active stylus past the proximity detection threshold of the screen.InteractiveObject
 Inherited
    proximityEnd
Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.InteractiveObject
 InheritedDispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold.InteractiveObject
 Inherited
    proximityOut
Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen.InteractiveObject
 InheritedDispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen.InteractiveObject
 InheritedDispatched when the user moves an active stylus away from this InteractiveObject and any of its children while remaining within the proximity detection threshold of the screen.InteractiveObject
 InheritedDispatched when the user moves an active stylus over this InteractiveObject from outside the object's tree of descendents in the display list (while remaining within the proximity detection threshold of the screen).InteractiveObject
 InheritedDispatched when a user releases the button on the pointing device after the user first pressed the button over an InteractiveObject instance and then moved the pointing device off of the InteractiveObject instance.InteractiveObject
 InheritedDispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method.UIComponent
 InheritedDispatched when a display object is about to be removed from the display list.DisplayObject
 InheritedDispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited[broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
 InheritedDispatched when the component is resized.UIComponent
 InheritedDispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user activates the platform-specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu.InteractiveObject
  Dispached after the selectionAnchorPosition and/or selectionActivePosition properties have changed for any reason.SkinnableTextBase
 InheritedDispatched when an object's state changes from invisible to visible.UIComponent
 InheritedDispatched immediately after the soft keyboard is raised.InteractiveObject
 InheritedDispatched immediately before the soft keyboard is raised.InteractiveObject
 InheritedDispatched immediately after the soft keyboard is lowered.InteractiveObject
 InheritedDispatched after the component has entered a new state and any state transition animation to that state has finished playing.UIComponent
 InheritedDispatched when a component interrupts a transition to its current state in order to switch to a new state.UIComponent
 InheritedDispatched when the value of the object's tabChildren flag changes.InteractiveObject
 InheritedDispatched when the object's tabEnabled flag changes.InteractiveObject
 InheritedDispatched when the value of the object's tabIndex property changes.InteractiveObject
  Dispatched when a keystroke is about to be input to the component.SkinnableTextBase
 InheritedDispatched by the component when it is time to create a ToolTip.UIComponent
 InheritedDispatched by the component when its ToolTip has been hidden and is to be discarded soon.UIComponent
 InheritedDispatched by the component when its ToolTip is about to be hidden.UIComponent
 InheritedDispatched by the component when its ToolTip is about to be shown.UIComponent
 InheritedDispatched by the component when its ToolTip has been shown.UIComponent
 InheritedDispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.UIComponent
 InheritedDispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedA non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture.UIComponent
 InheritedA non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture.UIComponent
 InheritedA cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture.UIComponent
 InheritedDispatched when the user touches the device, and is continuously dispatched until the point of contact is removed.InteractiveObject
 InheritedDispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).UIComponent
 InheritedDispatched when a component is monitored by a Validator and the validation succeeded.UIComponent
 InheritedDispatched when values are changed programmatically or by user interaction.UIComponent
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
  
alignmentBaseline
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Specifies the baseline to which the dominant baseline aligns.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.alignmentBaseline

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
 InheritedType: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

The vertical distance in pixels from the top edge of the content area to the control's baseline position.
UIComponent
  
baselineShift
Type: Object CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Amount to shift the baseline.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.baselineShift.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
blockProgression
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Specifies a vertical or horizontal progression of line placement.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.blockProgression.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
 InheritedType: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area.
UIComponent
  
breakOpportunity
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Controls where lines are allowed to break when breaking wrapping text into multiple lines.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.breakOpportunity.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
cffHinting
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The type of CFF hinting used for this text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.cffHinting.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
clearFloats
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Controls how text wraps around a float.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.clearFloats.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
color
Type: uint Format: Color CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Color of the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.color.

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style color, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style color.

The default value is 0x000000.

Related API Elements

SkinnableTextBase
  
digitCase
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The type of digit case used for this text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.digitCase.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
digitWidth
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Type of digit width used for this text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.digitWidth.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
direction
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Specifies the default bidirectional embedding level of the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.direction.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
dominantBaseline
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.dominantBaseline.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
 InheritedType: uint Format: Color CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

Color of the component highlight when validation fails.
UIComponent
 InheritedType: Class
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Name of the skin class to use for this component when a validation error occurs.
SkinnableComponent
  
firstBaselineOffset
Type: Object CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Specifies the baseline position of the first line in the container.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.firstBaselineOffset.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
 InheritedType: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

Blend mode used by the focus rectangle.
UIComponent
  
focusedTextSelectionColor
Type: uint Format: Color CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The color of text when the component is enabled and has focus.

For the Mobile theme, this is not supported.

SkinnableTextBase
 InheritedType: Class CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

Skin used to draw the focus rectangle.
UIComponent
 InheritedType: Number Format: Length CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

Thickness, in pixels, of the focus rectangle outline.
UIComponent
  
fontFamily
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The name of the font to use, or a comma-separated list of font names.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontFamily.

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style fontFamily, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style fontFamily.

The default value for the Spark theme is Arial. The default value for the Mobile theme is _sans.

Related API Elements

SkinnableTextBase
  
fontLookup
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Font lookup to use.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontLookup

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
fontSize
Type: Number Format: Length CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Height of the text, in pixels.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontSize

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style fontSize, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style fontSize.

The default value for the Spark theme is 12. The default value for the Mobile theme is 24.

Related API Elements

SkinnableTextBase
  
fontStyle
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Determines whether the text is italic font.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontStyle

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style fontStyle, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style fontStyle.

Related API Elements

SkinnableTextBase
  
fontWeight
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Determines whether the text is boldface.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontWeight

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style fontWeight, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style fontWeight.

Related API Elements

SkinnableTextBase
 InheritedType: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

The horizontal distance in pixels from the center of the component's content area to the center of the component.
UIComponent
  
inactiveTextSelectionColor
Type: uint Format: Color CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The color of text when the component is disabled.

For the Mobile theme, this is not supported.

SkinnableTextBase
 InheritedType: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4.5  Runtime Versions: Flash10, AIR 2.5

The primary interaction mode for this component.
UIComponent
  
justificationRule
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Rule used to justify text in a paragraph.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.justificationRule

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
justificationStyle
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The style used for justification of the paragraph.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.justificationStyle

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
kerning
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The style used for justification of the paragraph.

Kerning is enabled by default for Spark components, but is disabled by default for MX components. Spark components interpret default as auto, while MX components interpret default as false.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.kerning

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
 InheritedType: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4.1  Runtime Versions: Flash10, AIR 1.5

Specifies the desired layout direction of a component.
UIComponent
  
leadingModel
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Specifies the leading model, which is a combination of leading basis and leading direction.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.leadingModel.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
 InheritedType: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area.
UIComponent
  
ligatureLevel
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Controls which of the ligatures that are defined in the font may be used in the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.ligatureLevel

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
lineBreak
Type: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Controls word wrapping within the container.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.blockProgression.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
lineHeight
Type: Object CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Leading controls for the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.lineHeight.

For the Mobile theme, this is not supported. See leading.

Related API Elements

SkinnableTextBase
  
lineThrough
Type: Boolean CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

If true, applies strikethrough, a line drawn through the middle of the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.lineThrough

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
listAutoPadding
Type: Number Format: length CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

This specifies an auto indent for the start edge of lists when the padding value of the list on that side is auto.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.listAutoPadding.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
listStylePosition
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4.5  Runtime Versions: Flash10, AIR 2.5

This controls the placement of a list item marker relative to the list item.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.listStylePosition.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
listStyleType
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4.5  Runtime Versions: Flash10, AIR 2.5

This controls the appearance of items in a list.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.listStyleType.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
locale
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The locale of the text. Controls case transformations and shaping. Uses standard locale identifiers as described in Unicode Technical Standard #35. For example "en", "en_US" and "en-US" are all English, "ja" is Japanese.

The default value is undefined. This property inherits its value from an ancestor; if still undefined, it inherits from the global locale style. During the application initialization, if the global locale style is undefined, then the default value is set to "en".

When using the Spark formatters and globalization classes, you can set this style on the root application to the value of the LocaleID.DEFAULT constant. Those classes will then use the client operating system's international preferences.

The default value is undefined.

Learn more

SkinnableTextBase
  
paddingBottom
Type: Number Format: Length CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Bottom inset, in pixels.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paddingBottom.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
paddingLeft
Type: Number Format: Length CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Left inset, in pixels.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paddingLeft.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
paddingRight
Type: Number Format: Length CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Right inset, in pixels.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paddingRight.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
paddingTop
Type: Number Format: Length CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Top inset, in pixels.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paddingRight.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
paragraphEndIndent
Type: Number Format: length CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The amount to indent the paragraph's end edge.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paragraphEndIndent.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
paragraphSpaceAfter
Type: Number Format: length CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The amount of space to leave after the paragraph.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paragraphSpaceAfter.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
paragraphSpaceBefore
Type: Number Format: length CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The amount of space to leave before the paragraph.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paragraphSpaceBefore.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
paragraphStartIndent
Type: Number Format: length CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The amount to indent the paragraph's start edge.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paragraphStartIndent.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
renderingMode
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The rendering mode used for this text which applies only to embedded fonts.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.renderingMode

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
 InheritedType: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area.
UIComponent
 InheritedType: Boolean CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4.5  Runtime Versions: Flash10, AIR 1.5

Show the error border or skin when this component is invalid
UIComponent
 InheritedType: Boolean CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4.5  Runtime Versions: Flash10, AIR 1.5

Show the error tip when this component is invalid and the user rolls over it
UIComponent
 InheritedType: Class
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Name of the skin class to use for this component.
SkinnableComponent
  
tabStops
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Specifies the tab stops associated with the paragraph.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.tabStops.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
textAlign
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Alignment of text within a container.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textAlign

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style textAlign, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style textAlign.

Related API Elements

SkinnableTextBase
  
textAlignLast
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Alignment of the last line in the paragraph relative to the container in justified text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textAlignLast

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
textAlpha
Type: Number CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Alpha (transparency) value for the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textAlpha

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
textDecoration
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Determines whether the text is underlined.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textDecoration

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style textDecoration, and if using StyleableStageText, this is not supported.

Related API Elements

SkinnableTextBase
  
textIndent
Type: Number Format: Length CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Offset of first line of text from the left side of the container. .

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textIndent.

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style textIndent, and if using StyleableStageText this is not supported.

Related API Elements

SkinnableTextBase
  
textJustify
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Specifies options for justifying text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textJustify

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
textRotation
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Determines the number of degrees to rotate this text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textRotation.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
 InheritedType: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area.
UIComponent
  
trackingLeft
Type: Object CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The amount of tracking (manual kerning) to be applied to the left of each character.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.trackingLeft

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
trackingRight
Type: Object CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The amount of tracking (manual kerning) to be applied to the right of each character.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.trackingRight

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
typographicCase
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The type of typographic case used for this text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.typographicCase

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
unfocusedTextSelectionColor
Type: uint Format: Color CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The color of text when the component is enabled but does not have focus.

For the Mobile theme, this is not supported.

SkinnableTextBase
  
verticalAlign
Type: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Vertical alignment or justification.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.verticalAlign.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
 InheritedType: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

The vertical distance in pixels from the center of the component's content area to the center of the component.
UIComponent
  
whiteSpaceCollapse
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Collapses or preserves whitespace when importing text into a TextFlow.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.whiteSpaceCollapse.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
  
wordSpacing
Type: Object CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4.5  Runtime Versions: Flash10.5, AIR 2.0

Specifies the spacing between words to use during justification.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.wordSpacing.

For the Mobile theme, this is not supported.

Related API Elements

SkinnableTextBase
Spark Theme Styles
 Style Description Defined By
  
borderAlpha
Type: Number CSS Inheritance: No Theme: spark
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The alpha of the border for this component.
SkinnableTextBase
  
borderColor
Type: uint Format: Color CSS Inheritance: No Theme: spark
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The color of the border for this component.
SkinnableTextBase
  
borderVisible
Type: Boolean CSS Inheritance: No Theme: spark, mobile
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Controls the visibility of the border for this component.
SkinnableTextBase
 InheritedType: uint Format: Color CSS Inheritance: Yes Theme: spark, mobile
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The main color for a component.
SkinnableComponent
  
contentBackgroundAlpha
Type: Number CSS Inheritance: Yes Theme: spark, mobile
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The alpha of the content background for this component.
SkinnableTextBase
  
contentBackgroundColor
Type: uint Format: Color CSS Inheritance: Yes Theme: spark, mobile
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The color of the content background for this component.

For a List, changing contentBackgroundColor will change the content background color of the List; however, if the item renderer is opaque, the user may not see any difference. The item renderer's color is affected by alternatingItemColors. In the Spark theme, by default, item renderers are transparent (alternatingItemColors = undefined); however, in the Mobile theme, item renderers are opaque by default (alternatingItemColors = 0xFFFFFF).

The default value for the Spark theme is 0xFFFFFF. The default value for the Mobile theme is 0xF0F0F0.

SkinnableTextBase
  
focusAlpha
Type: Number CSS Inheritance: No Theme: spark, mobile
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The alpha of the focus ring for this component.
SkinnableTextBase
  
focusColor
Type: uint Format: Color CSS Inheritance: Yes Theme: spark, mobile
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Color of focus ring when the component is in focus.
SkinnableTextBase
Mobile Theme Styles
 Style Description Defined By
  
borderVisible
Type: Boolean CSS Inheritance: No Theme: spark, mobile
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Controls the visibility of the border for this component.
SkinnableTextBase
 InheritedType: uint Format: Color CSS Inheritance: Yes Theme: spark, mobile
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The main color for a component.
SkinnableComponent
  
contentBackgroundAlpha
Type: Number CSS Inheritance: Yes Theme: spark, mobile
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The alpha of the content background for this component.
SkinnableTextBase
  
contentBackgroundColor
Type: uint Format: Color CSS Inheritance: Yes Theme: spark, mobile
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The color of the content background for this component.

For a List, changing contentBackgroundColor will change the content background color of the List; however, if the item renderer is opaque, the user may not see any difference. The item renderer's color is affected by alternatingItemColors. In the Spark theme, by default, item renderers are transparent (alternatingItemColors = undefined); however, in the Mobile theme, item renderers are opaque by default (alternatingItemColors = 0xFFFFFF).

The default value for the Spark theme is 0xFFFFFF. The default value for the Mobile theme is 0xF0F0F0.

SkinnableTextBase
  
focusAlpha
Type: Number CSS Inheritance: No Theme: spark, mobile
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The alpha of the focus ring for this component.
SkinnableTextBase
  
focusColor
Type: uint Format: Color CSS Inheritance: Yes Theme: spark, mobile
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Color of focus ring when the component is in focus.
SkinnableTextBase
  
leading
Type: Number Format: Length CSS Inheritance: Yes Theme: mobile
Language Version: ActionScript 3.0  Product Version: Flex 4.5  Runtime Versions: Flash10.1, AIR 2.0

Additional vertical space between lines of text.

For the Spark theme, this is not supported. See lineHeight.

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableStageText Style fontWeight and if using StyleableStageText, this is not supported.

Related API Elements

SkinnableTextBase
  
letterSpacing
Type: Number CSS Inheritance: Yes Theme: mobile
Language Version: ActionScript 3.0  Product Version: Flex 4.5  Runtime Versions: Flash10.1, AIR 2.0

The number of additional pixels to appear between each character.

For the Spark theme, this is not supported. See trackingLeft and trackingRight.

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField.letterSpacing and if using StyleableStageText, this is not supported.

Related API Elements

SkinnableTextBase
  
showPromptWhenFocused
Type: Boolean CSS Inheritance: Yes Theme: mobile
Language Version: ActionScript 3.0  Product Version: Flex 4.6  Runtime Versions: Flash10.2, AIR 2.5

Controls the visibility of prompt text for this component when it is empty and focused.
SkinnableTextBase
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
  
promptDisplay:IDisplayText
Required: false Part Type: Static
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The Label or other IDisplayText that might be present in any skin assigned to this component.
SkinnableTextBase
  
textDisplay:IEditableText
Required: false Part Type: Static
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

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.


 Skin State Description Defined By
  
disabled
Disabled state.
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5
SkinnableTextBase
  
disabledWithPrompt
Disabled state with prompt.
Language Version: ActionScript 3.0  Product Version: Flex 4.5  Runtime Versions: Flash10.2, AIR 2.5
SkinnableTextBase
  
normal
Normal state.
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5
SkinnableTextBase
  
normalWithPrompt
Normal state with prompt.
Language Version: ActionScript 3.0  Product Version: Flex 4.5  Runtime Versions: Flash10.2, AIR 2.5
SkinnableTextBase
Effects
 Effect Description Defined By
 Inherited Triggering Event: added
Played when the component is added as a child to a Container.
UIComponent
 Inherited Triggering Event: creationComplete
Played when the component is created.
UIComponent
 Inherited Triggering Event: focusIn
Played when the component gains keyboard focus.
UIComponent
 Inherited Triggering Event: focusOut
Played when the component loses keyboard focus.
UIComponent
 Inherited Triggering Event: hide
Played when the component becomes invisible.
UIComponent
 Inherited Triggering Event: mouseDown
Played when the user presses the mouse button while over the component.
UIComponent
 Inherited Triggering Event: mouseUp
Played when the user releases the mouse button while over the component.
UIComponent
 Inherited Triggering Event: move
Played when the component is moved.
UIComponent
 Inherited Triggering Event: removed
Played when the component is removed from a Container.
UIComponent
 Inherited Triggering Event: resize
Played when the component is resized.
UIComponent
 Inherited Triggering Event: rollOut
Played when the user rolls the mouse so it is no longer over the component.
UIComponent
 Inherited Triggering Event: rollOver
Played when the user rolls the mouse over the component.
UIComponent
 Inherited Triggering Event: show
Played when the component becomes visible.
UIComponent
Public Constants
 ConstantDefined By
Property Detail
    

autoCapitalize

property
autoCapitalize:String

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

Hint indicating what captialization behavior soft keyboards should use.

Supported values are defined in flash.text.AutoCapitalize:

  • "none" - no automatic capitalization
  • "word" - capitalize the first letter following any space or punctuation
  • "sentence" - captitalize the first letter following any period
  • "all" - capitalize every letter

For the Spark theme, this is not supported.

The default value is "none".



Implementation
    public function get autoCapitalize():String
    public function set autoCapitalize(value:String):void

Related API Elements

    

autoCorrect

property 
autoCorrect:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4.6
Runtime Versions: AIR 3.0

Hint indicating whether a soft keyboard should use its auto-correct behavior, if supported.

For the Spark theme, this is not supported.

The default value is true.



Implementation
    public function get autoCorrect():Boolean
    public function set autoCorrect(value:Boolean):void

displayAsPassword

property 
displayAsPassword:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Specifies whether the text field is a password text field. If the value of this property is true, the text field is treated as a password text field and hides the input characters using asterisks instead of the actual characters. If false, the text field is not treated as a password text field. When password mode is enabled, the Cut and Copy commands and their corresponding keyboard shortcuts will not function. This security mechanism prevents an unscrupulous user from using the shortcuts to discover a password on an unattended computer.

The default value is false.



Implementation
    public function get displayAsPassword():Boolean
    public function set displayAsPassword(value:Boolean):void

editable

property 
editable:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Specifies whether the text is editable.

For the Spark theme, see spark.components.RichEditableText.editable

For the Mobile theme, see spark.components.supportClasses.StyleableStageText.editable

The default value is true.



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

Related API Elements

enableIME

property 
enableIME:Boolean  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

A flag that indicates whether the IME should be enabled when the component receives focus.

For the Mobile theme, this is not supported.



Implementation
    public function get enableIME():Boolean

Related API Elements

imeMode

property 
imeMode:String

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Specifies the IME (input method editor) mode.

For the Spark theme, see spark.components.RichEditableText.imeMode

For the Mobile theme, this is not supported.

The default value is null.



Implementation
    public function get imeMode():String
    public function set imeMode(value:String):void

Related API Elements

maxChars

property 
maxChars:int

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The maximum number of characters that the text field can contain, as entered by a user. A script can insert more text than maxChars allows; the maxChars property indicates only how much text a user can enter. If the value of this property is 0, a user can enter an unlimited amount of text.

The default value is 0.



Implementation
    public function get maxChars():int
    public function set maxChars(value:int):void

prompt

property 
prompt:String

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10.2, AIR 2.0

Text to be displayed if/when the actual text property is an empty string.

Prompt text appears when the text control is first created. Prompt text disappears when the control gets focus or when the control’s text property is a non-empty string. Prompt text reappears when the control loses focus, but only if no text was entered (if the value of the text field is the empty string).

For text controls, if the user enters text, but later deletes it, the prompt text reappears when the control loses focus. You can also cause the prompt text to reappear programmatically by setting the text control’s text property to the empty string.

You can change the style of the prompt text with CSS. If the control has prompt text and is not disabled, the style is defined by the normalWithPrompt pseudo selector. If the control is disabled, then the styles defined by the disabledWithPrompt pseudo selector are used.

The following example CSS changes the color of the prompt text in controls that sub-class SkinnableTextBase (this includes the Spark TextInput and TextArea controls):

      @namespace s "library://ns.adobe.com/flex/spark";
      s|SkinnableTextBase:normalWithPrompt {
          color: #CCCCFF;
      }
      

The default value is null.



Implementation
    public function get prompt():String
    public function set prompt(value:String):void

restrict

property 
restrict:String

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Indicates the set of characters that a user can enter into the text field. If the value of the restrict property is null, you can enter any character. If the value of the restrict property is an empty string, you cannot enter any character. If the value of the restrict property is a string of characters, you can enter only characters in the string into the text field. The string is scanned from left to right. You can specify a range by using the hyphen (-) character. Only user interaction is restricted; a script can put any text into the text field. This property does not synchronize with the Embed font options in the Property inspector.

If the string begins with a caret (^) character, all characters are initially accepted and succeeding characters in the string are excluded from the set of accepted characters. If the string does not begin with a caret (^) character, no characters are initially accepted and succeeding characters in the string are included in the set of accepted characters.

The following example allows only uppercase characters, spaces, and numbers to be entered into a text field:

     my_txt.restrict = "A-Z 0-9";
     

The following example includes all characters, but excludes lowercase letters:

     my_txt.restrict = "^a-z";
     

You can use a backslash to enter a ^ or - verbatim. The accepted backslash sequences are \-, \^ or \\. The backslash must be an actual character in the string, so when specified in ActionScript, a double backslash must be used. For example, the following code includes only the dash (-) and caret (^):

     my_txt.restrict = "\\-\\^";
     

The ^ can be used anywhere in the string to toggle between including characters and excluding characters. The following code includes only uppercase letters, but excludes the uppercase letter Q:

     my_txt.restrict = "A-Z^Q";
     

You can use the \u escape sequence to construct restrict strings. The following code includes only the characters from ASCII 32 (space) to ASCII 126 (tilde).

     my_txt.restrict = "\u0020-\u007E";
     

The default value is null.



Implementation
    public function get restrict():String
    public function set restrict(value:String):void
    

returnKeyLabel

property 
returnKeyLabel:String

Language Version: ActionScript 3.0
Product Version: Flex 4.6
Runtime Versions: AIR 3.0

Hint indicating what label should be displayed for the return key on soft keyboards.

Supported values are defined in flash.text.ReturnKeyLabel:

  • "default" - default icon or label text
  • "done" - icon or label text indicating completed text entry
  • "go" - icon or label text indicating that an action should start
  • "next" - icon or label text indicating a move to the next field
  • "search" - icon or label text indicating that the entered text should be searched for

For the Spark theme, this is not supported.

The default value is "default".



Implementation
    public function get returnKeyLabel():String
    public function set returnKeyLabel(value:String):void

Related API Elements

selectable

property 
selectable:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

A flag indicating whether the content is selectable. On a Desktop, a user can select content with the mouse or with the keyboard when the control has keyboard focus. On a touch interaction device, a user can select text with their fingers once they've entered into selection mode for the text component.

For the Spark theme, see spark.components.RichEditableText.selectable

For the Mobile theme, see spark.components.supportClasses.StyleableStageText.selectable

The default value is true.



Implementation
    public function get selectable():Boolean
    public function set selectable(value:Boolean):void

Related API Elements

selectionActivePosition

property 
selectionActivePosition:int  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

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.

For the Spark theme, see spark.components.RichEditableText.selectionActivePosition

For the Mobile theme, see spark.components.supportClasses.StyleableStageText.selectionActivePosition

This property can be used as the source for data binding. When this property is modified, it dispatches the selectionChange event.



Implementation
    public function get selectionActivePosition():int

Related API Elements

selectionAnchorPosition

property 
selectionAnchorPosition:int  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

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.

For the Spark theme, see spark.components.RichEditableText.selectionAnchorPosition

For the Mobile theme, see spark.components.supportClasses.StyleableStageText.selectionAnchorPosition

This property can be used as the source for data binding. When this property is modified, it dispatches the selectionChange event.



Implementation
    public function get selectionAnchorPosition():int

Related API Elements

selectionHighlighting

property 
selectionHighlighting:String

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Determines when the text selection is highlighted.

For the Spark theme, see spark.components.RichEditableText.selectionHighlighting

For the Mobile theme, this is not supported.

The default value is TextSelectionHighlighting.WHEN_FOCUSED.



Implementation
    public function get selectionHighlighting():String
    public function set selectionHighlighting(value:String):void

Related API Elements

    

softKeyboardType

property 
softKeyboardType:String

Language Version: ActionScript 3.0
Product Version: Flex 4.6
Runtime Versions: AIR 3.0

Hint indicating what kind of soft keyboard should be displayed for this component.

Supported values are defined in flash.text.SoftKeyboardType:

  • "default" - the default keyboard
  • "punctuation" - puts the keyboard into punctuation/symbol entry mode
  • "url" - present soft keys appropriate for URL entry, such as a specialized key that inserts '.com'
  • "number" - puts the keyboard into numeric keypad mode
  • "contact" - puts the keyboard into a mode appropriate for entering contact information
  • "email" - puts the keyboard into e-mail addres entry mode, which may make it easier to enter the at sign or '.com'

For the Spark theme, this is not supported.

The default value is "default".



Implementation
    public function get softKeyboardType():String
    public function set softKeyboardType(value:String):void

Related API Elements

text

property 
text:String

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The text displayed by this text component.

For the Spark theme, see spark.components.RichEditableText.text

For the Mobile theme, see spark.components.supportClasses.StyleableStageText#text

The default value is "".



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

Related API Elements

typicalText

property 
typicalText:String

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Text that is used to determine the default width and height of the control, without actually being displayed.

For the Spark theme, see spark.components.RichEditableText.typicalText

For the Mobile theme, this is not supported.

The default value is null.



Implementation
    public function get typicalText():String
    public function set typicalText(value:String):void

Related API Elements

Constructor Detail

SkinnableTextBase

()Constructor
public function SkinnableTextBase()

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Constructor.

Method Detail

appendText

()method
public function appendText(text:String):void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.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.

Related API Elements

insertText

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

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.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.

Related API Elements

selectAll

()method 
public function selectAll():void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Selects all of the text.

Related API Elements

selectRange

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

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.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.

Related API Elements

Event Detail

change

Event
Event Object Type: spark.events.TextOperationEvent
property TextOperationEvent.type = spark.events.TextOperationEvent.CHANGE

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Dispatched after a user editing operation is complete.

The TextOperationEvent.CHANGE constant defines the value of the type property of the event object for a change event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
operationThe FlowOperation object describing the editing operation being performed on the text by the user.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

changing

Event  
Event Object Type: spark.events.TextOperationEvent
property TextOperationEvent.type = spark.events.TextOperationEvent.CHANGING

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Dispatched before a user editing operation occurs. You can alter the operation, or cancel the event to prevent the operation from being processed.

For the Mobile theme, this is not dispatched.

The TextOperationEvent.CHANGING constant defines the value of the type property of the event object for a changing event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
operationThe FlowOperation object describing the editing operation being performed on the text by the user.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

selectionChange

Event  
Event Object Type: mx.events.FlexEvent
property FlexEvent.type = mx.events.FlexEvent.SELECTION_CHANGE

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Dispached after the selectionAnchorPosition and/or selectionActivePosition properties have changed for any reason.

For the Mobile theme, this is not dispatched.

The FlexEvent.SELECTION_CHANGE constant defines the value of the type property of the event object for a selectionChange event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

textInput

Event  
Event Object Type: flash.events.TextEvent
property TextEvent.type = flash.events.TextEvent.TEXT_INPUT

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Dispatched when a keystroke is about to be input to the component.

For the Mobile theme, this is not dispatched.

Defines the value of the type property of a textInput event object.

Note: This event is not dispatched for the Delete or Backspace keys.

This event has the following properties:

PropertyValue
bubblestrue
cancelabletrue; call the preventDefault() method to cancel default behavior.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe text field into which characters are being entered. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.
textThe character or sequence of characters entered by the user.