Packagefeathers.controls
Classpublic class TextArea
InheritanceTextArea Inheritance Scroller Inheritance FeathersControl Inheritance starling.display.Sprite
Implements INativeFocusOwner

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

Important: TextArea is not recommended for mobile. Instead, you should generally use a TextInput with a StageTextTextEditor that has its multiline property set to true and the text input's verticalAlign property should be set to TextInput.VERTICAL_ALIGN_JUSTIFY. In that situation, the StageText instance will automatically provide its own operating system native scroll bars. TextArea is intended for use on desktop and may not behave correctly on mobile.

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, input_changeHandler );
     this.addChild( textArea );

See also

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


Public Properties
 PropertyDefined By
 InheritedautoHideBackground : Boolean
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
 InheritedbackgroundDisabledSkin : DisplayObject
A background to display when the container is disabled.
Scroller
  backgroundFocusedSkin : DisplayObject
A display object displayed behind the text area's content when it has focus.
TextArea
 InheritedbackgroundSkin : DisplayObject
The default background to display.
Scroller
 InheritedclipContent : Boolean
If true, the viewport will be clipped to the scroller's bounds.
Scroller
 InheritedcustomHorizontalScrollBarName : String
DEPRECATED: Replaced by customHorizontalScrollBarName.
Scroller
 InheritedcustomHorizontalScrollBarStyleName : String
A style name to add to the container's horizontal scroll bar sub-component.
Scroller
 InheritedcustomVerticalScrollBarName : String
DEPRECATED: Replaced by customVerticalScrollBarStyleName.
Scroller
 InheritedcustomVerticalScrollBarStyleName : String
A style name to add to the container's vertical scroll bar sub-component.
Scroller
 InheriteddecelerationRate : Number
This value is used to decelerate the scroller when "thrown".
Scroller
 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
 Inheritedelasticity : 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
 InheritedelasticSnapDuration : Number
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
 InheritedfocusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.
FeathersControl
 InheritedfocusManager : IFocusManager
FeathersControl
 InheritedfocusOwner : IFocusDisplayObject
FeathersControl
 InheritedfocusPadding : Number
Quickly sets all focus padding properties to the same value.
FeathersControl
 InheritedfocusPaddingBottom : Number
The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin.
FeathersControl
 InheritedfocusPaddingLeft : Number
The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin.
FeathersControl
 InheritedfocusPaddingRight : Number
The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin.
FeathersControl
 InheritedfocusPaddingTop : Number
The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin.
FeathersControl
  globalStyleProvider : IStyleProvider
[static] The default IStyleProvider for all TextArea components.
TextArea
 InheritedhasElasticEdges : Boolean
Determines if the scrolling can go beyond the edges of the viewport.
Scroller
  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
 InheritedhideScrollBarAnimationDuration : Number
The duration, in seconds, of the animation when a scroll bar fades out.
Scroller
 InheritedhideScrollBarAnimationEase : Object
The easing function used for hiding the scroll bars, if applicable.
Scroller
 InheritedhorizontalPageCount : int
[read-only] The number of horizontal pages, if snapping is enabled.
Scroller
 InheritedhorizontalPageIndex : int
[read-only] 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
 InheritedinteractionMode : String
Determines how the user may interact with the scroller.
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
FeathersControl
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
FeathersControl
 InheritedisQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list.
FeathersControl
 InheritedisScrolling : Boolean
[read-only] Determines if the scroller is currently scrolling with user interaction or with animation.
Scroller
 InheritedlayoutData : ILayoutData
Extra parameters associated with this display object that will be used by the layout algorithm.
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
 InheritedmouseWheelScrollDuration : Number
The duration, in seconds, of the animation when the mouse wheel initiates a scroll action.
Scroller
  nativeFocus : InteractiveObject
[read-only] A text editor may be an INativeFocusOwner, so we need to return the value of its nativeFocus property.
TextArea
 InheritednextTabFocus : IFocusDisplayObject
FeathersControl
 Inheritedpadding : Number
Quickly sets all padding properties to the same value.
Scroller
 InheritedpaddingBottom : Number
The minimum space, in pixels, between the container's bottom edge and the container's content.
Scroller
 InheritedpaddingLeft : Number
The minimum space, in pixels, between the container's left edge and the container's content.
Scroller
 InheritedpaddingRight : Number
The minimum space, in pixels, between the container's right edge and the container's content.
Scroller
 InheritedpaddingTop : Number
