Packagefeathers.controls
Classpublic class TextInput
InheritanceTextInput Inheritance FeathersControl Inheritance starling.display.Sprite
Implements ITextBaselineControl, IAdvancedNativeFocusOwner, IStateContext
Subclasses AutoComplete

Product Version : Feathers 1.0.0

A text entry control that allows users to enter and edit a single line of uniformly-formatted text.

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

var input:TextInput = new TextInput();
input.text = "Hello World";
input.selectRange( 0, input.text.length );
input.addEventListener( Event.CHANGE, input_changeHandler );
this.addChild( input );

See also

How to use the Feathers TextInput component
Introduction to Feathers text editors
feathers.core.ITextEditor
feathers.controls.AutoComplete
feathers.controls.TextArea


Public Properties
 PropertyDefined By
  baseline : Number
[read-only] The baseline measurement of the text, in pixels.
TextInput
  currentState : String
[read-only] The current state of the text input.
TextInput
 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
  displayAsPassword : Boolean
Determines if the entered text will be masked so that it cannot be seen, such as for a password input.
TextInput
  errorString : String
Error text to display in a Callout when the input has focus.
TextInput
 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
 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
 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 TextInput components.
TextInput
  hasFocus : Boolean
[read-only] When the FocusManager isn't enabled, hasFocus can be used instead of FocusManager.focus == textInput to determine if the text input has focus.
TextInput
 Inheritedheight : Number
[override] The height of the component, in pixels.
FeathersControl
 InheritedincludeInLayout : Boolean
Determines if the ILayout should use this object or ignore it.
FeathersControl
 InheritedisCreated : Boolean
[read-only] Determines if the component has been initialized and validated for the first time.
FeathersControl
  isEditable : Boolean
Determines if the text input is editable.
TextInput
 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
 InheritedisQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list.
FeathersControl
  isSelectable : Boolean
If the isEditable property is set to false, the isSelectable property determines if the text is selectable.
TextInput
 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.
TextInput
 InheritedmaxHeight : Number
The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmaxWidth : Number
The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminHeight : Number
The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 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
 InheritedminWidth : Number
The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
  nativeFocus : Object
[read-only] A text editor may be an INativeFocusOwner, so we need to return the value of its nativeFocus property.
TextInput
 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
 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
  prompt : String
The prompt, hint, or description text displayed by the input when the value of its text is empty.
TextInput
  promptFactory : Function
A function used to instantiate the prompt text renderer.
TextInput
  promptProperties : Object
An object that stores properties for the input's prompt text renderer sub-component, and the properties will be passed down to the text renderer when the input validates.
TextInput
  restrict : String
Limits the set of characters that may be entered.
TextInput
  selectionBeginIndex : int
[read-only] The index of the first character of the selection.
TextInput
  selectionEndIndex : int
[read-only] The index of the last character of the selection.
TextInput
  stateToIconFunction : Function
Deprecated Since 3.0.0: Please Use feathers.skins.ImageSkin
DEPRECATED: Create a feathers.skins.ImageSkin instead, and pass to the defaultIcon property.
TextInput
 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 input.
TextInput
  textEditorFactory : Function
A function used to instantiate the text editor.
TextInput
  textEditorProperties : Object
An object that stores properties for the input's text editor sub-component, and the properties will be passed down to the text editor when the input validates.
TextInput
 InheritedtoolTip : String
Text to display in a tool tip to when hovering over this component, if the ToolTipManager is enabled.
FeathersControl
 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.
TextInput
  currentBackground : DisplayObject
The currently selected background, based on state.
TextInput
  currentIcon : DisplayObject
The currently visible icon.
TextInput
 InheriteddefaultStyleProvider : IStyleProvider
[read-only] When the FeathersControl constructor is called, the styleProvider property is set to this value.
FeathersControl
  errorCalloutStyleName : String = "feathers-text-input-error-callout"
The value added to the styleNameList of the error callout.
TextInput
  promptStyleName : String = "feathers-text-input-prompt"
