| Package | spark.components.supportClasses |
| Class | public class ScrollableStageText |
| Inheritance | ScrollableStageText  UIComponent FlexSprite flash.display.Sprite |
| Implements | IStyleableEditableText, spark.core.ISoftKeyboardHintClient, IProxiedStageTextWrapper |
| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.12 |
| Runtime Versions : | AIR 3.0 |
StageText allows for better text entry and manipulation experiences on mobile devices using native text fields. The native fields provide correct visuals, text spacing and reflow, selection behavior, and text entry assistance. This class can also be used on desktop platforms where it behaves as a wrapper around TextField.
The padding around native text controls may be different than the padding around TextField controls.Similiar to other native applications, when you tap outside of the native text field, the text field gives up focus and the soft keyboard goes away. This differs from when you tap outside of a TextField and the focus stays in the TextField and the soft keyboard remains visible.
Limitation of StageText-based controls:
text is always selectable.See also
| 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. | ScrollableStageText | ||
| autoCorrect : Boolean
Hint indicating whether a soft keyboard should use its auto-correct
behavior, if supported. | ScrollableStageText | ||
| 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 [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | UIComponent | |
| 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
Specifies whether the text field is a password text field. | ScrollableStageText | ||
| 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
Flag that indicates whether the text in the field is editable. | ScrollableStageText | ||
| enabled : Boolean
Whether the component can accept user interaction. | UIComponent | |
| 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 | |
| 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 | ScrollableStageText | ||
| 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 | |
| multiline : Boolean | ScrollableStageText | ||
| 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 | |
| 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 | ScrollableStageText | ||
| returnKeyLabel : String
Hint indicating what label should be displayed for the return key on
soft keyboards. | ScrollableStageText | ||
| 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 | |
| selectionActivePosition : int [read-only]
The active, or last clicked position, of the selection. | ScrollableStageText | ||
| selectionAnchorPosition : int [read-only]
The anchor, or first clicked position, of the selection. | ScrollableStageText | ||
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| softKeyboardType : String
Hint indicating what kind of soft keyboard should be displayed for this
component. | ScrollableStageText | ||
| 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 | |
| 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
A string that is the current text in the text field. | ScrollableStageText | ||
| 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 | |
| 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 | |
| Property | Defined By | ||
|---|---|---|---|
| currentCSSState : String [read-only]
The state to be used when matching CSS pseudo-selectors. | UIComponent | |
| debugId : String [read-only] | ScrollableStageText | ||
| defaultStyles : Object [static]
StageText does not support setting its style-like properties to null or
undefined to restore their default values. | ScrollableStageText | ||
| densityScale : Number [read-only]
The scale factor necessary to account for differences in the design
resolution of the application (applicationDPI) and the resolution of the
device the application is running on. | ScrollableStageText | ||
| _displayAsPassword : Boolean
Storage for the displayAsPassword property. | ScrollableStageText | ||
| _editable : Boolean = true
Storage for the editable property. | ScrollableStageText | ||
| hasComplexLayoutMatrix : Boolean [read-only]
Returns true if the UIComponent has any non-translation (x,y) transform properties. | UIComponent | |
| hiddenFocusStageText : StageText = null [static] | ScrollableStageText | ||
| invalidateStyleFlag : Boolean = true
Flag indicating one or more styles have changed. | ScrollableStageText | ||
| lastFocusedStageText : StageText [static] | ScrollableStageText | ||
| _maxChars : int
Storage for the maxChars property. | ScrollableStageText | ||
| _multiline : Boolean
Storage for the multiline property. | ScrollableStageText | ||
| proxy : DisplayObject = null
To be displayed when out of focus
| ScrollableStageText | ||
| resourceManager : IResourceManager [read-only]
A reference to the object which manages
all of the application's localized resources. | UIComponent | |
| _restrict : String
Storage for the restrict property. | ScrollableStageText | ||
| stageText : StageText
The runtime StageText object that this field uses for text display and
editing. | ScrollableStageText | ||
| supportedStyles : String = textAlign fontFamily fontWeight fontStyle fontSize color locale [static] | ScrollableStageText | ||
| unscaledHeight : Number [read-only]
A convenience method for determining the unscaled height
of the component. | UIComponent | |
| unscaledWidth : 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 | |
| Method | Defined By | ||
|---|---|---|---|
| ScrollableStageText(multiline:Boolean = false)
Constructor. | ScrollableStageText | ||
| 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. | ScrollableStageText | ||
| 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. | ScrollableStageText | ||
| 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 | |
keepSoftKeyboardActive():void
this method is called between the time a text input get out of focus and the next text input gets in focus
to prevent the soft keyboard from disappearing. | ScrollableStageText | ||
| 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 | |
prepareForTouchScroll():void
this method is called before a touch scroll is about to occur, so that component can hide the StageText and show the proxies
| ScrollableStageText | ||
| 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. | ScrollableStageText | ||
| selectRange(anchorIndex:int, activeIndex:int):void
Selects a specified range of characters. | ScrollableStageText | ||
| 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 | |
| Method | Defined By | ||
|---|---|---|---|
addedToStageHandler(event:Event):void | ScrollableStageText | ||
| addMXMLChildren(comps:Array):void | UIComponent | |
| adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle. | UIComponent | |
| applyComputedMatrix():void
Commits the computed matrix built from the combination of the layout
matrix and the transform offsets to the flash displayObject's transform. | UIComponent | |
| attachOverlay():void
This is an internal method used by the Flex framework
to support the Dissolve effect. | UIComponent | |
| canSkipMeasurement():Boolean
Determines if the call to the measure() method can be skipped. | UIComponent | |
| childrenCreated():void
Performs any final processing after child objects are created. | UIComponent | |
| commitProperties():void
Processes the properties set on the component. | UIComponent | |
| createChildren():void
Create child objects of the component. | UIComponent | |
| createInFontContext(classObj:Class):Object
Creates a new object using a context
based on the embedded font being used. | UIComponent | |
| createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object
Creates the object using a given moduleFactory. | UIComponent | |
createProxy():DisplayObject | ScrollableStageText | ||
| dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | |
disposeProxy():void Dispose the proxy resources once it has been removed from the stage | ScrollableStageText | ||
endTextEdit():Boolean | ScrollableStageText | ||
| focusInHandler(event:FocusEvent):void
The event handler called when a UIComponent object gets focus. | UIComponent | |
| focusOutHandler(event:FocusEvent):void
The event handler called when a UIComponent object loses focus. | UIComponent | |
| generateMXMLAttributes(data:Array):void | UIComponent | |
| generateMXMLInstances(document:Object, data:Array, recursive:Boolean = true):void | UIComponent | |
| generateMXMLObject(document:Object, data:Array):Object | UIComponent | |
getGlobalViewPort():Rectangle | ScrollableStageText | ||
| initAdvancedLayoutFeatures():void
Initializes the implementation and storage of some of the less frequently
used advanced layout features of a component. | UIComponent | |
| initializationComplete():void
Finalizes the initialization of this component. | UIComponent | |
| initializeAccessibility():void
Initializes this component's accessibility code. | UIComponent | |
|
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true). | UIComponent | |
| isOurFocus(target:DisplayObject):Boolean
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus. | UIComponent | |
| keyDownHandler(event:KeyboardEvent):void
The event handler called for a keyDown event. | UIComponent | |
| keyUpHandler(event:KeyboardEvent):void
The event handler called for a keyUp event. | UIComponent | |
| measure():void
Calculates the default size, and optionally the default minimum size,
of the component. | UIComponent | |
measureTextLineHeight():Number
StageText does not have any provision for measuring text. | ScrollableStageText | ||
removedFromStageHandler(event:Event):void | ScrollableStageText | ||
| resourcesChanged():void
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 | |
restoreStageText():void | ScrollableStageText | ||
| setStretchXY(stretchX:Number, stretchY:Number):void
Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent | |
stageText_changeHandler(event:Event):void | ScrollableStageText | ||
stageText_completeHandler(event:Event):void | ScrollableStageText | ||
startTextEdit():Boolean | ScrollableStageText | ||
| 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 | |
| updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Draws the object and/or sizes and positions its children. | UIComponent | |
updateProxy():void
Replace the existing proxy image representing this StageText with a new
one. | ScrollableStageText | ||
updateViewPort():void
Tell the StageText what rectangle it needs to render in. | ScrollableStageText | ||
| 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. | ScrollableStageText | |||
| 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 if the StageText is not multiline and the user presses the enter key. | ScrollableStageText | |||
| Dispatched after the component has entered a view state. | UIComponent | ||
| Dispatched just before the component exits a view state. | UIComponent | ||
| Dispatched after the native text control gains focus. | ScrollableStageText | |||
| Dispatched after the native text control loses focus. | ScrollableStageText | |||
| 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 | ||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| Dispatched when a soft keyboard is displayed. | ScrollableStageText | |||
| Dispatched immediately before a soft keyboard is displayed. | ScrollableStageText | |||
| Dispatched when a soft keyboard is lowered or hidden. | ScrollableStageText | |||
| 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 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 | ||
|---|---|---|---|---|
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
| Type: String CSS Inheritance: no The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark The main color for a component. | UIComponent | ||
color | Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. The default value is 0x000000. | ScrollableStageText | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
| Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent | ||
| 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 Name of the font to use. Unlike in a full CSS implementation, comma-separated lists are not supported. You can use any font family name. If you specify a generic font name, it is converted to an appropriate device font. The default value is "_sans". | ScrollableStageText | ||
fontSize | Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. The default value is 24. | ScrollableStageText | ||
fontStyle | Type: String CSS Inheritance: yes Determines whether the text is italic font. Recognized values are "normal" and "italic".
The default value is "normal". | ScrollableStageText | ||
fontWeight | Type: String CSS Inheritance: yes Determines whether the text is boldface. Recognized values are "normal" and "bold".
The default value is "normal". | ScrollableStageText | ||
| 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 | ||
| Type: String CSS Inheritance: yes The primary interaction mode for this component. See also | UIComponent | ||
| Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. See also | UIComponent | ||
| 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 | ||
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 | ScrollableStageText | ||
| 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 | ||
textAlign | Type: String CSS Inheritance: yes Alignment of text within a container. Possible values are "start", "end", "left",
"right", or "center".
The default value is "start". | ScrollableStageText | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: halo Theme color of a component. | UIComponent | ||
| Type: String CSS Inheritance: no The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent | ||
| Type: 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 | ||
| Constant | Defined By | ||
|---|---|---|---|
| isAndroid : Boolean [static] | ScrollableStageText | ||
| isDesktop : Boolean [static] | ScrollableStageText | ||
| _displayAsPassword | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected var _displayAsPassword:BooleanStorage for the displayAsPassword property. This is needed because clients may ask for this after the StageText has been disposed.
| _editable | property |
protected var _editable:Boolean = trueStorage for the editable property.
| _maxChars | property |
protected var _maxChars:intStorage for the maxChars property. This is needed because clients may ask for this after the StageText has been disposed.
| _multiline | property |
protected var _multiline:BooleanStorage for the multiline property. This is needed because clients may ask for this after the StageText has been disposed.
| _restrict | property |
protected var _restrict:StringStorage for the restrict property. This is needed because clients may ask for this after the StageText has been disposed.
| autoCapitalize | property |
autoCapitalize:String| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.6 |
| Runtime Versions : | AIR 3.0 |
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 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.
The default value is true.
public function get autoCorrect():Boolean public function set autoCorrect(value:Boolean):void| debugId | property |
debugId:String [read-only] protected function get debugId():String| defaultStyles | property |
protected static var defaultStyles:ObjectStageText does not support setting its style-like properties to null or undefined to restore their default values. So, the first time we create a StageText, store its default values here.
| densityScale | property |
densityScale:Number [read-only] The scale factor necessary to account for differences in the design resolution of the application (applicationDPI) and the resolution of the device the application is running on.
protected function get densityScale():Number| displayAsPassword | property |
displayAsPassword:Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.6 |
| Runtime Versions : | AIR 3.0 |
Specifies whether the text field is a password text field.
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.6 |
| Runtime Versions : | AIR 3.0 |
Flag that indicates whether the text in the field is editable.
The default value is true.
public function get editable():Boolean public function set editable(value:Boolean):void| hiddenFocusStageText | property |
protected static var hiddenFocusStageText:StageText = null| invalidateStyleFlag | property |
protected var invalidateStyleFlag:Boolean = trueFlag indicating one or more styles have changed. If invalidateStyleFlag is false, commitStyles is a no-op, so it is safe to call commitStyles whenever this object is measured or drawn.
| lastFocusedStageText | property |
protected static var lastFocusedStageText:StageText| maxChars | property |
maxChars:int| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.6 |
| Runtime Versions : | AIR 3.0 |
The default value is 0.
public function get maxChars():int public function set maxChars(value:int):void| multiline | property |
multiline:Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.6 |
| Runtime Versions : | AIR 3.0 |
public function get multiline():Boolean public function set multiline(value:Boolean):void| proxy | property |
protected var proxy:DisplayObject = nullTo be displayed when out of focus
| restrict | property |
restrict:String| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.6 |
| Runtime Versions : | AIR 3.0 |
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 for The default value is "default".
public function get returnKeyLabel():String public function set returnKeyLabel(value:String):voidSee also
| selectionActivePosition | property |
selectionActivePosition:int [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.6 |
| Runtime Versions : | AIR 3.0 |
The active, or last clicked position, of the selection. If the implementation does not support selection anchor this is the last character of the selection.
This value can not be used as the source for data binding.
public function get selectionActivePosition():int| selectionAnchorPosition | property |
selectionAnchorPosition:int [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.6 |
| Runtime Versions : | AIR 3.0 |
The anchor, or first clicked position, of the selection. If the implementation does not support selection anchor this is the first character of the selection.
This value can not be used as the source for data binding.
public function get selectionAnchorPosition():int| 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' The default value is "default".
public function get softKeyboardType():String public function set softKeyboardType(value:String):voidSee also
| stageText | property |
protected var stageText:StageTextThe runtime StageText object that this field uses for text display and editing.
| supportedStyles | property |
protected static var supportedStyles:String = textAlign fontFamily fontWeight fontStyle fontSize color locale| text | property |
text:String| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.6 |
| Runtime Versions : | AIR 3.0 |
A string that is the current text in the text field. Lines are separated by the carriage return character ('\r', ASCII 13). This property contains unformatted text in the text field, without any formatting tags.
If there was a prior selection, it will be preserved.
If the length of the old text was less than the length of the new text, the selection
will be adjusted so that neither selectionAnchorPosition or
selectionActivePosition is greater than the length of the new text.
The default value is "".
public function get text():String public function set text(value:String):void| ScrollableStageText | () | Constructor |
public function ScrollableStageText(multiline:Boolean = false)| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.6 |
| Runtime Versions : | AIR 3.0 |
Constructor.
multiline determines what happens when you press the Enter key.
If it is true, the Enter key starts a new line.
If it is false, it causes a FlexEvent.ENTER
event to be dispatched.
multiline:Boolean (default = false)true to allow more than one line of text to be input.
|
| addedToStageHandler | () | method |
protected function addedToStageHandler(event:Event):voidParameters
event:Event |
| appendText | () | method |
public function appendText(text:String):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.6 |
| Runtime Versions : | AIR 3.0 |
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.
|
| createProxy | () | method |
protected function createProxy():DisplayObjectReturnsDisplayObject |
| disposeProxy | () | method |
protected function disposeProxy():voidDispose the proxy resources once it has been removed from the stage
| endTextEdit | () | method |
protected function endTextEdit():BooleanReturns
Boolean — true if editing was actually ended, false is already ended
|
| getGlobalViewPort | () | method |
protected function getGlobalViewPort():RectangleReturnsRectangle |
| insertText | () | method |
public function insertText(text:String):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.6 |
| Runtime Versions : | AIR 3.0 |
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.
|
| keepSoftKeyboardActive | () | method |
public function keepSoftKeyboardActive():voidthis method is called between the time a text input get out of focus and the next text input gets in focus to prevent the soft keyboard from disappearing.
| measureTextLineHeight | () | method |
protected function measureTextLineHeight():NumberStageText does not have any provision for measuring text. To get approximate sizing, this uses UIComponent's text measurement method on a string with an ascender and a descender. Because platform rendering and UIComponent's rendering differ, the measurement should only be used as an approximation.
ReturnsNumber |
| prepareForTouchScroll | () | method |
public function prepareForTouchScroll():voidthis method is called before a touch scroll is about to occur, so that component can hide the StageText and show the proxies
| removedFromStageHandler | () | method |
protected function removedFromStageHandler(event:Event):voidParameters
event:Event |
| restoreStageText | () | method |
protected function restoreStageText():void| selectAll | () | method |
public function selectAll():void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.6 |
| Runtime Versions : | AIR 3.0 |
Selects all of the text.
On iOS, for non multiline StyleableStageText objects, this function is not supported and does nothing.
For some devices or operating systems, the selection may only be visible when the StageText object has focus.
| selectRange | () | method |
public function selectRange(anchorIndex:int, activeIndex:int):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.6 |
| Runtime Versions : | AIR 3.0 |
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.
|
| stageText_changeHandler | () | method |
protected function stageText_changeHandler(event:Event):voidParameters
event:Event |
| stageText_completeHandler | () | method |
protected function stageText_completeHandler(event:Event):voidParameters
event:Event |
| startTextEdit | () | method |
protected function startTextEdit():BooleanReturns
Boolean — true if editing was actually stated,, false is already started
|
| updateProxy | () | method |
protected function updateProxy():voidReplace the existing proxy image representing this StageText with a new one. Call this whenever the StageText's properties, contents, or geometry changes. This does nothing if there is no proxy image, so it is safe to call updateProxy even if the state of the proxy image is unknown.
| updateViewPort | () | method |
protected function updateViewPort():voidTell the StageText what rectangle it needs to render in. The StageText is not part of the normal display hierarchy, so its coordinates are always specified in global space.
| change | Event |
flash.events.Eventflash.events.Event.CHANGE| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.6 |
| Runtime Versions : | AIR 3.0 |
Dispatched after a user editing operation is complete.
| enter | Event |
mx.events.FlexEventmx.events.FlexEvent.ENTER| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.6 |
| Runtime Versions : | AIR 3.0 |
Dispatched if the StageText is not multiline and the user presses the enter key.
TheFlexEvent.ENTER constant defines the value of the
type property of the event object for a enter 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. |
| focusIn | Event |
flash.events.FocusEventflash.events.FocusEvent.FOCUS_IN| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.6 |
| Runtime Versions : | AIR 3.0 |
Dispatched after the native text control gains focus. This happens when a user highlights the text field with a pointing device, keyboard navigation, or a touch gesture.
Note: Since flash.text.StageText is not an
InteractiveObject, the Stage.focus property may
not be used to determine if a native text field has focus.
| focusOut | Event |
flash.events.FocusEventflash.events.FocusEvent.FOCUS_OUT| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.6 |
| Runtime Versions : | AIR 3.0 |
Dispatched after the native text control loses focus. This happens when a user highlights an object other than the text field with a pointing device, keyboard navigation, or a touch gesture.
Note: Since flash.text.StageText is not an
InteractiveObject, the Stage.focus property may
not be used to determine if a native text field has focus.
| softKeyboardActivate | Event |
flash.events.SoftKeyboardEventflash.events.SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATE| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.6 |
| Runtime Versions : | AIR 3.0 |
Dispatched when a soft keyboard is displayed.
| softKeyboardActivating | Event |
flash.events.SoftKeyboardEventflash.events.SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATING| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.6 |
| Runtime Versions : | AIR 3.0 |
Dispatched immediately before a soft keyboard is displayed. If canceled by
calling preventDefault, the soft keyboard will not open.
| softKeyboardDeactivate | Event |
flash.events.SoftKeyboardEventflash.events.SoftKeyboardEvent.SOFT_KEYBOARD_DEACTIVATE| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.6 |
| Runtime Versions : | AIR 3.0 |
Dispatched when a soft keyboard is lowered or hidden.
| isAndroid | Constant |
protected static const isAndroid:Boolean| isDesktop | Constant |
protected static const isDesktop:Boolean