The minimum space, in pixels, between the container's top edge and the container's content.
Scroller
 InheritedpageHeight : Number
When set, the vertical pages snap to this height value instead of the height of the scroller.
Scroller
 InheritedpageThrowDuration : Number
The duration, in seconds, of the animation when the scroller is thrown to a page.
Scroller
 InheritedpageWidth : Number
When set, the horizontal pages snap to this width value instead of the width of the scroller.
Scroller
 InheritedpreviousTabFocus : IFocusDisplayObject
FeathersControl
  restrict : String
Limits the set of characters that may be entered.
TextArea
 InheritedrevealScrollBarsDuration : Number
The duration, in seconds, that the scroll bars will be shown when calling revealScrollBars()
Scroller
 InheritedscrollBarDisplayMode : String
Determines how the scroll bars are displayed.
Scroller
 InheritedsnapScrollPositionsToPixels : Boolean
If enabled, the scroll position will always be adjusted to whole pixels.
Scroller
 InheritedsnapToPages : Boolean
Determines if scrolling will snap to the nearest page.
Scroller
  stateToSkinFunction : Function
Returns a skin for the current state.
TextArea
 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
 InheritedthrowEase : Object
The easing function used for "throw" animations.
Scroller
 InheritedthrowElasticity : Number
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
 InheriteduseFixedThrowDuration : Boolean
If true, the duration of a "throw" animation will be the same no matter the value of the throw's initial velocity.
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
[read-only] The index of the vertical page, if snapping is enabled.
Scroller
 InheritedverticalScrollBarFactory : Function
Creates the vertical scroll bar.
Scroller
 InheritedverticalScrollBarPosition : String
Determines where the vertical scroll bar will be positioned.
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
 InheritedactualWidth : Number = 0
The final width value that should be used for layout.
FeathersControl
  currentState : String
The current state of the input.
TextArea
 InheriteddefaultStyleProvider : IStyleProvider
[read-only] When the FeathersControl constructor is called, the globalStyleProvider property is set to this value.
FeathersControl
 InheritedexplicitHeight : Number = NaN
The height value explicitly set by calling the height setter or setSize().
FeathersControl
 InheritedexplicitWidth : Number = NaN
The width value explicitly set by calling the width setter or setSize().
FeathersControl
 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
 InheritedhorizontalScrollBarName : String
DEPRECATED: Replaced by horizontalScrollBarStyleName.
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
  stateNames : Vector.<String>
[read-only] A list of all valid state names for use with currentState.
TextArea
 InheritedverticalScrollBar : IScrollBar
The vertical scrollbar instance.
Scroller
 InheritedverticalScrollBarName : String
DEPRECATED: Replaced by verticalScrollBarStyleName.
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 input control.
TextArea
 Inherited