The value added to the styleNameList of the prompt text renderer.
TextInput
  promptTextRenderer : ITextRenderer
The prompt text renderer sub-component.
TextInput
  textEditor : ITextEditor
The text editor sub-component.
TextInput
  textEditorStyleName : String = "feathers-text-input-text-editor"
The value added to the styleNameList of the text editor.
TextInput
Public Methods
 MethodDefined By
  
Constructor.
TextInput
  
clearFocus():void
Manually removes focus from the text input control.
TextInput
 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 input's text when the input's currentState property matches the specified state value.
TextInput
  
getIconForState(state:String):DisplayObject
Gets the icon to be used by the text input when the input's currentState property matches the specified state value.
TextInput
  
getPromptFontStylesForState(state:String):TextFormat
Gets the font styles to be used to display the input's prompt when the input's currentState property matches the specified state value.
TextInput
  
getSkinForState(state:String):DisplayObject
Gets the skin to be used by the text input when the input's currentState property matches the specified state value.
TextInput
 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
Resets the styleProvider property to its default value, which is usually the global style provider for the component.
FeathersControl
  
selectRange(beginIndex:int, endIndex:int = -1):void
Sets the range of selected characters.
TextInput
  
setFocus():void
Focuses the text input control so that it may be edited, and selects all of its text.
TextInput
  
setFontStylesForState(state:String, format:TextFormat):void
Sets the font styles to be used to display the input's text when the input's currentState property matches the specified state value.
TextInput
  
setIconForState(state:String, icon:DisplayObject):void
Sets the icon to be used by the text input when the input's currentState property matches the specified state value.
TextInput
  
setPromptFontStylesForState(state:String, format:TextFormat):void
Sets the font styles to be used to display the input's prompt when the input's currentState property matches the specified state value.
TextInput
 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 input when the input's currentState property matches the specified state value.
TextInput
 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
validate():void
Immediately validates the display object, if it is invalid.
FeathersControl
Protected Methods
 MethodDefined By
  
If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself.
TextInput
 Inherited
clearInvalidationFlag(flag:String):void
Clears an invalidation flag.
FeathersControl
  
Creates and adds the textEditor sub-component and removes the old instance, if one exists.
TextInput
 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
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
  
Positions and sizes the text input's children.
TextInput
 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
  
Sets the currentBackground property.
TextInput
 Inherited
Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.
FeathersControl
  
Sets the currentIcon property.
TextInput
 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
Events
 Event Summary Defined By
  Dispatched when the text input's text property changes.TextInput
 InheritedDispatched after the component has validated for the first time.FeathersControl
  Dispatched when the user presses the Enter key while the text input has focus.TextInput
  Dispatched when the text input receives focus.TextInput
  Dispatched when the text input loses focus.TextInput
 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
  Dispatched when the soft keyboard is activated by the text editor.TextInput
  Dispatched when the soft keyboard is about the be activated by the text editor.TextInput
  Dispatched when the soft keyboard is deactivated by the text editor.TextInput
  Dispatched when the display object's state changes.TextInput
Styles
 StyleDefined By
  
backgroundDisabledSkin : DisplayObject
The skin used for the input's disabled state.
TextInput
  
backgroundEnabledSkin : DisplayObject
The skin used for the input's enabled state.
TextInput
  
backgroundErrorSkin : DisplayObject
The skin used for the input's error state.
TextInput
  
backgroundFocusedSkin : DisplayObject
The skin used for the input's focused state.
TextInput
  
backgroundSkin : DisplayObject
The skin used when no other skin is defined for the current state.
TextInput
  
A style name to add to the text input's error callout sub-component.
TextInput
  
A style name to add to the text input's prompt text renderer sub-component.
TextInput
  
A style name to add to the text input's text editor sub-component.
TextInput
  
defaultIcon : DisplayObject
The icon used when no other icon is defined for the current state.
TextInput
  
