class TextInput
package feathers.controls
extends FeathersControl › MeasureSprite › ValidatingSprite
implements IStageFocusDelegate, ITextControl, IStateContext<TextInputState>
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 |
|---|---|
openfl.events.Event.SCROLL | Dispatched when |
1.0.0
.See also:
Static variables
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.
1.0.0
.See also:
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;1.0.0
.See also:
Constructor
Variables
autoSizeWidth: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;1.0.0
.backgroundSkin: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);1.0.0
.See also:
read onlycurrentState:TextInputState
The current state of the text input.
1.0.0
.See also:
customErrorCalloutVariant: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.
1.0.0
.See also:
disabledTextFormat: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);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;1.0.0
.See also:
editable:Bool
Indicates if the text input is editable.
The following example disables editing:
textInput.editable = false;1.0.0
.embedFonts:Bool
Determines if an embedded font is used or not.
In the following example, the text input uses embedded fonts:
input.embedFonts = true;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();
};1.3.0
.See also:
errorFocusRectSkin:DisplayObject
An alternate to focusRectSkin that is displayed when the text input is
focused and errorString is not null.
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.
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";1.0.0
.See also:
read onlyerrorStringCalloutOpen:Bool
Indicates if the callout for the errorString is currently open or
closed.
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.
1.3.0
.leftView: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);1.0.0
.See also:
leftViewGap: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;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.
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.
1.0.0
.paddingBottom: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;1.0.0
.paddingLeft: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;1.0.0
.paddingRight: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;1.0.0
.paddingTop: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;1.0.0
.prompt: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";1.0.0
.See also:
promptTextFormat: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);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";1.0.0
.See also:
rightView: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);1.0.0
.See also:
rightViewGap: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;1.0.0
.See also:
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;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;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.
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.
1.0.0
.See also:
showPromptWhenEmptyAndFocused: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;1.1.0
.text: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!";1.0.0
.See also:
textFormat: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);1.0.0
.See also:
verticalAlign: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;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.
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.
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);1.0.0
.See also:
setPadding(value:Float):Void
Sets all four padding properties to the same value.
1.0.0
.See also:
setSkinForState(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.
1.0.0
.See also:
setTextFormatForState(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.
1.0.0
.See also: