Packagefeathers.controls
Classpublic class TextArea
InheritanceTextArea Inheritance Scroller Inheritance FeathersControl Inheritance starling.display.Sprite
Implements IAdvancedNativeFocusOwner, IStateContext

Product Version : Feathers 1.1.0

A text entry control that allows users to enter and edit multiple lines of uniformly-formatted text with the ability to scroll.

The following example sets the text in a text area, selects the text, and listens for when the text value changes:

var textArea:TextArea = new TextArea();
textArea.text = "Hello\nWorld"; //it's multiline!
textArea.selectRange( 0, textArea.text.length );
textArea.addEventListener( Event.CHANGE, textArea_changeHandler );
this.addChild( textArea );

See also

How to use the Feathers TextArea component
feathers.controls.TextInput


Public Properties
 PropertyDefined By
 InheritedaddedEffect : Function
An optional effect that is activated when the component is added to the stage.
FeathersControl
 InheritedbottomPullView : DisplayObject
A view that is displayed at the bottom of the scroller's view port when dragging up.
Scroller
 InheritedbottomPullViewDisplayMode : String
Indicates whether the bottom pull view may be dragged with the content, or if its position is fixed to the edge of the scroller.
Scroller
  currentState : String
[read-only] The current state of the text area.
TextArea
 InheriteddefaultTextEditorFactory : Function
[static] A function used by all UI controls that support text editor to create an ITextEditor instance.
FeathersControl
 InheriteddefaultTextRendererFactory : Function
[static] A function used by all UI controls that support text renderers to create an ITextRenderer instance.
FeathersControl
 Inheriteddepth : int
[read-only] The component's depth in the display list, relative to the stage.
FeathersControl
 InheritedeffectsSuspended : Boolean
[read-only] Indicates if effects have been suspended.
FeathersControl
  errorString : String
Error text to display in a Callout when the text area has focus.
TextArea
 InheritedexplicitHeight : Number
[read-only] The height value explicitly set by passing a value to the height setter or by calling the setSize() function.
FeathersControl
 InheritedexplicitMaxHeight : Number
[read-only] The maximum height value explicitly set by passing a value to the maxHeight setter.
FeathersControl
 InheritedexplicitMaxWidth : Number
[read-only] The maximum width value explicitly set by passing a value to the maxWidth setter.
FeathersControl
 InheritedexplicitMinHeight : Number
[read-only] The minimum height value explicitly set by passing a value to the minHeight setter.
FeathersControl
 InheritedexplicitMinWidth : Number
[read-only] The minimum width value explicitly set by passing a value to the minWidth setter.
FeathersControl
 InheritedexplicitWidth : Number
[read-only] The width value explicitly set by passing a value to the width setter or to the setSize() method.
FeathersControl
 InheritedfocusInEffect : Function
An optional effect that is activated when the component receives focus.
FeathersControl
 InheritedfocusManager : IFocusManager
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The current focus manager for this component.
FeathersControl
 InheritedfocusOutEffect : Function
An optional effect that is activated when the component loses focus.
FeathersControl
 InheritedfocusOwner : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Used for associating focusable display objects that are not direct children with an "owner" focusable display object, such as pop-ups.
FeathersControl
  globalStyleProvider : IStyleProvider
[static] The default IStyleProvider for all TextArea components.
TextArea
  hasFocus : Boolean
[read-only] When the FocusManager isn't enabled, hasFocus can be used instead of FocusManager.focus == textArea to determine if the text area has focus.
TextArea
 Inheritedheight : Number
[override] The height of the component, in pixels.
FeathersControl
 InheritedhideEffect : Function
An optional effect that is activated when the component is hidden.
FeathersControl
 InheritedhorizontalPageCount : int
[read-only] The number of horizontal pages, if snapping is enabled.
Scroller
 InheritedhorizontalPageIndex : int
The index of the horizontal page, if snapping is enabled.
Scroller
 InheritedhorizontalScrollBarFactory : Function
Creates the horizontal scroll bar.
Scroller
 InheritedhorizontalScrollBarProperties : Object
An object that stores properties for the container's horizontal scroll bar, and the properties will be passed down to the horizontal scroll bar when the container validates.
Scroller
 InheritedhorizontalScrollPolicy : String
Determines whether the scroller may scroll horizontally (on the x-axis) or not.
Scroller
 InheritedhorizontalScrollPosition : Number
The number of pixels the container has been scrolled horizontally (on the x-axis).
Scroller
 InheritedhorizontalScrollStep : Number
The number of pixels the horizontal scroll position can be adjusted by a "step".
Scroller
 InheritedincludeInLayout : Boolean
Determines if the ILayout should use this object or ignore it.
FeathersControl
 InheritedisBottomPullViewActive : Boolean
Indicates if the bottomPullView has been activated.
Scroller
 InheritedisCreated : Boolean