disabledFontStyles : TextFormat
The font styles used to display the input's text when the input is disabled.
TextInput
  
disabledIcon : DisplayObject
The icon used for the input's disabled state.
TextInput
  
enabledIcon : DisplayObject
The icon used for the input's enabled state.
TextInput
  
errorIcon : DisplayObject
The icon used for the input's error state.
TextInput
  
focusedIcon : DisplayObject
The icon used for the input's focused state.
TextInput
 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 input's text.
TextInput
  
gap : Number
The space, in pixels, between the icon and the text editor, if an icon exists.
TextInput
  
padding : Number
Quickly sets all padding properties to the same value.
TextInput
  
paddingBottom : Number
The minimum space, in pixels, between the input's bottom edge and the input's content.
TextInput
  
paddingLeft : Number
The minimum space, in pixels, between the input's left edge and the input's content.
TextInput
  
paddingRight : Number
The minimum space, in pixels, between the input's right edge and the input's content.
TextInput
  
paddingTop : Number
The minimum space, in pixels, between the input's top edge and the input's content.
TextInput
  
The font styles used to display the input's prompt when the input is disabled.
TextInput
  
promptFontStyles : TextFormat
The font styles used to display the input's prompt text.
TextInput
  
typicalText : String
If not null, the dimensions of the typicalText will be used in the calculation of the text input's full dimensions.
TextInput
  
verticalAlign : String
The location where the text editor is aligned vertically (on the y-axis).
TextInput
Public Constants
 ConstantDefined By
  ALTERNATE_STYLE_NAME_SEARCH_TEXT_INPUT : String = "feathers-search-text-input"
[static] An alternate style name to use with TextInput to allow a theme to give it a search input style.
TextInput
  DEFAULT_CHILD_STYLE_NAME_ERROR_CALLOUT : String = "feathers-text-input-error-callout"
[static] The default value added to the styleNameList of the error callout.
TextInput
  DEFAULT_CHILD_STYLE_NAME_PROMPT : String = "feathers-text-input-prompt"
[static] The default value added to the styleNameList of the prompt text renderer.
TextInput
  DEFAULT_CHILD_STYLE_NAME_TEXT_EDITOR : String = "feathers-text-input-text-editor"
[static] The default value added to the styleNameList of the text editor.
TextInput
 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
Property Detail
baselineproperty
baseline:Number  [read-only]

The baseline measurement of the text, in pixels.


Implementation
    public function get baseline():Number
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 the text input does not have focus.

For internal use in subclasses.

currentBackgroundproperty 
protected var currentBackground:DisplayObject

The currently selected background, based on state.

For internal use in subclasses.

currentIconproperty 
protected var currentIcon:DisplayObject

The currently visible icon. The value will be null if there is no currently visible icon.

For internal use in subclasses.

currentStateproperty 
currentState:String  [read-only]

The current state of the text input.


Implementation
    public function get currentState():String

See also

displayAsPasswordproperty 
displayAsPassword:Boolean

Determines if the entered text will be masked so that it cannot be seen, such as for a password input.

In the following example, the text input's text is displayed as a password:

input.displayAsPassword = true;

The default value is false.


Implementation
    public function get displayAsPassword():Boolean
    public function set displayAsPassword(value:Boolean):void
errorCalloutStyleNameproperty 
protected var errorCalloutStyleName:String = "feathers-text-input-error-callout"

The value added to the styleNameList of the error callout. This variable is protected so that sub-classes can customize the prompt 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 input has focus. When this value is not null the input'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:

input.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 TextInput 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 == textInput to determine if the text input has focus.


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

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

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

input.isEditable = false;

The default value is true.


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

See also

isSelectableproperty 
isSelectable:Boolean

If the isEditable property is set to false, the isSelectable property determines if the text is selectable. If the isEditable property is set to true, the text will always be selectable.

In the following example, the text input is not selectable:

input.isEditable = false;
input.isSelectable = false;

The default value is true.


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

See also

maxCharsproperty 
maxChars:int

