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

For internal use in subclasses.

The current state of the text area.

See also

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

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

See also

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

The following example displays an error string:

textArea.errorString = "Something is wrong";

The default value is null.

See also

The default IStyleProvider for all TextArea components.

The default value is null.

See also

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

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.

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.

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

See also

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

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

textArea.prompt = "User Name";

The default value is null.

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.

See also

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

The prompt text renderer sub-component.

For internal use in subclasses.

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.

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.

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.

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

See also

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

The factory should have the following function signature:

function():ITextEditorViewPort

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

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

The default value is null.

See also

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

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

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

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

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

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

The default value is null.

See also

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.

Manually removes focus from the text area control.

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

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

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

Parameters

See also

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

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

Parameters

See also

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

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

Parameters

See also

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

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

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

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

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

Parameters

See also

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

See also

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

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

Parameters

See also

Dispatched when the text area's text property changes.

The properties of the event object have the following values:

See also

Dispatched when the display object's state changes.

The properties of the event object have the following values:

See also

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

In the following example, the font styles are customized:

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

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

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

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

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

The following example gives the text area 20 pixels of inner padding on the left edge only:

textArea.innerPaddingLeft = 20;

The default value is 0.

See also

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

The following example gives the text area 20 pixels of inner padding on the bottom edge only:

textArea.innerPaddingBottom = 20;

The default value is 0.

See also

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

The following example gives the text area 20 pixels of inner padding on the right edge only:

textArea.innerPaddingRight = 20;

The default value is 0.

See also

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

The following example gives the text area 20 pixels of inner padding on the top edge only:

textArea.innerPaddingTop = 20;

The default value is 0.

See also

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

The following example gives the button 20 pixels of padding on all sides:

textArea.innerPadding = 20;

The default value is 0.

See also

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

In the following example, the font styles are customized:

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

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

The default value is null.

See also

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

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

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

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

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

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

The default value is null.

See also

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

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

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

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

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

The default value is null.

See also

A style name to add to the text area'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 area:

textArea.customPromptStyleName = "my-custom-text-area-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-area-prompt", setCustomTextAreaPromptStyles );

The default value is null.

See also

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

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

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

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

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

The default value is null.

See also

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

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

textArea.backgroundErrorSkin = new Image( texture );

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

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

The default value is null.

See also

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

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

textArea.backgroundFocusedSkin = new Image( texture );

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

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

The default value is null.

See also

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

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

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

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

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

The default value is null.

See also

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

See also

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

See also

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

See also