[read-only] Determines if the component has been initialized and validated for the first time.
FeathersControl
  isEditable : Boolean
Determines if the text area is editable.
TextArea
 InheritedisEnabled : Boolean
Indicates whether the control is interactive or not.
FeathersControl
 InheritedisFocusEnabled : Boolean
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Determines if this component can receive focus.
FeathersControl
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
FeathersControl
 InheritedisLeftPullViewActive : Boolean
Indicates if the leftPullView has been activated.
Scroller
 InheritedisQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list.
FeathersControl
 InheritedisRightPullViewActive : Boolean
Indicates if the rightPullView has been activated.
Scroller
 InheritedisScrolling : Boolean
[read-only] Determines if the scroller is currently scrolling with user interaction or with animation.
Scroller
 InheritedisShowingFocus : Boolean
[read-only] The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Indicates if the showFocus() method has been called on the object when it has focus.
FeathersControl
 InheritedisTopPullViewActive : Boolean
Indicates if the topPullView has been activated.
Scroller
 InheritedlayoutData : ILayoutData
Extra parameters associated with this display object that will be used by the layout algorithm.
FeathersControl
 InheritedleftPullView : DisplayObject
A view that is displayed to the left of the scroller's view port when dragging to the right.
Scroller
 InheritedleftPullViewDisplayMode : String
Indicates whether the left pull view may be dragged with the content, or if its position is fixed to the edge of the scroller.
Scroller
 InheritedmaintainTouchFocus : Boolean
[read-only] The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. If true, the display object should remain in focus, even if something else is touched.
FeathersControl
  maxChars : int
The maximum number of characters that may be entered.
TextArea
 InheritedmaxHeight : Number
The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmaxHorizontalPageIndex : int
[read-only] The maximum horizontal page index that may be displayed by this container, if page snapping is enabled.
Scroller
 InheritedmaxHorizontalScrollPosition : Number
[read-only] The number of pixels the scroller may be scrolled horizontally to the right.
Scroller
 InheritedmaxVerticalPageIndex : int
[read-only] The maximum vertical page index that may be displayed by this container, if page snapping is enabled.
Scroller
 InheritedmaxVerticalScrollPosition : Number
[read-only] The number of pixels the scroller may be scrolled vertically beyond the bottom edge.
Scroller
 InheritedmaxWidth : Number
The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmeasureViewPort : Boolean
Determines if the dimensions of the view port are used when measuring the scroller.
Scroller
 InheritedminHeight : Number
The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminHorizontalPageIndex : int
[read-only] The minimum horizontal page index that may be displayed by this container, if page snapping is enabled.
Scroller
 InheritedminHorizontalScrollPosition : Number
[read-only] The number of pixels the scroller may be scrolled horizontally to the left.
Scroller
 InheritedminimumDragDistance : Number
The minimum physical distance (in inches) that a touch must move before the scroller starts scrolling.
Scroller
 InheritedminimumPageThrowVelocity : Number
The minimum physical velocity (in inches per second) that a touch must move before the scroller will "throw" to the next page.
Scroller
 InheritedminTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded.
FeathersControl
 InheritedminTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded.
FeathersControl
 InheritedminVerticalPageIndex : int
[read-only] The minimum vertical page index that may be displayed by this container, if page snapping is enabled.
Scroller
 InheritedminVerticalScrollPosition : Number
[read-only] The number of pixels the scroller may be scrolled vertically beyond the top edge.
Scroller
 InheritedminWidth : Number
The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmoveEffect : Function
An optional effect that is activated when the component is moved to a new position.
FeathersControl
  nativeFocus : Object
[read-only] A text editor may be an INativeFocusOwner, so we need to return the value of its nativeFocus property.
TextArea
 InheritednextDownFocus : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.DOWN is pressed at KeyLocation.D_PAD and a focus manager is enabled.
FeathersControl
 InheritednextLeftFocus : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.LEFT is pressed at KeyLocation.D_PAD and a focus manager is enabled.
FeathersControl
 InheritednextRightFocus : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.RIGHT is pressed at KeyLocation.D_PAD and a focus manager is enabled.
FeathersControl
 InheritednextTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when the tab key is pressed when a focus manager is enabled.
FeathersControl
 InheritednextUpFocus : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.UP is pressed at KeyLocation.D_PAD and a focus manager is enabled.
FeathersControl
 InheritedpageHeight : Number
When set, the vertical pages snap to this height value instead of the height of the scroller.
Scroller
 InheritedpageWidth : Number
When set, the horizontal pages snap to this width value instead of the width of the scroller.
Scroller
 InheritedpreviousTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The previous object that will receive focus when the tab key is pressed while holding shift when a focus manager is enabled.
FeathersControl
 InheritedresizeEffect : Function
An optional effect that is activated when the component is resized with new dimensions.
FeathersControl
  restrict : String
Limits the set of characters that may be entered.
TextArea
 InheritedrightPullView : DisplayObject