The maximum number of characters that may be entered. If 0, any number of characters may be entered.

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

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

promptproperty 
prompt:String

The prompt, hint, or description text displayed by the input when the value of its text is empty.

In the following example, the text input's prompt is updated:

input.prompt = "User Name";

The default value is null.


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

A function used to instantiate the prompt text renderer. If null, FeathersControl.defaultTextRendererFactory is used instead. The prompt text renderer must be an instance of ITextRenderer. This factory can be used to change properties on the prompt 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 prompt.

The factory should have the following function signature:

function():ITextRenderer

If the prompt property is null, the prompt text renderer will not be created.

In the following example, a custom prompt factory is passed to the text input:

input.promptFactory = function():ITextRenderer
{
    return new TextFieldTextRenderer();
};

The default value is null.


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

See also

promptPropertiesproperty 
promptProperties:Object

An object that stores properties for the input's prompt text renderer sub-component, and the properties will be passed down to the text renderer when the input validates. The available properties depend on which ITextRenderer implementation is returned by messageFactory. Refer to feathers.core.ITextRenderer for a list of available text renderer implementations.

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 promptFactory function instead of using promptProperties will result in better performance.

In the following example, the text input's prompt's properties are updated (this example assumes that the prompt text renderer is a TextFieldTextRenderer):

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

The default value is null.


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

See also

promptStyleNameproperty 
protected var promptStyleName:String = "feathers-text-input-prompt"

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

To customize the prompt text renderer style name without subclassing, see customPromptStyleName.

See also

promptTextRendererproperty 
protected var promptTextRenderer:ITextRenderer

The prompt text renderer sub-component.

For internal use in subclasses.

restrictproperty 
restrict:String

Limits the set of characters that may be entered.

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

input.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
stateToIconFunctionproperty 
stateToIconFunction:Function
Deprecated Since 3.0.0: Please Use feathers.skins.ImageSkin

DEPRECATED: Create a feathers.skins.ImageSkin instead, and pass to the defaultIcon property.

DEPRECATION WARNING: This property is deprecated starting with Feathers 3.0. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.


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

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

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

input.text = "Hello World";

The default value is "".


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

See also

textEditorproperty 
protected var textEditor:ITextEditor

The text editor sub-component.

For internal use in subclasses.

textEditorFactoryproperty 
textEditorFactory:Function

A function used to instantiate the text editor. If null, FeathersControl.defaultTextEditorFactory is used instead. The text editor must be an instance of ITextEditor. This factory can be used to change properties on the text editor 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.

The factory should have the following function signature:

function():ITextEditor

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

input.textEditorFactory = function():ITextEditor
{
    return new TextFieldTextEditor();
};

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 input's text editor sub-component, and the properties will be passed down to the text editor when the input validates. The available properties depend on which ITextEditor implementation is returned by textEditorFactory. Refer to feathers.core.ITextEditor for a list of available text editor implementations.

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 StageTextTextEditor):

input.textEditorProperties.fontName = "Helvetica";
input.textEditorProperties.fontSize = 16;

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-input-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
TextInput()Constructor
public function TextInput()

Constructor.

Method Detail
autoSizeIfNeeded()method
protected function autoSizeIfNeeded():Boolean

If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself. If the explicitWidth or explicitHeight member variables are set, those value will be used without additional measurement. If one is set, but not the other, the dimension with the explicit value will not be measured, but the other non-explicit dimension will still need measurement.

Calls saveMeasurements() to set up the actualWidth and actualHeight member variables used for layout.

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

Returns
Boolean
clearFocus()method 
public function clearFocus():void

Manually removes focus from the text input control.

createTextEditor()method 
protected function createTextEditor():void

Creates and adds the textEditor 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 input's text when the input'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

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

Gets the icon to be used by the text input when the input's currentState property matches the specified state value.

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

Parameters

state:String

Returns
DisplayObject

See also

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

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

If prompt 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 input when the input's 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

