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 = new TextInput();
input.text = "Hello World";
input.selectRange(0, input.text.length);
input.addEventListener(Event.CHANGE, input_changeHandler);
this.addChild(input);

Events:

openfl.events.Event.CHANGE

Dispatched when TextInput.text changes.

openfl.events.Event.SCROLL

Dispatched when TextInput.scrollX changes.

Available since

1.0.0

.

See also:

Static variables

@:value("textInput_errorCallout")staticfinalread onlyCHILD_VARIANT_ERROR_CALLOUT:String = "textInput_errorCallout"

The variant used to style the error string TextCallout child component in a theme.

To override this default variant, set the TextInput.customErrorCalloutVariant property.

Available since

1.0.0

.

See also:

@:value("search")staticfinalread onlyVARIANT_SEARCH:String = "search"

A variant used to style the text input as a search box. Variants allow themes to provide an assortment of different appearances for the same type of UI component.

The following example uses this variant:

var input = new TextInput();
input.variant = Label.VARIANT_SEARCH;
Available since

1.0.0

.

See also:

Constructor

@:value({ text : "" })new(text:String = "", ?prompt:String, ?changeListener:Event ‑> Void)

Creates a new TextInput object.

Available since

1.0.0

.

Variables

@:style@:flash.propertyautoSizeWidth:Bool

Indicates if the text width is considered when calculating the ideal size of the text input.

The following example changes the text input's auto size behavior:

input.autoSizeWidth = true;
Available since

1.0.0

.

@:style@:flash.propertybackgroundSkin:DisplayObject

The default background skin for the text input, which is used when no other skin is defined for the current state with setSkinForState().

The following example passes a bitmap for the text input to use as a background skin:

input.backgroundSkin = new Bitmap(bitmapData);
Available since

1.0.0

.

See also:

@:bindable("stateChange")read onlycurrentState:TextInputState

The current state of the text input.

Available since

1.0.0

.

See also:

@:style@:flash.propertycustomErrorCalloutVariant:String

A custom variant to set on the error callout, instead of TextInput.CHILD_VARIANT_ERROR_CALLOUT.

The customErrorCalloutVariant will be not be used if the TextCallout already has a variant set.

Available since

1.0.0

.

See also:

@:style@:flash.propertydisabledTextFormat:AbstractTextFormat

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

In the following example, the text input's disabled text formatting is customized:

input.enabled = false;
input.disabledTextFormat = new TextFormat("Helvetica", 20, 0xee0000);
Available since

1.0.0

.

See also:

displayAsPassword:Bool

Masks the text so that it cannot be read.

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

input.displayAsPassword = true;
Available since

1.0.0

.

See also:

editable:Bool

Indicates if the text input is editable.

The following example disables editing:

textInput.editable = false;
Available since

1.0.0

.

@:style@:flash.propertyembedFonts:Bool

Determines if an embedded font is used or not.

In the following example, the text input uses embedded fonts:

input.embedFonts = true;
Available since

1.0.0

.

See also:

errorCalloutFactory:AbstractDisplayObjectFactory<Dynamic, TextCallout>

Creates the error callout, which must be of type feathers.controls.TextCallout.

In the following example, a custom error callout factory is provided:

textInput.errorCalloutFactory = () ->
{
	return new TextCallout();
};
Available since

1.3.0

.

See also:

@:style@:flash.propertyerrorFocusRectSkin:DisplayObject

An alternate to focusRectSkin that is displayed when the text input is focused and errorString is not null.

Available since

1.3.0

.

errorStatePriority:Int

Sets the priority of TextInputState.ERROR. If two states are possible, the state with the higher priority takes precedence. If the priorities are equal, TextInputState.FOCUSED takes the default precedence.

Available since

1.3.0

.

errorString:String

Error text to display in a TextCallout when the text input has focus. When this value is not null the text input's currentState is changed to TextInputState.ERROR.

An empty string will change the background, but no TextCallout 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";
Available since

1.0.0

.

See also:

read onlyerrorStringCalloutOpen:Bool

Indicates if the callout for the errorString is currently open or closed.

Available since

1.0.0

.

See also:

focusedStatePriority:Int