A view that is displayed to the right of the scroller's view port when dragging to the left.
Scroller
 InheritedrightPullViewDisplayMode : String
Indicates whether the right pull view may be dragged with the content, or if its position is fixed to the edge of the scroller.
Scroller
  selectionBeginIndex : int
[read-only] The index of the first character of the selection.
TextArea
  selectionEndIndex : int
[read-only] The index of the last character of the selection.
TextArea
 InheritedshowEffect : Function
An optional effect that is activated when the component is shown.
FeathersControl
 InheritedstyleName : String
The concatenated styleNameList, with values separated by spaces.
FeathersControl
 InheritedstyleNameList : TokenList
[read-only] Contains a list of all "styles" assigned to this control.
FeathersControl
 InheritedstyleProvider : IStyleProvider
When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.
FeathersControl
  text : String
The text displayed by the text area.
TextArea
  textEditorFactory : Function
A function used to instantiate the text editor view port.
TextArea
  textEditorProperties : Object
An object that stores properties for the text area's text editor sub-component, and the properties will be passed down to the text editor when the text area validates.
TextArea
 InheritedtoolTip : String
Text to display in a tool tip to when hovering over this component, if the ToolTipManager is enabled.
FeathersControl
 InheritedtopPullView : DisplayObject
A view that is displayed at the top of the scroller's view port when dragging down.
Scroller
 InheritedtopPullViewDisplayMode : String
Indicates whether the top pull view may be dragged with the content, or if its position is fixed to the edge of the scroller.
Scroller
 InheritedverticalMouseWheelScrollDirection : String
The direction of scrolling when the user scrolls the mouse wheel vertically.
Scroller
 InheritedverticalMouseWheelScrollStep : Number
The number of pixels the vertical scroll position can be adjusted by a "step" when using the mouse wheel.
Scroller
 InheritedverticalPageCount : int
[read-only] The number of vertical pages, if snapping is enabled.
Scroller
 InheritedverticalPageIndex : int
The index of the vertical page, if snapping is enabled.
Scroller
 InheritedverticalScrollBarFactory : Function
Creates the vertical scroll bar.
Scroller
 InheritedverticalScrollBarProperties : Object
An object that stores properties for the container's vertical scroll bar, and the properties will be passed down to the vertical scroll bar when the container validates.
Scroller
 InheritedverticalScrollPolicy : String
Determines whether the scroller may scroll vertically (on the y-axis) or not.
Scroller
 InheritedverticalScrollPosition : Number
The number of pixels the container has been scrolled vertically (on the y-axis).
Scroller
 InheritedverticalScrollStep : Number
The number of pixels the vertical scroll position can be adjusted by a "step".
Scroller
 InheritedviewPort : IViewPort
The display object displayed and scrolled within the Scroller.
Scroller
 Inheritedwidth : Number
[override] The width of the component, in pixels.
FeathersControl
Protected Properties
 PropertyDefined By
 InheritedactualHeight : Number = 0
The final height value that should be used for layout.
FeathersControl
 InheritedactualMinHeight : Number = 0
The final minimum height value that should be used for layout.
FeathersControl
 InheritedactualMinWidth : Number = 0
The final minimum width value that should be used for layout.
FeathersControl
 InheritedactualWidth : Number = 0
The final width value that should be used for layout.
FeathersControl
  callout : TextCallout
The TextCallout that displays the value of the errorString property.
TextArea
 InheriteddefaultStyleProvider : IStyleProvider
[read-only] When the FeathersControl constructor is called, the styleProvider property is set to this value.
FeathersControl
  errorCalloutStyleName : String = "feathers-text-area-error-callout"
The value added to the styleNameList of the error callout.
TextArea
 InheritedhasPendingHorizontalPageIndex : Boolean = false
A flag that indicates if the scroller should scroll to a new page when it validates.
Scroller
 InheritedhasPendingVerticalPageIndex : Boolean = false
A flag that indicates if the scroller should scroll to a new page when it validates.
Scroller
 InheritedhorizontalScrollBar : IScrollBar
The horizontal scrollbar instance.
Scroller
 InheritedhorizontalScrollBarStyleName : String = "feathers-scroller-horizontal-scroll-bar"
The value added to the styleNameList of the horizontal scroll bar.
Scroller
 InheritedpendingHorizontalPageIndex : int
The pending horizontal page index to scroll to after validating.
Scroller
 InheritedpendingHorizontalScrollPosition : Number = NaN
The pending horizontal scroll position to scroll to after validating.
Scroller
 InheritedpendingScrollDuration : Number
The duration of the pending scroll action.
Scroller
 InheritedpendingVerticalPageIndex : int
The pending vertical page index to scroll to after validating.
Scroller
 InheritedpendingVerticalScrollPosition : Number = NaN