layoutChildren()method 
protected function layoutChildren():void

Positions and sizes the text input's children.

For internal use in subclasses.

refreshBackgroundSkin()method 
protected function refreshBackgroundSkin():void

Sets the currentBackground property.

For internal use in subclasses.

refreshIcon()method 
protected function refreshIcon():void

Sets the currentIcon property.

For internal use in subclasses.

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 input control so that it may be edited, and selects all of its text. Call selectRange() after setFocus() to select a different range.

See also

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

Sets the font styles to be used to display the input's text when the input'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

setIconForState()method 
public function setIconForState(state:String, icon:DisplayObject):void

Sets the icon to be used by the text input when the input's currentState property matches the specified state value.

If an icon is not defined for a specific state, the value of the defaultIcon property will be used instead.

Parameters

state:String
 
icon:DisplayObject

See also

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

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

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

Note: if the text renderer has been customized with advanced font formatting, it may override the values specified with setPromptFontStylesForState() and properties like promptFontStyles and promptDisabledFontStyles.

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 input when the input's 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 input'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

enter Event  
Event Object Type: starling.events.Event
Event.type property = feathers.events.FeathersEventType.ENTER

Dispatched when the user presses the Enter key while the text input has focus. This event may not be dispatched at all times. Certain text editors will not dispatch an event for the enter key on some platforms, depending on the values of certain properties. This may include the default values for some platforms! If you've encountered this issue, please see the specific text editor's API documentation for complete details of this event's limitations and requirements.

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.ENTER event type is meant to be used when the enter key has been pressed in an input control.
focusIn Event  
Event Object Type: starling.events.Event
Event.type property = feathers.events.FeathersEventType.FOCUS_IN

Dispatched when the text input receives focus.

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.FOCUS_IN event type is used by Feathers components to indicate when they have received focus.
focusOut Event  
Event Object Type: starling.events.Event
Event.type property = feathers.events.FeathersEventType.FOCUS_OUT

Dispatched when the text input loses focus.

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.FOCUS_OUT event type is used by Feathers components to indicate when they have lost focus.
softKeyboardActivate Event  
Event Object Type: starling.events.Event
Event.type property = feathers.events.FeathersEventType.SOFT_KEYBOARD_ACTIVATE

Dispatched when the soft keyboard is activated by the text editor. Not all text editors will activate a soft keyboard.

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.SOFT_KEYBOARD_ACTIVATE event type is used by Feathers text editors when they activate a device's soft keyboard.
softKeyboardActivating Event  
Event Object Type: starling.events.Event
Event.type property = feathers.events.FeathersEventType.SOFT_KEYBOARD_ACTIVATING

Dispatched when the soft keyboard is about the be activated by the text editor. Not all text editors will activate a soft keyboard.

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.SOFT_KEYBOARD_ACTIVATING event type is used by Feathers text editors when they are about to activate a device's soft keyboard.
softKeyboardDeactivate Event  
Event Object Type: starling.events.Event
Event.type property = feathers.events.FeathersEventType.SOFT_KEYBOARD_DEACTIVATE

Dispatched when the soft keyboard is deactivated by the text editor. Not all text editors will activate a soft keyboard.

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.SOFT_KEYBOARD_DEACTIVATE event type is used by Feathers text editors when they deactivate a device's soft keyboard.
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
verticalAlignstyle
verticalAlign:String

The location where the text editor is aligned vertically (on the y-axis).

The following example aligns the text editor to the top:

input.verticalAlign = VerticalAlign.TOP;

The default value is feathers.layout.VerticalAlign.MIDDLE.

See also

typicalTextstyle 
typicalText:String

If not null, the dimensions of the typicalText will be used in the calculation of the text input's full dimensions. If the text input's dimensions haven't been set explicitly, it's calculated dimensions will be at least large enough to display the typicalText. Other children, such as the background skin and the prompt text renderer may also affect the dimensions of the text input, allowing it to, potentially, be bigger than the rendered typicalText.