Sets the priority of TextInputState.FOCUSED. If two states are possible, the state with the higher priority takes precedence. If the priorities are equal, TextInputState.FOCUSED takes the default precedence.

Available since

1.3.0

.

@:style@:flash.propertyleftView:DisplayObject

An optional view displayed inside the text input, to the left of its text.

The following example passes a bitmap for the text input to use as a left view:

input.leftView = new Bitmap(bitmapData);
Available since

1.0.0

.

See also:

@:style@:flash.propertyleftViewGap:Float

The gap between the left view and the text.

The following example sets the left view's gap to 20 pixels:

input.leftViewGap = 20.0;
Available since

1.0.0

.

See also:

maxChars:Int

The maximum number of characters that may be entered into the text input. If set to 0, the length of the text is unrestricted.

Available since

1.0.0

.

measureText:String

If not null, the dimensions of the measureText will be used in the calculation of the text input's width. If the text input's width hasn't been set explicitly, its calculated dimensions will be at least large enough to display the measureText. If other children of the text input, such as the background skin or the prompt text is larger than the width of the measureText, the text input will choose the largest required width.

Available since

1.0.0

.

@:style@:flash.propertypaddingBottom:Float

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

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

input.paddingBottom = 20.0;
Available since

1.0.0

.

@:style@:flash.propertypaddingLeft:Float

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

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

input.paddingLeft = 20.0;
Available since

1.0.0

.

@:style@:flash.propertypaddingRight:Float

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

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

input.paddingRight = 20.0;
Available since

1.0.0

.

@:style@:flash.propertypaddingTop:Float

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

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

input.paddingTop = 20.0;
Available since

1.0.0

.

@:inspectableprompt:String

The text displayed by the text input when the length of the text property is 0.

The following example sets the text input's prompt:

input.prompt = "Minimum 8 characters required";
Available since

1.0.0

.

See also:

@:style@:flash.propertypromptTextFormat:AbstractTextFormat

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

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

input.promptTextFormat = new TextFormat("Helvetica", 20, 0xcc0000);
Available since

1.0.0

.

See also:

restrict:String

Limits the set of characters that may be typed into the TextInput.

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

input.restrict = "0-9";
Available since

1.0.0

.

See also:

@:style@:flash.propertyrightView:DisplayObject

An optional view displayed inside the text input, to the right of its text.

The following example passes a bitmap for the text input to use as a right view:

input.rightView = new Bitmap(bitmapData);
Available since

1.0.0

.

See also:

@:style@:flash.propertyrightViewGap:Float

The gap between the right view and the text.

The following example sets the right view's gap to 20 pixels:

input.rightViewGap = 20.0;
Available since

1.0.0

.

See also:

@:bindable("scroll")scrollX:Float

The horizontal scroll position (on the x-axis) of the text, measured in pixels.

The following example changes the text input's scroll position:

input.scrollX = 20.0;
Available since

1.0.0

.

selectable:Bool

If the editable property is false, indicates if the text can still be selected. If the editable property is true, the text is always selectable, and this property is ignored.

The following example disables selection:

textInput.editable = false;
textInput.selectable = false;
Available since

1.0.0

.

read onlyselectionActiveIndex:Int

The character position of the active part of the selection. If the selection is changed with the arrow keys, the active index changes and the anchor index stays fixed. If both the active index and the anchor index are equal, then no text is selected and both values represent the position of the caret.

Available since

1.0.0

.

See also:

read onlyselectionAnchorIndex:Int

The character position of the anchor part of the selection. If the selection is changed with the arrow keys, the active index changes and the anchor index stays fixed. If both the active index and the anchor index are equal, then no text is selected and both values represent the position of the caret.

Available since

1.0.0

.

See also:

@:style@:flash.propertyshowPromptWhenEmptyAndFocused:Bool

Indicates if the prompt is shown when the length of the text is 0 and the text input is focused. Keeping the prompt visible until the user types something is considered better for usability because the user may look away for a moment and forget the prompt when they return.

The following example set the prompt to be hidden when focused and the text is empty:

input.showPromptWhenEmptyAndFocused = false;
Available since

1.1.0

.

@:bindable("change")@:inspectabletext:String

The text displayed by the text input.

When the value of the text property changes, the text input will dispatch an event of type Event.CHANGE.