The pending vertical scroll position to scroll to after validating.
Scroller
  textEditorStyleName : String = "feathers-text-area-text-editor"
The value added to the styleNameList of the text editor.
TextArea
 InheritedverticalScrollBar : IScrollBar
The vertical scrollbar instance.
Scroller
 InheritedverticalScrollBarStyleName : String = "feathers-scroller-vertical-scroll-bar"
The value added to the styleNameList of the vertical scroll bar.
Scroller
Public Methods
 MethodDefined By
  
Constructor.
TextArea
  
clearFocus():void
Manually removes focus from the text area control.
TextArea
 Inherited
getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle
[override] Feathers components use an optimized getBounds() implementation that may sometimes behave differently than regular Starling display objects.
FeathersControl
  
getFontStylesForState(state:String):TextFormat
Gets the font styles to be used to display the text area's text when the text area's currentState property matches the specified state value.
TextArea
  
getSkinForState(state:String):DisplayObject
Gets the skin to be used by the text area when its currentState property matches the specified state value.
TextArea
 Inherited
hideFocus():void
The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.
FeathersControl
 Inherited
If the component has not yet initialized, initializes immediately.
FeathersControl
 Inherited
invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending.
FeathersControl
 Inherited
isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not.
FeathersControl
 Inherited
move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single function call.
FeathersControl
 Inherited
removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void
Plays an effect before removing the component from its parent.
FeathersControl
 Inherited
Resets the styleProvider property to its default value, which is usually the global style provider for the component.
FeathersControl
 Inherited
Indicates that effects should be re-activated after being suspended.
FeathersControl
 Inherited
If the scroll bars are floating, briefly show them as a hint to the user.
Scroller
 Inherited
scrollToPageIndex(horizontalPageIndex:int, verticalPageIndex:int, animationDuration:Number):void
After the next validation, animates the scroll position to a specific page index.
Scroller
 Inherited
scrollToPosition(horizontalScrollPosition:Number, verticalScrollPosition:Number, animationDuration:Number):void
After the next validation, animates the scroll positions to a specific location.
Scroller
  
selectRange(beginIndex:int, endIndex:int = -1):void
Sets the range of selected characters.
TextArea
  
setFocus():void
Focuses the text area control so that it may be edited.
TextArea
  
setFontStylesForState(state:String, format:TextFormat):void
Sets the font styles to be used to display the text area's text when the text area's currentState property matches the specified state value.
TextArea
 Inherited
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single function call.
FeathersControl
  
setSkinForState(state:String, skin:DisplayObject):void
Sets the skin to be used by the text area when its currentState property matches the specified state value.
TextArea
 Inherited
showFocus():void
The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.
FeathersControl
 Inherited
If the user is scrolling with touch or if the scrolling is animated, calling stopScrolling() will cause the scroller to ignore the drag and stop animations.
Scroller
 Inherited
Indicates that effects should not be activated temporarily.
FeathersControl
 Inherited
validate():void
Immediately validates the display object, if it is invalid.
FeathersControl
Protected Methods
 MethodDefined By
 Inherited
If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself.
Scroller
 Inherited
clearInvalidationFlag(flag:String):void
Clears an invalidation flag.
FeathersControl
 Inherited
Prepares the scroller for normal interaction and dispatches FeathersEventType.SCROLL_COMPLETE.
Scroller
 Inherited
Creates and adds the horizontalScrollBar and verticalScrollBar sub-components and removes the old instances, if they exist.
Scroller
  
Creates and adds the textEditorViewPort sub-component and removes the old instance, if one exists.
TextArea
 Inherited
draw():void
Override to customize layout and to adjust properties of children.
FeathersControl
 Inherited
focusInHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_IN that may be overridden in subclasses to perform additional actions when the component receives focus.
FeathersControl
 Inherited
focusOutHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_OUT that may be overridden in subclasses to perform additional actions when the component loses focus.
FeathersControl
 Inherited
Scrolls to a pending scroll position, if required.
Scroller
 Inherited
The next style that is set will not be restricted.
FeathersControl
 Inherited
initialize():void
Called the first time that the UI control is added to the stage, and you should override this function to customize the initialization process.
FeathersControl
 Inherited
Positions and sizes children based on the actual width and height values.
Scroller
 Inherited
processStyleRestriction(key:Object):Boolean
Used by setters for properties that are considered "styles" to determine if the setter has been called directly on the component or from a style provider.
FeathersControl
 Inherited
Choose the appropriate background skin based on the control's current state.
Scroller
 Inherited
Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.
FeathersControl
 Inherited
saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean
Saves the dimensions and minimum dimensions calculated for the component.
FeathersControl
 Inherited
setInvalidationFlag(flag:String):void
Sets an invalidation flag.
FeathersControl
 Inherited
setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of invalidating or not.
FeathersControl
 Inherited
If scrolling hasn't already started, prepares the scroller to scroll and dispatches FeathersEventType.SCROLL_START.
Scroller
 Inherited