In the following example, the text input's typical text is updated:

input.text = "We want to allow the text input to show all of this text";

The default value is null.

promptFontStylesstyle 
promptFontStyles:TextFormat

The font styles used to display the input's prompt text.

In the following example, the font styles are customized:

input.promptFontStyles = new TextFormat( "Helvetica", 20, 0xcc0000 );

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

The default value is null.

See also

promptDisabledFontStylesstyle 
promptDisabledFontStyles:TextFormat

The font styles used to display the input's prompt when the input is disabled.

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

input.promptDisabledFontStyles = new TextFormat( "Helvetica", 20, 0x999999 );

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

The default value is null.

See also

paddingLeftstyle 
paddingLeft:Number

The minimum space, in pixels, between the input's left edge and the input's content.

In the following example, the text input's left padding is set to 20 pixels:

input.paddingLeft = 20;

The default value is 0.

See also

paddingBottomstyle 
paddingBottom:Number

The minimum space, in pixels, between the input's bottom edge and the input's content.

In the following example, the text input's bottom padding is set to 20 pixels:

input.paddingBottom = 20;

The default value is 0.

See also

paddingRightstyle 
paddingRight:Number

The minimum space, in pixels, between the input's right edge and the input's content.

In the following example, the text input's right padding is set to 20 pixels:

input.paddingRight = 20;

The default value is 0.

See also

paddingTopstyle 
paddingTop:Number

The minimum space, in pixels, between the input's top edge and the input's content.

In the following example, the text input's top padding is set to 20 pixels:

input.paddingTop = 20;

The default value is 0.

See also

paddingstyle 
padding:Number

Quickly sets all padding properties to the same value. The padding getter always returns the value of paddingTop, but the other padding values may be different.

In the following example, the text input's padding is set to 20 pixels:

input.padding = 20;

The default value is 0.

See also

gapstyle 
gap:Number

The space, in pixels, between the icon and the text editor, if an icon exists.

The following example creates a gap of 50 pixels between the icon and the text editor:

button.defaultIcon = new Image( texture );
button.gap = 50;

The default value is 0.

fontStylesstyle 
fontStyles:TextFormat

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

In the following example, the font styles are customized:

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

focusedIconstyle 
focusedIcon:DisplayObject

The icon used for the input's focused state. If null, then defaultIcon is used instead.

The following example gives the input an icon for the focused state:

button.focusedIcon = new Image( texture );

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

var icon:Image = new Image( texture );
input.setIconForState( TextInputState.FOCUSED, icon );

The default value is null.

See also

errorIconstyle 
errorIcon:DisplayObject

The icon used for the input's error state. If null, then defaultIcon is used instead.

The following example gives the input an icon for the error state:

button.errorIcon = new Image( texture );

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

var icon:Image = new Image( texture );
input.setIconForState( TextInputState.ERROR, icon );

The default value is null.

See also

enabledIconstyle 
enabledIcon:DisplayObject

The icon used for the input's enabled state. If null, then defaultIcon is used instead.

The following example gives the input an icon for the enabled state:

button.enabledIcon = new Image( texture );

Alternatively, you may use setIconForState() with TextInputState.ENABLED to set the same icon:

var icon:Image = new Image( texture );
input.setIconForState( TextInputState.ENABLED, icon );

The default value is null.

See also

disabledIconstyle 
disabledIcon:DisplayObject

The icon used for the input's disabled state. If null, then defaultIcon is used instead.

The following example gives the input an icon for the disabled state:

button.disabledIcon = new Image( texture );

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

var icon:Image = new Image( texture );
input.setIconForState( TextInputState.DISABLED, icon );

The default value is null.

See also

disabledFontStylesstyle 
disabledFontStyles:TextFormat

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

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

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

defaultIconstyle 
defaultIcon:DisplayObject

The icon used when no other icon is defined for the current state. Intended for use when multiple states should use the same icon.

The following example gives the input a default icon to use for all states when no specific icon is available:

