View source

class TextInput

package feathers.controls

extends FeathersControl › MeasureSprite › ValidatingSprite

implements IFocusObject, ITextControl, IStateContext<TextInputState>

@:directlyUsed@:build(feathers.macros.StyleMacro.build())@:autoBuild(feathers.macros.StyleMacro.build())@:build(feathers.macros.StyleContextMacro.build())@:autoBuild(feathers.macros.StyleContextMacro.build())@:styleContext

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);
Available since

1.0.0

.

See also:

Constructor

new()

Creates a new TextInput object.

Available since

1.0.0

.

Variables

@:value(null)@:stylebackgroundSkin:DisplayObject = null

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:

@:value(ENABLED)read onlycurrentState:TextInputState = ENABLED

The current state of the text input.

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:

@:value(true)editable:Bool = true

Indicates if the text input is editable.

The following example disables editing:

textInput.editable = false;
Available since

1.0.0

.

@:value(false)@:styleembedFonts:Bool = false

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:

@:value(0.0)@:stylepaddingBottom:Float = 0.0

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

.

@:value(0.0)@:stylepaddingLeft:Float = 0.0

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

.

@:value(0.0)@:stylepaddingRight:Float = 0.0

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

.

@:value(0.0)@:stylepaddingTop:Float = 0.0

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

.

@:value(null)@:isVarprompt:String = null

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:

@:value(null)@:stylepromptTextFormat:TextFormat = null

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:

@:value(0.0)scrollX:Float = 0.0

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

.

@:value("")@:isVartext: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:

@:value(null)@:styletextFormat:TextFormat = null

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:

@:value(MIDDLE)@:styleverticalAlign:VerticalAlign = MIDDLE

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;

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

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:

@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:TextFormat):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

@:value(false)read onlycreated:Bool = false

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);
}

See also:

@:value(true)@:isVarenabled:Bool = true

See also:

@:value(true)@:isVarfocusEnabled:Bool = true

See also:

@:value(null)@:isVarfocusManager:IFocusManager = null

See also:

@:value(null)@:isVar@stylefocusRectSkin:DisplayObject = null

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

Available since

1.0.0

.

@:value(true)includeInLayout:Bool = true

See also:

@:value(false)read onlyinitialized:Bool = false

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:

@:value(null)@stylelayoutData:ILayoutData = null

See also:

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

When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.

You can set or replace an existing style provider at any time before a component initializes without immediately affecting the component's visual appearance. After the component initializes, the style provider may still be changed, and any properties that were set by the previous style provider will be reset to their default values before applying the new style provider.

Available since

1.0.0

.

See also:

@:value(null)variant:String = null

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

@:value(null)@:isVarexplicitHeight:Null<Float> = null

See also:

@:value(null)@:isVarexplicitMaxHeight:Null<Float> = null

See also:

@:value(null)@:isVarexplicitMaxWidth:Null<Float> = null

See also:

@:value(null)@:isVarexplicitMinHeight:Null<Float> = null

See also:

@:value(null)@:isVarexplicitMinWidth:Null<Float> = null

See also:

@:value(null)@:isVarexplicitWidth:Null<Float> = null

See also:

@:flash.propertymaxHeight:Float

See also:

@:flash.propertymaxWidth:Float

See also:

@:flash.propertyminHeight:Float

See also:

@:flash.propertyminWidth:Float

See also:

Defined by ValidatingSprite

@:value(-1)read onlydepth:Int = -1

See also:

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, Event.INIT is dispatched.

The following example overrides initialization:

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

}
Available since

1.0.0

.

initializeNow():Void

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

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

.

showFocus(show:Bool):Void

See also:

Defined by MeasureSprite

resetHeight():Void

See also:

resetMaxHeight():Void

See also:

resetMaxWidth():Void

See also:

resetMinHeight():Void

See also:

resetMinWidth():Void

See also:

resetWidth():Void

See also:

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

@:value({ flag : null })isInvalid(?flag:String):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

.

@:value({ flag : null })setInvalid(?flag:String):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:String):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

.