throwTo(targetHorizontalScrollPosition:Number, targetVerticalScrollPosition:Number, duration:Number = 0.5):void
Immediately throws the scroller to the specified position, with optional animation.
Scroller
 Inherited
throwToPage(targetHorizontalPageIndex:int, targetVerticalPageIndex:int, duration:Number = 0.5):void
Immediately throws the scroller to the specified page index, with optional animation.
Scroller
Events
 Event Summary Defined By
 InheritedDispatched when the user starts dragging the scroller when ScrollInteractionMode.TOUCH is enabled or when the user starts interacting with the scroll bar.Scroller
  Dispatched when the text area's text property changes.TextArea
 InheritedDispatched after the component has validated for the first time.FeathersControl
 InheritedDispatched when the user stops dragging the scroller when ScrollInteractionMode.TOUCH is enabled or when the user stops interacting with the scroll bar.Scroller
 InheritedDispatched when the component receives focus.Scroller
 InheritedDispatched when the component loses focus.Scroller
 InheritedDispatched after initialize() has been called, but before the first time that draw() has been called.FeathersControl
 InheritedDispatched when the width or height of the control changes.FeathersControl
 InheritedDispatched when the scroller scrolls in either direction or when the view port's scrolling bounds have changed.Scroller
 InheritedDispatched when the scroller finishes scrolling in either direction as a result of either user interaction or animation.Scroller
 InheritedDispatched when the scroller starts scrolling in either direction as a result of either user interaction or animation.Scroller
  Dispatched when the display object's state changes.TextArea
 InheritedDispatched when a pull view is activated.Scroller
Styles
 StyleDefined By
 Inherited
If true, the background's visible property will be set to false when the scroll position is greater than or equal to the minimum scroll position and less than or equal to the maximum scroll position.
Scroller
  
backgroundDisabledSkin : DisplayObject
A display object displayed behind the text area's content when it is disabled.
TextArea
  
backgroundErrorSkin : DisplayObject
The skin used for the text area's error state.
TextArea
  
backgroundFocusedSkin : DisplayObject
A display object displayed behind the text area's content when it has focus.
TextArea
 Inherited
backgroundSkin : DisplayObject
The default background to display.
Scroller
 Inherited
clipContent : Boolean
If true, the viewport will be clipped to the scroller's bounds.
Scroller
  
A style name to add to the text area's error callout sub-component.
TextArea
 Inherited
A style name to add to the container's horizontal scroll bar sub-component.
Scroller
  
A style name to add to the text area's text editor sub-component.
TextArea
 Inherited
A style name to add to the container's vertical scroll bar sub-component.
Scroller
 Inherited
This value is used to decelerate the scroller when "thrown".
Scroller
  
disabledFontStyles : TextFormat
The font styles used to display the text area's text when the text area is disabled.
TextArea
 Inherited
elasticity : Number
If the scroll position goes outside the minimum or maximum bounds when the scroller's content is being actively dragged, the scrolling will be constrained using this multiplier.
Scroller
 Inherited
The duration, in seconds, of the animation when a the scroller snaps back to the minimum or maximum position after going out of bounds.
Scroller
 Inherited
focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.
FeathersControl
 Inherited
focusPadding : Number
Quickly sets all focus padding properties to the same value.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin.
FeathersControl
  
fontStyles : TextFormat
The font styles used to display the text area's text.
TextArea
 Inherited
hasElasticEdges : Boolean
Determines if the scrolling can go beyond the edges of the viewport.
Scroller
 Inherited
The duration, in seconds, of the animation when a scroll bar fades out.
Scroller
 Inherited
The easing function used for hiding the scroll bars, if applicable.
Scroller
 Inherited
Determines where the horizontal scroll bar will be positioned.
Scroller
 Inherited
Determines how the user may interact with the scroller.
Scroller
 Inherited
The duration, in seconds, of the animation when the mouse wheel initiates a scroll action.
Scroller
 Inherited
padding : Number
Quickly sets all padding properties to the same value.
Scroller
 Inherited
paddingBottom : Number
The minimum space, in pixels, between the container's bottom edge and the container's content.
Scroller
 Inherited
paddingLeft : Number
The minimum space, in pixels, between the container's left edge and the container's content.
Scroller
 Inherited
paddingRight : Number
The minimum space, in pixels, between the container's right edge and the container's content.
Scroller
 Inherited
paddingTop : Number
The minimum space, in pixels, between the container's top edge and the container's content.
Scroller
 Inherited
The duration, in seconds, of the animation when the scroller is thrown to a page.
Scroller
 Inherited
The duration, in seconds, that the scroll bars will be shown when calling revealScrollBars().
Scroller
 Inherited
Determines how the scroll bars are displayed.
Scroller
 Inherited