input.defaultIcon = new Image( texture );

The default value is null.

See also

customTextEditorStyleNamestyle 
customTextEditorStyleName:String

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

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

input.customTextEditorStyleName = "my-custom-text-input-text-editor";

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

getStyleProviderForClass( StageTextTextEditor ).setFunctionForStyleName( "my-custom-text-input-text-editor", setCustomTextInputTextEditorStyles );

The default value is null.

See also

customPromptStyleNamestyle 
customPromptStyleName:String

A style name to add to the text input's prompt text renderer sub-component. Typically used by a theme to provide different styles to different text inputs.

In the following example, a custom prompt text renderer style name is passed to the text input:

input.customPromptStyleName = "my-custom-text-input-prompt";

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

getStyleProviderForClass( BitmapFontTextRenderer ).setFunctionForStyleName( "my-custom-text-input-prompt", setCustomTextInputPromptStyles );

The default value is null.

See also

customErrorCalloutStyleNamestyle 
customErrorCalloutStyleName:String

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

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

input.customErrorCalloutStyleName = "my-custom-text-input-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-input-error-callout", setCustomTextInputErrorCalloutStyles );

The default value is null.

See also

backgroundSkinstyle 
backgroundSkin:DisplayObject

The skin used when no other skin is defined for the current state. Intended for use when multiple states should use the same skin.

The following example gives the input a default skin to use for all states when no specific skin is available:

input.backgroundSkin = new Image( texture );

The default value is null.

See also

backgroundFocusedSkinstyle 
backgroundFocusedSkin:DisplayObject

The skin used for the input's focused state. If null, then backgroundSkin is used instead.

The following example gives the input a skin for the focused state:

input.backgroundFocusedSkin = new Image( texture );

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

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

The default value is null.

See also

backgroundErrorSkinstyle 
backgroundErrorSkin:DisplayObject

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

The following example gives the input a skin for the error state:

input.backgroundErrorSkin = new Image( texture );

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

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

The default value is null.

See also

backgroundEnabledSkinstyle 
backgroundEnabledSkin:DisplayObject

The skin used for the input's enabled state. If null, then backgroundSkin is used instead.

The following example gives the input a skin for the enabled state:

input.backgroundEnabledSkin = new Image( texture );

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

var skin:Image = new Image( texture );
input.setSkinForState( TextInputState.ENABLED, skin );

The default value is null.

See also

backgroundDisabledSkinstyle 
backgroundDisabledSkin:DisplayObject

The skin used for the input's disabled state. If null, then backgroundSkin is used instead.

The following example gives the input a skin for the disabled state:

input.backgroundDisabledSkin = new Image( texture );

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

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

The default value is null.

See also

Constant Detail
ALTERNATE_STYLE_NAME_SEARCH_TEXT_INPUTConstant
public static const ALTERNATE_STYLE_NAME_SEARCH_TEXT_INPUT:String = "feathers-search-text-input"

An alternate style name to use with TextInput to allow a theme to give it a search input style. If a theme does not provide a style for the search text input, the theme will automatically fal back to using the default text input style.

An alternate style name should always be added to a component's styleNameList before the component is initialized. If the style name is added later, it will be ignored.

In the following example, the search style is applied to a text input:

var input:TextInput = new TextInput();
input.styleNameList.add( TextInput.ALTERNATE_STYLE_NAME_SEARCH_TEXT_INPUT );
this.addChild( input );

See also

DEFAULT_CHILD_STYLE_NAME_ERROR_CALLOUTConstant 
public static const DEFAULT_CHILD_STYLE_NAME_ERROR_CALLOUT:String = "feathers-text-input-error-callout"

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

See also

DEFAULT_CHILD_STYLE_NAME_PROMPTConstant 
public static const DEFAULT_CHILD_STYLE_NAME_PROMPT:String = "feathers-text-input-prompt"

The default value added to the styleNameList of the prompt text renderer.

See also

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

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

See also