hideFocus():void
If the visual indicator of focus has been displayed by showFocus(), call this function to hide it.
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
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(startIndex: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
 Inherited
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single function call.
FeathersControl
  
showFocus():void
[override] If the object has focus, an additional visual indicator may optionally be displayed to highlight the object.
TextArea
 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
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
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
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
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 INTERACTION_MODE_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 INTERACTION_MODE_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
Public Constants
 ConstantDefined By
  DECELERATION_RATE_FAST : Number = 0.99
[static] Decelerates a bit faster per millisecond than the default.
TextArea
  DECELERATION_RATE_NORMAL : Number = 0.998
[static] The default deceleration rate per millisecond.
TextArea
 InheritedDEFAULT_CHILD_NAME_HORIZONTAL_SCROLL_BAR : String = feathers-scroller-horizontal-scroll-bar
[static] DEPRECATED: Replaced by Scroller.DEFAULT_CHILD_STYLE_NAME_HORIZONTAL_SCROLL_BAR.
Scroller
 InheritedDEFAULT_CHILD_NAME_VERTICAL_SCROLL_BAR : String = feathers-scroller-vertical-scroll-bar
[static] DEPRECATED: Replaced by Scroller.DEFAULT_CHILD_STYLE_NAME_VERTICAL_SCROLL_BAR.
Scroller
 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
 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
  INTERACTION_MODE_MOUSE : String = mouse
[static] The user may only interact with the scroll bars to scroll.
TextArea
  INTERACTION_MODE_TOUCH : String = touch
[static] The user may touch anywhere on the scroller and drag to scroll.
TextArea
  INTERACTION_MODE_TOUCH_AND_SCROLL_BARS : String = touchAndScrollBars
[static] The user may touch anywhere on the scroller and drag to scroll, and the scroll bars may be dragged separately.
TextArea
 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
  MOUSE_WHEEL_SCROLL_DIRECTION_HORIZONTAL : String = horizontal
[static] The scroller will scroll horizontally when the mouse wheel is scrolled.
TextArea
  MOUSE_WHEEL_SCROLL_DIRECTION_VERTICAL : String = vertical
[static] The scroller will scroll vertically when the mouse wheel is scrolled.
TextArea
  SCROLL_BAR_DISPLAY_MODE_FIXED : String = fixed
[static] The scroll bars are always visible and appear next to the scroller's view port, making the view port smaller than the scroller.
TextArea
  SCROLL_BAR_DISPLAY_MODE_FIXED_FLOAT : String = fixedFloat
[static] The scroll bars appear above the scroller's view port, overlapping the content, but they do not fade out when not in use.
TextArea
  SCROLL_BAR_DISPLAY_MODE_FLOAT : String = float
[static] The scroll bars appear above the scroller's view port, overlapping the content, and they fade out when not in use.
TextArea
  SCROLL_BAR_DISPLAY_MODE_NONE : String = none
[static] The scroll bars are never visible.
TextArea
  SCROLL_POLICY_AUTO : String = auto
[static] The scroller may scroll if the view port is larger than the scroller's bounds.
TextArea
  SCROLL_POLICY_OFF : String = off
[static] The scroller does not scroll at all.
TextArea
  SCROLL_POLICY_ON : String = on
[static] The scroller will always scroll.
TextArea
  STATE_DISABLED : String = disabled
[static] The TextArea is disabled.
TextArea
  STATE_ENABLED : String = enabled
[static] The TextArea is enabled and does not have focus.
TextArea
  STATE_FOCUSED : String = focused
[static] The TextArea is enabled and has focus.
TextArea
  VERTICAL_SCROLL_BAR_POSITION_LEFT : String = left
[static] The vertical scroll bar will be positioned on the left.
TextArea
  VERTICAL_SCROLL_BAR_POSITION_RIGHT : String = right
[static] The vertical scroll bar will be positioned on the right.
TextArea
Protected Constants
 ConstantDefined By
 InheritedINVALIDATION_FLAG_CLIPPING : String = clipping
[static] Flag to indicate that the clipping has changed.
Scroller
Property Detail
backgroundFocusedSkinproperty
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 );

The default value is null.


Implementation
    public function get backgroundFocusedSkin():DisplayObject
    public function set backgroundFocusedSkin(value:DisplayObject):void
currentStateproperty 
currentState:String

The current state of the input.

For internal use in subclasses.


Implementation
    protected function get currentState():String
    protected function set currentState(value:String):void
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:InteractiveObject  [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():InteractiveObject

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
stateNamesproperty 
stateNames:Vector.<String>  [read-only]

A list of all valid state names for use with currentState.

For internal use in subclasses.


Implementation
    protected function get stateNames():Vector.<String>

See also

stateToSkinFunctionproperty 
stateToSkinFunction:Function

Returns a skin for the current state.

The following function signature is expected:

function( target:TextArea, state:Object, oldSkin:DisplayObject = null ):DisplayObject

The default value is null.


Implementation
    public function get stateToSkinFunction():Function
    public function set stateToSkinFunction(value:Function):void
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:

         input.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):

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

The default value is null.


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

See also

Constructor Detail
TextArea()Constructor
public function TextArea()

Constructor.

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

Manually removes focus from the text input 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