If enabled, the scroll position will always be adjusted to the nearest pixel on the physical screen.
Scroller
 Inherited
snapToPages : Boolean
Determines if scrolling will snap to the nearest page.
Scroller
 Inherited
throwEase : Object
The easing function used for "throw" animations.
Scroller
 Inherited
If the scroll position goes outside the minimum or maximum bounds when the scroller's content is "thrown", the scrolling will be constrained using this multiplier.
Scroller
 Inherited
If true, the duration of a "throw" animation will be the same no matter the value of the throw's initial velocity.
Scroller
 Inherited
Determines where the vertical scroll bar will be positioned.
Scroller
Public Constants
 ConstantDefined By
  DEFAULT_CHILD_STYLE_NAME_ERROR_CALLOUT : String = "feathers-text-area-error-callout"
[static] The default value added to the styleNameList of the error callout.
TextArea
 InheritedDEFAULT_CHILD_STYLE_NAME_HORIZONTAL_SCROLL_BAR : String = "feathers-scroller-horizontal-scroll-bar"
[static] The default value added to the styleNameList of the horizontal scroll bar.
Scroller
  DEFAULT_CHILD_STYLE_NAME_TEXT_EDITOR : String = "feathers-text-area-text-editor"
[static] The default value added to the styleNameList of the text editor.
TextArea
 InheritedDEFAULT_CHILD_STYLE_NAME_VERTICAL_SCROLL_BAR : String = "feathers-scroller-vertical-scroll-bar"
[static] The default value added to the styleNameList of the vertical scroll bar.
Scroller
 InheritedINVALIDATION_FLAG_ALL : String = "all"
[static] Flag to indicate that everything is invalid and should be redrawn.
FeathersControl
 InheritedINVALIDATION_FLAG_DATA : String = "data"
[static] Invalidation flag to indicate that the primary data displayed by the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_FOCUS : String = "focus"
[static] Invalidation flag to indicate that the focus of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_LAYOUT : String = "layout"
[static] Invalidation flag to indicate that the layout of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SCROLL : String = "scroll"
[static] Invalidation flag to indicate that the scroll position of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SELECTED : String = "selected"
[static] Invalidation flag to indicate that the selection of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SIZE : String = "size"
[static] Invalidation flag to indicate that the dimensions of the UI control have changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SKIN : String = "skin"
[static] Invalidation flag to indicate that the skin of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STATE : String = "state"
[static] Invalidation flag to indicate that the state has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STYLES : String = "styles"
[static] Invalidation flag to indicate that the styles or visual appearance of the UI control has changed.
FeathersControl
Protected Constants
 ConstantDefined By
 InheritedINVALIDATION_FLAG_CLIPPING : String = "clipping"
[static] Flag to indicate that the clipping has changed.
Scroller
Property Detail
calloutproperty
protected var callout:TextCallout

The TextCallout that displays the value of the errorString property. The value may be null if there is no current error string or if the text area doesn't have focus.

For internal use in subclasses.

currentStateproperty 
currentState:String  [read-only]

The current state of the text area.


Implementation
    public function get currentState():String

See also

errorCalloutStyleNameproperty 
protected var errorCalloutStyleName:String = "feathers-text-area-error-callout"

The value added to the styleNameList of the error callout. This variable is protected so that sub-classes can customize the error callout text renderer style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_ERROR_CALLOUT.

To customize the error callout style name without subclassing, see customErrorCalloutStyleName.

See also

errorStringproperty 
errorString:String

Error text to display in a Callout when the text area has focus. When this value is not null the text area's state is changed to TextInputState.ERROR. An empty string will change the background, but no Callout will appear on focus. To clear an error, the errorString property must be set to null

The following example displays an error string:

textArea.errorString = "Something is wrong";

The default value is null.


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

See also

globalStyleProviderproperty 
public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all TextArea components.

The default value is null.

See also

hasFocusproperty 
hasFocus:Boolean  [read-only]

When the FocusManager isn't enabled, hasFocus can be used instead of FocusManager.focus == textArea to determine if the text area has focus.


Implementation
    public function get hasFocus():Boolean
isEditableproperty 
isEditable:Boolean

Determines if the text area is editable. If the text area is not editable, it will still appear enabled.

In the following example, the text area is not editable:

textArea.isEditable = false;

The default value is true.


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

The maximum number of characters that may be entered.

In the following example, the text area's maximum characters is specified:

textArea.maxChars = 10;

The default value is 0.


Implementation
    public function get maxChars():int
    public function set maxChars(value:int):void
nativeFocusproperty 
nativeFocus:Object  [read-only]

A text editor may be an INativeFocusOwner, so we need to return the value of its nativeFocus property. If not, then we return null.


Implementation
    public function get nativeFocus():Object

See also

restrictproperty 
restrict:String

Limits the set of characters that may be entered.

In the following example, the text area's allowed characters are restricted:

textArea.restrict = "0-9;