The following example sets the text input's text:

input.text = "Good afternoon!";
Available since

1.0.0

.

See also:

@:style@:flash.propertytextFormat:AbstractTextFormat

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

In the following example, the text input's formatting is customized:

input.textFormat = new TextFormat("Helvetica", 20, 0xcc0000);
Available since

1.0.0

.

See also:

@:style@:flash.propertyverticalAlign:VerticalAlign

How the content is positioned vertically (along the y-axis) within the text input.

The following example aligns the text input's content to the top:

input.verticalAlign = TOP;
Available since

1.0.0

.

See also:

Methods

getSkinForState(state:TextInputState):DisplayObject

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

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

Available since

1.0.0

.

See also:

getTextFormatForState(state:TextInputState):AbstractTextFormat

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

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

Available since

1.0.0

.

See also:

selectAll():Void

Selects all of the text displayed by the text input.

Available since

1.0.0

.

See also:

selectRange(anchorIndex:Int, activeIndex:Int):Void

Selects the specified range of characters.

The following example selects the first three characters:

input.selectRange(0, 3);
Available since

1.0.0

.

See also:

setPadding(value:Float):Void

Sets all four padding properties to the same value.

Available since

1.0.0

.

See also:

@stylesetSkinForState(state:TextInputState, skin:DisplayObject):Void

Set the skin to be used by the text input 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.

Available since

1.0.0

.

See also:

@stylesetTextFormatForState(state:TextInputState, textFormat:AbstractTextFormat):Void

Set the text format to be used by the text input when its currentState property matches the specified state value.

If a text format is not defined for a specific state, the value of the textFormat property will be used instead.

Available since

1.0.0

.

See also:

Inherited Variables

Defined by FeathersControl

@:stylealwaysShowFocus:Bool

Indicates if the focusRectSkin should always be displayed when the component is focused, or only after keyboard focus changes.

Available since

1.3.0

.

@:bindable("creationComplete")read onlycreated:Bool

Determines if the component has been initialized and validated for the first time.

In the following example, we check if the component is created or not, and we listen for an event if it isn't:

if(!control.created)
{
	control.addEventListener(FeathersEventType.CREATION_COMPLETE, creationCompleteHandler);
}
Available since

1.0.0

.

See also:

@styledisabledAlpha:Null<Float>

When disabledAlpha is not null, sets the alpha property to this value when the the enabled property is set to false.

Available since

1.0.0

.

@:inspectable(defaultValue = "true")enabled:Bool

@stylefocusPaddingBottom:Float

Optional padding outside the bottom edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@stylefocusPaddingLeft:Float

Optional padding outside the left edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@stylefocusPaddingRight:Float

Optional padding outside the right edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@stylefocusPaddingTop:Float

Optional padding outside the top edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@stylefocusRectSkin:DisplayObject

An optional skin to display when an IFocusObject component receives focus.

Available since

1.0.0

.

@:bindable("layoutDataChange")includeInLayout:Bool

@:bindable("initialize")read onlyinitialized:Bool

Determines if the component has been initialized yet. The initialize() function is called one time only, when the Feathers UI control is added to the display list for the first time.

In the following example, we check if the component is initialized or not, and we listen for an event if it isn't initialized:

if(!control.initialized)
{
	control.addEventListener(FeathersEvent.INITIALIZE, initializeHandler);
}
Available since

1.0.0

.

See also:

@style@:bindable("layoutDataChange")layoutData:ILayoutData

read onlystyleContext:Class<IStyleObject>

The class used as the context for styling the component. If a subclass of a component should have different styles than its superclass, it should override the get_styleContext getter. However, if a subclass should continue using the same styles as its superclass, it happens automatically.

Available since

1.0.0

.

styleProvider:IStyleProvider

Typically used by the theme to provide styles to each component, but a custom style provider may be provided that will take precedence over the theme's style provider.

When a component initializes, its style provider sets properties that affect the component's visual appearance. If the style provider dispatches StyleProviderEvent.STYLES_CHANGE after the component has initialized, the original properties set by the style provider will be reset to their default values and before applying the new property values.