selectRange()method 
public function selectRange(startIndex: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

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

setFocus()method 
public function setFocus():void

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

showFocus()method 
override public function showFocus():void

If the object has focus, an additional visual indicator may optionally be displayed to highlight the object. Calling this function may have no effect. It's merely a suggestion to the object.

Important: This function will not give focus to the display object if it doesn't have focus. To give focus to the display object, you should set the focus property on the focus manager.

         object.focusManager.focus = object;

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.

Constant Detail
DECELERATION_RATE_FASTConstant
public static const DECELERATION_RATE_FAST:Number = 0.99

Decelerates a bit faster per millisecond than the default.

See also

DECELERATION_RATE_NORMALConstant 
public static const DECELERATION_RATE_NORMAL:Number = 0.998

The default deceleration rate per millisecond.

See also

INTERACTION_MODE_MOUSEConstant 
public static const INTERACTION_MODE_MOUSE:String = mouse

The user may only interact with the scroll bars to scroll. The user cannot touch anywhere in the scroller's content and drag like a touch interface.

See also

INTERACTION_MODE_TOUCHConstant 
public static const INTERACTION_MODE_TOUCH:String = touch

The user may touch anywhere on the scroller and drag to scroll. The scroll bars will be visual indicator of position, but they will not be interactive.

See also

INTERACTION_MODE_TOUCH_AND_SCROLL_BARSConstant 
public static const INTERACTION_MODE_TOUCH_AND_SCROLL_BARS:String = touchAndScrollBars

The user may touch anywhere on the scroller and drag to scroll, and the scroll bars may be dragged separately. For most touch interfaces, this is not a common behavior. The scroll bar on touch interfaces is often simply a visual indicator and non-interactive.

One case where this mode might be used is a "scroll bar" that displays a tappable alphabetical index to navigate a GroupedList with alphabetical categories.

See also

MOUSE_WHEEL_SCROLL_DIRECTION_HORIZONTALConstant 
public static const MOUSE_WHEEL_SCROLL_DIRECTION_HORIZONTAL:String = horizontal

The scroller will scroll horizontally when the mouse wheel is scrolled.

See also

MOUSE_WHEEL_SCROLL_DIRECTION_VERTICALConstant 
public static const MOUSE_WHEEL_SCROLL_DIRECTION_VERTICAL:String = vertical

The scroller will scroll vertically when the mouse wheel is scrolled.

See also

SCROLL_BAR_DISPLAY_MODE_FIXEDConstant 
public static const SCROLL_BAR_DISPLAY_MODE_FIXED:String = fixed

The scroll bars are always visible and appear next to the scroller's view port, making the view port smaller than the scroller.

See also

SCROLL_BAR_DISPLAY_MODE_FIXED_FLOATConstant 
public static const SCROLL_BAR_DISPLAY_MODE_FIXED_FLOAT:String = fixedFloat

The scroll bars appear above the scroller's view port, overlapping the content, but they do not fade out when not in use.

See also

SCROLL_BAR_DISPLAY_MODE_FLOATConstant 
public static const SCROLL_BAR_DISPLAY_MODE_FLOAT:String = float

The scroll bars appear above the scroller's view port, overlapping the content, and they fade out when not in use.

See also

SCROLL_BAR_DISPLAY_MODE_NONEConstant 
public static const SCROLL_BAR_DISPLAY_MODE_NONE:String = none

The scroll bars are never visible.

See also

SCROLL_POLICY_AUTOConstant 
public static const SCROLL_POLICY_AUTO:String = auto

The scroller may scroll if the view port is larger than the scroller's bounds. If the interaction mode is touch, the elastic edges will only be active if the maximum scroll position is greater than zero. If the scroll bar display mode is fixed, the scroll bar will only be visible when the maximum scroll position is greater than zero.

See also

SCROLL_POLICY_OFFConstant 
public static const SCROLL_POLICY_OFF:String = off

The scroller does not scroll at all. If the scroll bar display mode is fixed or float, the scroll bar will never be visible.

See also

SCROLL_POLICY_ONConstant 
public static const SCROLL_POLICY_ON:String = on

The scroller will always scroll. If the interaction mode is touch, elastic edges will always be active, even when the maximum scroll position is zero. If the scroll bar display mode is fixed, the scroll bar will always be visible.

See also

STATE_DISABLEDConstant 
public static const STATE_DISABLED:String = disabled

The TextArea is disabled.

STATE_ENABLEDConstant 
public static const STATE_ENABLED:String = enabled

The TextArea is enabled and does not have focus.

STATE_FOCUSEDConstant 
public static const STATE_FOCUSED:String = focused

The TextArea is enabled and has focus.

VERTICAL_SCROLL_BAR_POSITION_LEFTConstant 
public static const VERTICAL_SCROLL_BAR_POSITION_LEFT:String = left

The vertical scroll bar will be positioned on the left.

See also

VERTICAL_SCROLL_BAR_POSITION_RIGHTConstant 
public static const VERTICAL_SCROLL_BAR_POSITION_RIGHT:String = right

The vertical scroll bar will be positioned on the right.

See also