The default value is null.


Implementation
    public function get restrict():String
    public function set restrict(value:String):void
selectionBeginIndexproperty 
selectionBeginIndex:int  [read-only]

The index of the first character of the selection. If no text is selected, then this is the value of the caret index. This value will always be smaller than selectionEndIndex.


Implementation
    public function get selectionBeginIndex():int
selectionEndIndexproperty 
selectionEndIndex:int  [read-only]

The index of the last character of the selection. If no text is selected, then this is the value of the caret index. This value will always be larger than selectionBeginIndex.


Implementation
    public function get selectionEndIndex():int
textproperty 
text:String

The text displayed by the text area. The text area dispatches Event.CHANGE when the value of the text property changes for any reason.

In the following example, the text area's text is updated:

textArea.text = "Hello World";

The default value is "".


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

See also

textEditorFactoryproperty 
textEditorFactory:Function

A function used to instantiate the text editor view port. If null, a TextFieldTextEditorViewPort will be instantiated. The text editor must be an instance of ITextEditorViewPort. This factory can be used to change properties on the text editor view port when it is first created. For instance, if you are skinning Feathers components without a theme, you might use this factory to set styles on the text editor view port.

The factory should have the following function signature:

function():ITextEditorViewPort

In the following example, a custom text editor factory is passed to the text area:

textArea.textEditorFactory = function():ITextEditorViewPort
{
    return new TextFieldTextEditorViewPort();
};

The default value is null.


Implementation
    public function get textEditorFactory():Function
    public function set textEditorFactory(value:Function):void

See also

textEditorPropertiesproperty 
textEditorProperties:Object

An object that stores properties for the text area's text editor sub-component, and the properties will be passed down to the text editor when the text area validates. The available properties depend on which ITextEditorViewPort implementation is returned by textEditorFactory. Refer to feathers.controls.text.ITextEditorViewPort for a list of available text editor implementations for text area.

If the subcomponent has its own subcomponents, their properties can be set too, using attribute @ notation. For example, to set the skin on the thumb which is in a SimpleScrollBar, which is in a List, you can use the following syntax:

list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);

Setting properties in a textEditorFactory function instead of using textEditorProperties will result in better performance.

In the following example, the text input's text editor properties are specified (this example assumes that the text editor is a TextFieldTextEditorViewPort):

textArea.textEditorProperties.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333);
textArea.textEditorProperties.embedFonts = true;

The default value is null.


Implementation
    public function get textEditorProperties():Object
    public function set textEditorProperties(value:Object):void

See also

textEditorStyleNameproperty 
protected var textEditorStyleName:String = "feathers-text-area-text-editor"

The value added to the styleNameList of the text editor. This variable is protected so that sub-classes can customize the text editor style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_TEXT_EDITOR.

To customize the text editor style name without subclassing, see customTextEditorStyleName.

See also

Constructor Detail
TextArea()Constructor
public function TextArea()

Constructor.

Method Detail
clearFocus()method
public function clearFocus():void

Manually removes focus from the text area control.

createTextEditor()method 
protected function createTextEditor():void

Creates and adds the textEditorViewPort sub-component and removes the old instance, if one exists.

Meant for internal use, and subclasses may override this function with a custom implementation.

See also

getFontStylesForState()method 
public function getFontStylesForState(state:String):TextFormat

Gets the font styles to be used to display the text area's text when the text area's currentState property matches the specified state value.

If font styles are not defined for a specific state, returns null.

Parameters

state:String

Returns
TextFormat

See also

getSkinForState()method 
public function getSkinForState(state:String):DisplayObject

Gets the skin to be used by the text area when its currentState property matches the specified state value.

If a skin is not defined for a specific state, returns null.

Parameters

state:String

Returns
DisplayObject

See also

selectRange()method 
public function selectRange(beginIndex:int, endIndex:int = -1):void

Sets the range of selected characters. If both values are the same, or the end index is -1, the text insertion position is changed and nothing is selected.

Parameters

beginIndex:int
 
endIndex:int (default = -1)

setFocus()method 
public function setFocus():void

Focuses the text area control so that it may be edited.

setFontStylesForState()method 
public function setFontStylesForState(state:String, format:TextFormat):void

Sets the font styles to be used to display the text area's text when the text area's currentState property matches the specified state value.

If font styles are not defined for a specific state, the value of the fontStyles property will be used instead.

Note: if the text editor has been customized with advanced font formatting, it may override the values specified with setFontStylesForState() and properties like fontStyles and disabledFontStyles.

Parameters

state:String
 
format:TextFormat

See also

setSkinForState()method 
public function setSkinForState(state:String, skin:DisplayObject):void

Sets the skin to be used by the text area when its currentState property matches the specified state value.

If a skin is not defined for a specific state, the value of the backgroundSkin property will be used instead.

Parameters

state:String
 
skin:DisplayObject