Setting the style provider or replacing an existing style provider before a component initializes will queue up the style changes until after initialization. Once a component initializes, the style provider may be changed, but the changes will be applied immediately. Similarly to when a style provider dispatcches StyleProviderEvent.STYLES_CHANGE, any properties that were set by the previous style provider will be reset to their default values before applying the new style provider.

If the themeEnabled property is false, the current theme's style provider will be ignored. However, if a custom style provider was provided from outside of the theme, it will still be used.

Available since

1.0.0

.

See also:

@:inspectablevariant:String

May be used to provide multiple different variations of the same UI component, each with a different appearance.

Available since

1.0.0

.

Defined by MeasureSprite

Defined by ValidatingSprite

read onlyvalidating:Bool

Indicates if the display object is currently validating.

Available since

1.0.0

.

Inherited Methods

Defined by FeathersControl

private@:dox(show)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. Do things like create children and set up event listeners. After this function is called, `FeathersEvent.INITIALIZE is dispatched.

The following example overrides initialization:

override private function initialize():Void {
	super.initialize();

}
Available since

1.0.0

.

See also:

move(x:Float, y:Float):Void

Sets both the x and y positions of the control in a single function call.

Available since

1.0.0

.

See also:

  • DisplayObject.x

  • DisplayObject.y

setFocusPadding(value:Float):Void

setSize(width:Float, height:Float):Void

Sets both the width and height dimensions of the control in a single function call.

Available since

1.0.0

.

See also:

  • DisplayObject.width

  • DisplayObject.height

private@:dox(show)setStyle(styleName:String, ?state:EnumValue):Bool

Determines if a style may be changed, and restricts the style from being changed in the future, if necessary.

Available since

1.0.0

.

Defined by MeasureSprite

private@:value({ minHeight : 0.0, minWidth : 0.0 })@:dox(show)saveMeasurements(width:Float, height:Float, minWidth:Float = 0.0, minHeight:Float = 0.0, ?maxWidth:Float, ?maxHeight:Float):Bool

Saves the calculated dimensions for the component, replacing any values that haven't been set explicitly. Returns true if the reported values have changed and Event.RESIZE was dispatched.

Available since

1.0.0

.

Defined by ValidatingSprite

isInvalid(?flag:InvalidationFlag):Bool

Indicates whether the control is pending validation or not. By default, returns true if any invalidation flag has been set. If you pass in a specific flag, returns true only if that flag has been set (others may be set too, but it checks the specific flag only. If all flags have been marked as invalid, always returns true.

The following example invalidates a component:

component.setInvalid();
trace(component.isInvalid()); // true
Available since

1.0.0

.

runWithInvalidationFlagsOnly(callback:() ‑> Void):Void

Calls a function that temporarily limits setInvalid() calls to setting invalidation flags only, and the control will not be added to the validation queue. In other words, setInvalid() calls will work similarly to setInvalidationFlag() instead.

Typically, this method should be called only during validation. If called outside of update(), the component's validation may be delayed until a future call to setInvalid().

Available since

1.2.0

.

runWithoutInvalidation(callback:() ‑> Void):Void

Calls a function that temporarily disables invalidation. In other words, calls to setInvalid() will be ignored until the function returns.

Available since

1.0.0

.

setInvalid(?flag:InvalidationFlag):Void

Call this function to tell the UI control that a redraw is pending. The redraw will happen immediately before OpenFL renders the UI control to the screen. The validation system exists to ensure that multiple properties can be set together without redrawing multiple times in between each property change.

If you cannot wait until later for the validation to happen, you can call validate() to redraw immediately. As an example, you might want to validate immediately if you need to access the correct width or height values of the UI control, since these values are calculated during validation.

The following example invalidates a component:

component.setInvalid();
trace(component.isInvalid()); // true
Available since

1.0.0

.

private@:dox(show)setInvalidationFlag(flag:InvalidationFlag):Void

Sets an invalidation flag. This will not add the component to the validation queue. It only sets the flag. A subclass might use this function during draw() to manipulate the flags that its superclass sees.

Available since

1.0.0

.

See also:

private@:dox(show)update():Void

Override to customize layout and to adjust properties of children. Called when the component validates, if any flags have been marked to indicate that validation is pending.

The following example overrides updating after invalidation:

override private function update():Void {
	super.update();

}
Available since

1.0.0

.