| Package | spark.components.supportClasses |
| Class | public class SkinnableTextBase |
| Inheritance | SkinnableTextBase  SkinnableComponent UIComponent FlexSprite flash.display.Sprite |
| Implements | IFocusManagerComponent, IIMESupport, spark.core.ISoftKeyboardHintClient |
| Subclasses | TextArea, TextInput |
| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Hide MXML SyntaxThe <s:SkinnableTextBase> tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
Show MXML Syntax
<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]
/>
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | |
 autoCapitalize : String
Hint indicating what captialization behavior soft keyboards should
use. | SkinnableTextBase | ||
| autoCorrect : Boolean
Hint indicating whether a soft keyboard should use its auto-correct
behavior, if supported. | SkinnableTextBase | ||
| automationDelegate : Object
The delegate object that handles the automation-related functionality. | UIComponent | |
| automationEnabled : Boolean [read-only]
True if this component is enabled for automation, false
otherwise. | UIComponent | |
| automationName : String
Name that can be used as an identifier for this object. | UIComponent | |
| automationOwner : DisplayObjectContainer [read-only]
The owner of this component for automation purposes. | UIComponent | |
| automationParent : DisplayObjectContainer [read-only]
The parent of this component for automation purposes. | UIComponent | |
| automationTabularData : Object [read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : Array [read-only]
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application. | UIComponent | |
| automationVisible : Boolean [read-only]
True if this component is visible for automation, false
otherwise. | UIComponent | |
| baseline : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| baselinePosition : Number [override] [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | SkinnableComponent | |
| bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | |
| className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | |
| contentMouseX : Number [read-only]
Returns the x position of the mouse, in the content coordinate system. | UIComponent | |
| contentMouseY : Number [read-only]
Returns the y position of the mouse, in the content coordinate system. | UIComponent | |
| currentState : String
The current view state of the component. | UIComponent | |
| cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers. | UIComponent | |
| depth : Number
Determines the order in which items inside of containers
are rendered. | UIComponent | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | UIComponent | |
| displayAsPassword : Boolean | SkinnableTextBase | ||
| document : Object
A reference to the document object associated with this UIComponent. | UIComponent | |
| doubleClickEnabled : Boolean [override]
Specifies whether the UIComponent object receives doubleClick events. | UIComponent | |
| editable : Boolean
Specifies whether the text is editable. | SkinnableTextBase | ||
| enabled : Boolean
Whether the component can accept user interaction. | UIComponent | |
| enableIME : Boolean [read-only]
A flag that indicates whether the IME should
be enabled when the component receives focus. | SkinnableTextBase | ||
| errorString : String
The text that displayed by a component's error tip when a
component is monitored by a Validator and validation fails. | UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UIComponent | |
| explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | |
| focusPane : Sprite
The focus pane associated with this object. | UIComponent | |
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | |
| hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | UIComponent | |
| height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| id : String
ID of the component. | UIComponent | |
| imeMode : String
Specifies the IME (input method editor) mode. | SkinnableTextBase | ||
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles. | UIComponent | |
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required). | UIComponent | |
| instanceIndex : int [read-only]
The index of a repeated component. | UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document. | UIComponent | |
| is3D : Boolean [read-only]
Contains true when the element is in 3D. | UIComponent | |
| isDocument : Boolean [read-only]
Contains true if this UIComponent instance is a document object. | UIComponent | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | |
| left : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| maxChars : int | SkinnableTextBase | ||
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| maxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels. | UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels. | UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels. | UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels. | UIComponent | |
| minHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| moduleFactory : IFlexModuleFactory
A module factory is used as context for using embedded fonts and for
finding the style manager that controls the styles for this
component. | UIComponent | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| MXMLDescriptor : Array [read-only] | UIComponent | |
| MXMLProperties : Array [read-only] | UIComponent | |
| nestLevel : int
Depth of this object in the containment hierarchy. | UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | UIComponent | |
| numAutomationChildren : int [read-only]
The number of automation children this container has. | UIComponent | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | UIComponent | |
| parent : DisplayObjectContainer [override] [read-only]
The parent container or component for this component. | UIComponent | |
| parentApplication : Object [read-only]
A reference to the Application object that contains this UIComponent
instance. | UIComponent | |
| parentDocument : Object [read-only]
A reference to the parent document object for this UIComponent. | UIComponent | |
| percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | UIComponent | |
| percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | UIComponent | |
| postLayoutTransformOffsets : TransformOffsets
Defines a set of adjustments that can be applied to the object's
transform in a way that is invisible to its parent's layout. | UIComponent | |
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| prompt : String
Text to be displayed if/when the actual text property is an empty string. | SkinnableTextBase | ||
| repeater : IRepeater [read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent. | UIComponent | |
| repeaterIndex : int [read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent. | UIComponent | |
| repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent. | UIComponent | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent. | UIComponent | |
| restrict : String | SkinnableTextBase | ||
| returnKeyLabel : String
Hint indicating what label should be displayed for the return key on
soft keyboards. | SkinnableTextBase | ||
| right : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| rotation : Number [override] | UIComponent | |
| rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationZ : Number [override]
| UIComponent | |
| scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | |
| scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | |
| scaleZ : Number [override]
Number that specifies the scaling factor along the z axis. | UIComponent | |
| screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | |
| selectable : Boolean
A flag indicating whether the content is selectable. | SkinnableTextBase | ||
| selectionActivePosition : int [read-only]
A character position, relative to the beginning of the
text String, specifying the end of the selection
that moves when the selection is extended with the arrow keys. | SkinnableTextBase | ||
| selectionAnchorPosition : int [read-only]
A character position, relative to the beginning of the
text String, specifying the end of the selection
that stays fixed when the selection is extended with the arrow keys. | SkinnableTextBase | ||
| selectionHighlighting : String
Determines when the text selection is highlighted. | SkinnableTextBase | ||
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| skin : UIComponent [read-only]
The instance of the skin class for this component instance. | SkinnableComponent | |
| softKeyboardType : String
Hint indicating what kind of soft keyboard should be displayed for
this component. | SkinnableTextBase | ||
| states : Array
The view states that are defined for this component. | UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | UIComponent | |
| styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | UIComponent | |
| styleName : Object
The class style used by this component. | UIComponent | |
| styleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors. | UIComponent | |
| suggestedFocusSkinExclusions : Array [read-only]
Lists the skin parts that are
excluded from bitmaps captured and used to
show focus. | SkinnableComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | |
| tabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus
via the TAB key
This is similar to the tabEnabled property
used by the Flash Player.
This is usually true for components that
handle keyboard input, but some components in controlbars
have them set to false because they should not steal
focus from another component like an editor. | UIComponent | |
| text : String
The text displayed by this text component. | SkinnableTextBase | ||
| toolTip : String
Text to display in the ToolTip. | UIComponent | |
| top : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| transform : Transform [override]
An object with properties pertaining to a display object's matrix, color transform,
and pixel bounds. | UIComponent | |
| transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | |
| transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | |
| transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object. | UIComponent | |
| typicalText : String
Text that is used to determine
the default width and height of the control,
without actually being displayed. | SkinnableTextBase | ||
| uid : String
A unique identifier for the object. | UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required). | UIComponent | |
| validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | |
| verticalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| visible : Boolean [override]
Whether or not the display object is visible. | UIComponent | |
| width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| x : Number [override]
Number that specifies the component's horizontal position,
in pixels, within its parent container. | UIComponent | |
| y : Number [override]
Number that specifies the component's vertical position,
in pixels, within its parent container. | UIComponent | |
| z : Number [override]
| UIComponent | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | SkinnableTextBase | ||
| addStyleClient(styleClient:IAdvancedStyleClient):void
Adds a non-visual style client to this component instance. | UIComponent | |
appendText(text:String):void
Appends the specified text to the end of the text component,
as if you had clicked at the end and typed. | SkinnableTextBase | ||
| callLater(method:Function, args:Array = null):void
Queues a function to be called later. | UIComponent | |
| clearStyle(styleProp:String):void
Deletes a style property from this component instance. | UIComponent | |
| contentToGlobal(point:Point):Point
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
| contentToLocal(point:Point):Point
Converts a Point object from content to local coordinates. | UIComponent | |
| createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within
this container. | UIComponent | |
| createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object
Returns a set of properties as automation IDs that identify the child within
this container. | UIComponent | |
| createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
| deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| dispatchEvent(event:Event):Boolean [override]
Dispatches an event into the event flow. | UIComponent | |
| drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component. | UIComponent | |
| drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | |
| effectFinished(effectInst:IEffectInstance):void
Called by the effect instance when it stops playing on the component. | UIComponent | |
| effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component. | UIComponent | |
| endEffectsStarted():void
Ends all currently playing effects on the component. | UIComponent | |
| executeBindings(recurse:Boolean = false):void
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
| finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete. | UIComponent | |
| generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array | UIComponent | |
| generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):* | UIComponent | |
| getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index. | UIComponent | |
| getAutomationChildren():Array
Provides the automation object list . | UIComponent | |
| getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
| getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
| getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance. | UIComponent | |
| getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
| getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
| getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
| getFocus():InteractiveObject
Gets the object that currently has focus. | UIComponent | |
| getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height. | UIComponent | |
| getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width. | UIComponent | |
| getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
| getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
| getLayoutMatrix():Matrix
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
| getLayoutMatrix3D():Matrix3D
Returns the layout transform Matrix3D for this element. | UIComponent | |
| getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height. | UIComponent | |
| getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width. | UIComponent | |
| getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height. | UIComponent | |
| getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width. | UIComponent | |
| getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height. | UIComponent | |
| getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width. | UIComponent | |
| 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 | |
| getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
| getVisibleRect(targetParent:DisplayObject = null):Rectangle
Get the bounds of this object that are visible to the user
on the screen. | UIComponent | |
| globalToContent(point:Point):Point
Converts a Point object from global to content coordinates. | UIComponent | |
| hasCSSState():Boolean
Returns true if currentCSSState is not null. | UIComponent | |
| hasState(stateName:String):Boolean
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
| horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
| initialize():void
Initializes the internal structure of this component. | UIComponent | |
| initializeRepeaterArrays(parent:IRepeaterClient):void
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
insertText(text:String):void
Inserts the specified text into the text component
as if you had typed it. | SkinnableTextBase | ||
| invalidateDisplayList():void
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
| invalidateLayering():void
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
| invalidateLayoutDirection():void
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | |
| invalidateProperties():void
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
| invalidateSize():void
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
| invalidateSkinState():void
Marks the component so that the new state of the skin is set
during a later screen update. | SkinnableComponent | |
| localToContent(point:Point):Point
Converts a Point object from local to content coordinates. | UIComponent | |
| matchesCSSState(cssState:String):Boolean
Returns true if cssState matches currentCSSState. | UIComponent | |
| matchesCSSType(cssType:String):Boolean
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
| measureHTMLText(htmlText:String):TextLineMetrics
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 | |
| measureText(text:String):TextLineMetrics
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 | |
| move(x:Number, y:Number):void
Moves the component to a specified position within its parent. | UIComponent | |
| notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children. | UIComponent | |
| owns(child:DisplayObject):Boolean
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
| parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
| prepareToPrint(target:IFlexDisplayObject):Object
Prepares an IFlexDisplayObject for printing. | UIComponent | |
| regenerateStyleCache(recursive:Boolean):void
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 | |
| registerEffects(effects:Array):void
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
| removeStyleClient(styleClient:IAdvancedStyleClient):void
Removes a non-visual style client from this component instance. | UIComponent | |
| replayAutomatableEvent(event:Event):Boolean
Replays the specified event. | UIComponent | |
| resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided. | UIComponent | |
| resumeBackgroundProcessing():void [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
selectAll():void
Selects all of the text. | SkinnableTextBase | ||
selectRange(anchorIndex:int, activeIndex:int):void
Selects a specified range of characters. | SkinnableTextBase | ||
| setActualSize(w:Number, h:Number):void
Sizes the object. | UIComponent | |
| setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
| setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state. | UIComponent | |
| setFocus():void
Sets the focus to this component. | UIComponent | |
| setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
| setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element. | UIComponent | |
| 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 | |
| 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 | |
| setMXMLDescriptor(value:Array):void | UIComponent | |
| setMXMLProperties(value:Array):void | UIComponent | |
| setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance. | UIComponent | |
| setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes. | UIComponent | |
| styleChanged(styleProp:String):void
Detects changes to style properties. | UIComponent | |
| stylesInitialized():void
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| suspendBackgroundProcessing():void [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
| toString():String [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIComponent | |
| 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 | |
| validateDisplayList():void
Validates the position and size of children and draws other
visuals. | UIComponent | |
| validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
| validateProperties():void
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
| 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 | |
| validationResultHandler(event:ValidationResultEvent):void
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
| verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method. | UIComponent | ||
| Dispatched after a user editing operation is complete. | SkinnableTextBase | |||
| Dispatched before a user editing operation occurs. | SkinnableTextBase | |||
| Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | ||
| Dispatched after the view state has changed. | UIComponent | ||
| Dispatched after the currentState property changes, but before the view state changes. | UIComponent | ||
| Dispatched 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 | ||
| Dispatched by the drop target when the user releases the mouse over it. | UIComponent | ||
| Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | ||
| Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | ||
| Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | ||
| Dispatched by the drag initiator when starting a drag operation. | UIComponent | ||
| Dispatched after an effect ends. | UIComponent | ||
| Dispatched just before an effect starts. | UIComponent | ||
| Dispatched after an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent | ||
| Dispatched after the component has entered a view state. | UIComponent | ||
| Dispatched just before the component exits a view state. | UIComponent | ||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | ||
| Dispatched when the object has moved. | UIComponent | ||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
| Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispached after the selectionAnchorPosition and/or selectionActivePosition properties have changed for any reason. | SkinnableTextBase | |||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| Dispatched after the component has entered a new state and any state transition animation to that state has finished playing. | UIComponent | ||
| Dispatched when a component interrupts a transition to its current state in order to switch to a new state. | UIComponent | ||
| Dispatched when a keystroke is about to be input to the component. | SkinnableTextBase | |||
| Dispatched by the component when it is time to create a ToolTip. | UIComponent | ||
| Dispatched by the component when its ToolTip has been hidden and is to be discarded soon. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be shown. | UIComponent | ||
| Dispatched by the component when its ToolTip has been shown. | UIComponent | ||
| Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIComponent | ||
| A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture. | UIComponent | ||
| A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture. | UIComponent | ||
| A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture. | UIComponent | ||
| Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | ||
| Dispatched when values are changed programmatically or by user interaction. | UIComponent | ||
| Style | Description | Defined By | ||
|---|---|---|---|---|
alignmentBaseline | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
baselineShift | Type: Object CSS Inheritance: yes Amount to shift the baseline. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.baselineShift. For the Mobile theme, this is not supported. See also | SkinnableTextBase | ||
blockProgression | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
borderAlpha | Type: Number CSS Inheritance: no Theme: spark The alpha of the border for this component. | SkinnableTextBase | ||
borderColor | Type: uint Format: Color CSS Inheritance: no Theme: spark, mobile The color of the border for this component. Supported in iOS7+ skins | SkinnableTextBase | ||
borderVisible | Type: Boolean CSS Inheritance: no Theme: spark, mobile Controls the visibility of the border for this component. | SkinnableTextBase | ||
| Type: String CSS Inheritance: no The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. | UIComponent | ||
breakOpportunity | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
cffHinting | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile The main color for a component. | SkinnableComponent | ||
clearFloats | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
color | Type: uint Format: Color CSS Inheritance: yes 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.See also | SkinnableTextBase | ||
columnBreakAfter | Type: String CSS Inheritance: yes Controls column break after the element. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.columnBreakAfter. For the Mobile theme, this is not supported. See also | SkinnableTextBase | ||
columnBreakBefore | Type: String CSS Inheritance: yes Controls column break before the element. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.columnBreakBefore. For the Mobile theme, this is not supported. See also | SkinnableTextBase | ||
containerBreakAfter | Type: String CSS Inheritance: yes Controls container break after the element. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.containerBreakAfter. For the Mobile theme, this is not supported. See also | SkinnableTextBase | ||
containerBreakBefore | Type: String CSS Inheritance: yes Controls container break before the element. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.containerBreakBefore. For the Mobile theme, this is not supported. See also | SkinnableTextBase | ||
contentBackgroundAlpha | Type: Number CSS Inheritance: yes Theme: spark, mobile The alpha of the content background for this component. | SkinnableTextBase | ||
contentBackgroundColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile The color of the content background for this component. For a List, changing The default value for the Spark theme is | SkinnableTextBase | ||
digitCase | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
digitWidth | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
direction | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
dominantBaseline | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
| Type: Class Name of the skin class to use for this component when a validation error occurs. | SkinnableComponent | ||
firstBaselineOffset | Type: Object CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
focusAlpha | Type: Number CSS Inheritance: no Theme: spark, mobile The alpha of the focus ring for this component. | SkinnableTextBase | ||
| Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent | ||
focusColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile Color of focus ring when the component is in focus. | SkinnableTextBase | ||
focusedTextSelectionColor | Type: uint Format: Color CSS Inheritance: yes The color of text when the component is enabled and has focus. For the Mobile theme, this is not supported. | SkinnableTextBase | ||
| Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: no Thickness, in pixels, of the focus rectangle outline. | UIComponent | ||
fontFamily | Type: String CSS Inheritance: yes 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 See also | SkinnableTextBase | ||
fontLookup | Type: String CSS Inheritance: yes Font lookup to use. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontLookup For the Mobile theme, this is not supported. See also | SkinnableTextBase | ||
fontSize | Type: Number Format: Length CSS Inheritance: yes 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 See also | SkinnableTextBase | ||
fontStyle | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
fontWeight | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
inactiveTextSelectionColor | Type: uint Format: Color CSS Inheritance: yes The color of text when the component is disabled. For the Mobile theme, this is not supported. | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes The primary interaction mode for this component. See also | UIComponent | ||
justificationRule | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
justificationStyle | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
kerning | Type: String CSS Inheritance: yes 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 For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.kerning For the Mobile theme, this is not supported. See also | SkinnableTextBase | ||
| Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. See also | UIComponent | ||
leading | Type: Number Format: Length CSS Inheritance: yes Theme: mobile Additional vertical space between lines of text.
For the Spark theme, this is not supported. See For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableStageText Style fontWeight and if using StyleableStageText, this is not supported. See also | SkinnableTextBase | ||
leadingModel | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
| Type: String CSS Inheritance: no The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | UIComponent | ||
letterSpacing | Type: Number CSS Inheritance: yes Theme: mobile The number of additional pixels to appear between each character.
For the Spark theme, this is not supported. See For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField.letterSpacing and if using StyleableStageText, this is not supported. See also | SkinnableTextBase | ||
ligatureLevel | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
lineBreak | Type: String CSS Inheritance: no Controls word wrapping within the container. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.blockProgression. For the Mobile theme, this is not supported. See also | SkinnableTextBase | ||
lineHeight | Type: Object CSS Inheritance: yes Leading controls for the text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.lineHeight.
For the Mobile theme, this is not supported. See See also | SkinnableTextBase | ||
lineThrough | Type: Boolean CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
listAutoPadding | Type: Number Format: length CSS Inheritance: yes This specifies an auto indent for the start edge of lists when the padding value of the list on that side is auto.
For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.listAutoPadding. For the Mobile theme, this is not supported. See also | SkinnableTextBase | ||
listStylePosition | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
listStyleType | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
locale | Type: String CSS Inheritance: yes 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 When using the Spark formatters and globalization classes, you can set this style on the
root application to the value of the undefined.See also | SkinnableTextBase | ||
paddingBottom | Type: Number Format: Length CSS Inheritance: no Bottom inset, in pixels. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paddingBottom. For the Mobile theme, this is not supported. See also | SkinnableTextBase | ||
paddingLeft | Type: Number Format: Length CSS Inheritance: no Left inset, in pixels. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paddingLeft. For the Mobile theme, this is not supported. See also | SkinnableTextBase | ||
paddingRight | Type: Number Format: Length CSS Inheritance: no Right inset, in pixels. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paddingRight. For the Mobile theme, this is not supported. See also | SkinnableTextBase | ||
paddingTop | Type: Number Format: Length CSS Inheritance: no Top inset, in pixels. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paddingRight. For the Mobile theme, this is not supported. See also | SkinnableTextBase | ||
paragraphEndIndent | Type: Number Format: length CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
paragraphSpaceAfter | Type: Number Format: length CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
paragraphSpaceBefore | Type: Number Format: length CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
paragraphStartIndent | Type: Number Format: length CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
renderingMode | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
| Type: String CSS Inheritance: no The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. | UIComponent | ||
| Type: Boolean CSS Inheritance: yes Show the error border or skin when this component is invalid. | UIComponent | ||
| Type: Boolean CSS Inheritance: yes Show the error tip when this component is invalid and the user rolls over it. | UIComponent | ||
showPromptWhenFocused | Type: Boolean CSS Inheritance: yes Theme: mobile Controls the visibility of prompt text for this component when it is empty and focused. | SkinnableTextBase | ||
| Type: Class Name of the skin class to use for this component. | SkinnableComponent | ||
tabStops | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
textAlign | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
textAlignLast | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
textAlpha | Type: Number CSS Inheritance: yes Alpha (transparency) value for the text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textAlpha For the Mobile theme, this is not supported. See also | SkinnableTextBase | ||
textDecoration | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
textIndent | Type: Number Format: Length CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
textJustify | Type: String CSS Inheritance: yes Specifies options for justifying text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textJustify For the Mobile theme, this is not supported. See also | SkinnableTextBase | ||
textRotation | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
| Type: String CSS Inheritance: no The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent | ||
trackingLeft | Type: Object CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
trackingRight | Type: Object CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
typographicCase | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
unfocusedTextSelectionColor | Type: uint Format: Color CSS Inheritance: yes 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 Vertical alignment or justification. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.verticalAlign. For the Mobile theme, this is not supported. See also | SkinnableTextBase | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
whiteSpaceCollapse | Type: String CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
wordSpacing | Type: Object CSS Inheritance: yes 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. See also | SkinnableTextBase | ||
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 The Label or other IDisplayText that might be present in any skin assigned to this component. | SkinnableTextBase | ||
textDisplay:IEditableText | Required: false Part Type: Static The IEditableText that may be present in any skin assigned to this component. This is RichEditableText for the Spark theme and StyleableStageText/ScrollableStageText for the Mobile theme. | SkinnableTextBase | ||
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.
| 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 letterFor the Spark theme, this is not supported.
The default value is "none".
public function get autoCapitalize():String public function set autoCapitalize(value:String):voidSee also
| 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.
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 |
The default value is false.
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.
public function get editable():Boolean public function set editable(value:Boolean):voidSee also
| 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.
public function get enableIME():BooleanSee also
| 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.
public function get imeMode():String public function set imeMode(value:String):voidSee also
| maxChars | property |
maxChars:int| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
The default value is 0.
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.
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 |
The default value is null.
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 forFor the Spark theme, this is not supported.
The default value is "default".
public function get returnKeyLabel():String public function set returnKeyLabel(value:String):voidSee also
| 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.
public function get selectable():Boolean public function set selectable(value:Boolean):voidSee also
| 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.
public function get selectionActivePosition():intSee also
| 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.
public function get selectionAnchorPosition():intSee also
| 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.
public function get selectionHighlighting():String public function set selectionHighlighting(value:String):voidSee also
| 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".
public function get softKeyboardType():String public function set softKeyboardType(value:String):voidSee also
| 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 "".
public function get text():String public function set text(value:String):voidSee also
| 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.
public function get typicalText():String public function set typicalText(value:String):voidSee also
| SkinnableTextBase | () | Constructor |
public function SkinnableTextBase()| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Constructor.
| 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.
|
See also
| 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.
|
See also
| 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.
See also
| 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.
|
See also
| change | Event |
spark.events.TextOperationEventspark.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.
TheTextOperationEvent.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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
operation | The FlowOperation object describing the editing operation being performed on the text by the user. |
target | The 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 |
spark.events.TextOperationEventspark.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.
TheTextOperationEvent.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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | true |
currentTarget | The 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. |
operation | The FlowOperation object describing the editing operation being performed on the text by the user. |
target | The 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 |
mx.events.FlexEventmx.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.
TheFlexEvent.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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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 |
flash.events.TextEventflash.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.