See also

Event Detail
change Event
Event Object Type: starling.events.Event
Event.type property = starling.events.Event.CHANGE

Dispatched when the text area's text property changes.

The properties of the event object have the following values:

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

See also

stateChange Event  
Event Object Type: starling.events.Event
Event.type property = feathers.events.FeathersEventType.STATE_CHANGE

Dispatched when the display object's state changes.

The properties of the event object have the following values:

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

The FeathersEventType.STATE_CHANGE event type is used by Feathers classes that implement the IStateContext interface.

See also

Style Detail
fontStylesstyle
fontStyles:TextFormat

The font styles used to display the text area's text.

In the following example, the font styles are customized:

textArea.fontStyles = new TextFormat( "Helvetica", 20, 0xcc0000 );

Note: The starling.text.TextFormat class defines a number of common font styles, but the text editor being used may support a larger number of ways to be customized. Use the textEditorFactory to set more advanced styles on the text editor.

The default value is null.

See also

disabledFontStylesstyle 
disabledFontStyles:TextFormat

The font styles used to display the text area's text when the text area is disabled.

In the following example, the disabled font styles are customized:

textArea.disabledFontStyles = new TextFormat( "Helvetica", 20, 0x999999 );

Alternatively, you may use setFontStylesForState() with TextInputState.DISABLED to set the same font styles:

var fontStyles:TextFormat = new TextFormat( "Helvetica", 20, 0x999999 );
textArea.setFontStylesForState( TextInputState.DISABLED, fontStyles );

Note: The starling.text.TextFormat class defines a number of common font styles, but the text editor being used may support a larger number of ways to be customized. Use the textEditorFactory to set more advanced styles on the text editor.

The default value is null.

See also

customTextEditorStyleNamestyle 
customTextEditorStyleName:String

A style name to add to the text area's text editor sub-component. Typically used by a theme to provide different styles to different text areas.

In the following example, a custom text editor style name is passed to the text area:

textArea.customTextEditorStyleName = "my-custom-text-area-text-editor";

In your theme, you can target this sub-component style name to provide different styles than the default:

getStyleProviderForClass( TextFieldTextEditorViewPort ).setFunctionForStyleName( "my-custom-text-area-text-editor", setCustomTextAreaTextEditorStyles );

The default value is null.

See also

customErrorCalloutStyleNamestyle 
customErrorCalloutStyleName:String

A style name to add to the text area's error callout sub-component. Typically used by a theme to provide different styles to different text areas.

In the following example, a custom error callout style name is passed to the text area:

textArea.customErrorCalloutStyleName = "my-custom-text-area-error-callout";

In your theme, you can target this sub-component style name to provide different styles than the default:

getStyleProviderForClass( Callout ).setFunctionForStyleName( "my-custom-text-area-error-callout", setCustomTextAreaErrorCalloutStyles );

The default value is null.

See also

backgroundErrorSkinstyle 
backgroundErrorSkin:DisplayObject

The skin used for the text area's error state. If null, then backgroundSkin is used instead.

The following example gives the text area a skin for the error state:

textArea.backgroundErrorSkin = new Image( texture );

Alternatively, you may use setSkinForState() with TextInputState.ERROR to set the same skin:

var skin:Image = new Image( texture );
textArea.setSkinForState( TextInputState.ERROR, skin );

The default value is null.

See also

backgroundFocusedSkinstyle 
backgroundFocusedSkin:DisplayObject

A display object displayed behind the text area's content when it has focus.

In the following example, the text area's focused background skin is specified:

textArea.backgroundFocusedSkin = new Image( texture );

Alternatively, you may use setSkinForState() with TextInputState.FOCUSED to set the same skin:

var skin:Image = new Image( texture );
textArea.setSkinForState( TextInputState.FOCUSED, skin );

The default value is null.

See also

backgroundDisabledSkinstyle 
backgroundDisabledSkin:DisplayObject

A display object displayed behind the text area's content when it is disabled.

In the following example, the text area's disabled background skin is specified:

textArea.isEnabled = false;
textArea.backgroundDisabledSkin = new Image( texture );

Alternatively, you may use setSkinForState() with TextInputState.DISABLED to set the same skin:

var skin:Image = new Image( texture );
textArea.setSkinForState( TextInputState.DISABLED, skin );

The default value is null.

See also

Constant Detail
DEFAULT_CHILD_STYLE_NAME_ERROR_CALLOUTConstant
public static const DEFAULT_CHILD_STYLE_NAME_ERROR_CALLOUT:String = "feathers-text-area-error-callout"

The default value added to the styleNameList of the error callout.

See also

DEFAULT_CHILD_STYLE_NAME_TEXT_EDITORConstant 
public static const DEFAULT_CHILD_STYLE_NAME_TEXT_EDITOR:String = "feathers-text-area-text-editor"

The default value added to the styleNameList of the text editor.

See also