Package | feathers.controls |
Class | public class TextInput |
Inheritance | TextInput ![]() ![]() |
Implements | IFocusDisplayObject, ITextBaselineControl, INativeFocusOwner |
Subclasses | AutoComplete |
To set things like font properties, the ability to display as
password, and character restrictions, use the textEditorProperties
to pass
values to the ITextEditor
instance.
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
Property | Defined 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 | ||
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 | ||
baseline : Number [read-only]
The baseline measurement of the text, in pixels. | TextInput | ||
defaultIcon : DisplayObject
The icon used when no other icon is defined for the current state. | TextInput | ||
![]() | defaultTextEditorFactory : Function [static]
A function used by all UI controls that support text editor to
create an ITextEditor instance. | FeathersControl | |
![]() | defaultTextRendererFactory : Function [static]
A function used by all UI controls that support text renderers to
create an ITextRenderer instance. | FeathersControl | |
![]() | depth : int [read-only]
The component's depth in the display list, relative to the stage. | FeathersControl | |
disabledIcon : DisplayObject
The icon used for the input's disabled state. | TextInput | ||
displayAsPassword : Boolean
Determines if the entered text will be masked so that it cannot be
seen, such as for a password input. | TextInput | ||
enabledIcon : DisplayObject
The icon used for the input's enabled state. | TextInput | ||
focusedIcon : DisplayObject
The icon used for the input's focused state. | TextInput | ||
![]() | focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be
displayed above the component when showFocus() is
called. | FeathersControl | |
![]() | focusManager : IFocusManager | FeathersControl | |
![]() | focusOwner : IFocusDisplayObject | FeathersControl | |
![]() | focusPadding : Number
Quickly sets all focus padding properties to the same value. | FeathersControl | |
![]() | focusPaddingBottom : Number
The minimum space, in pixels, between the object's bottom edge and the
bottom edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingLeft : Number
The minimum space, in pixels, between the object's left edge and the
left edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingRight : Number
The minimum space, in pixels, between the object's right edge and the
right edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingTop : Number
The minimum space, in pixels, between the object's top edge and the
top edge of the focus indicator skin. | FeathersControl | |
gap : Number
The space, in pixels, between the icon and the text editor, if an
icon exists. | TextInput | ||
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 | ||
![]() | height : Number [override]
The height of the component, in pixels. | FeathersControl | |
![]() | includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
![]() | isCreated : 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 | ||
![]() | isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
![]() | isFocusEnabled : Boolean | FeathersControl | |
![]() | isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
![]() | isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
![]() | layoutData : 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 | ||
![]() | maxHeight : Number
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | maxWidth : Number
The maximum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | minHeight : Number
The minimum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | minTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's
height is smaller than this value, it will be expanded. | FeathersControl | |
![]() | minTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's
width is smaller than this value, it will be expanded. | FeathersControl | |
![]() | minWidth : Number
The minimum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
nativeFocus : InteractiveObject [read-only]
A text editor may be an INativeFocusOwner, so we need to
return the value of its nativeFocus property. | TextInput | ||
![]() | nextTabFocus : IFocusDisplayObject | FeathersControl | |
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 | ||
![]() | previousTabFocus : IFocusDisplayObject | 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
Returns an icon for the current state. | TextInput | ||
stateToSkinFunction : Function
Returns a skin for the current state. | TextInput | ||
![]() | styleName : String
The concatenated styleNameList, with values separated
by spaces. | FeathersControl | |
![]() | styleNameList : TokenList [read-only]
Contains a list of all "styles" assigned to this control. | FeathersControl | |
![]() | styleProvider : 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 | ||
typicalText : String
The text used to measure the input when the dimensions are not set
explicitly (in addition to using the background skin for measurement). | TextInput | ||
verticalAlign : String
The location where the text editor is aligned vertically (on
the y-axis). | TextInput | ||
![]() | width : Number [override]
The width of the component, in pixels. | FeathersControl |
Property | Defined By | ||
---|---|---|---|
![]() | actualHeight : Number = 0
The final height value that should be used for layout. | FeathersControl | |
![]() | actualWidth : Number = 0
The final width value that should be used for layout. | FeathersControl | |
currentBackground : DisplayObject
The currently selected background, based on state. | TextInput | ||
currentIcon : DisplayObject
The currently visible icon. | TextInput | ||
currentState : String
The current state of the input. | TextInput | ||
![]() | defaultStyleProvider : IStyleProvider [read-only]
When the FeathersControl constructor is called, the
globalStyleProvider property is set to this value. | FeathersControl | |
![]() | explicitHeight : Number = NaN
The height value explicitly set by calling the height setter or
setSize(). | FeathersControl | |
![]() | explicitWidth : Number = NaN
The width value explicitly set by calling the width setter or
setSize(). | FeathersControl | |
promptTextRenderer : ITextRenderer
The prompt text renderer sub-component. | TextInput | ||
stateNames : Vector.<String> [read-only]
A list of all valid state names for use with currentState. | TextInput | ||
textEditor : ITextEditor
The text editor sub-component. | TextInput |
Method | Defined By | ||
---|---|---|---|
Constructor. | TextInput | ||
clearFocus():void
Manually removes focus from the text input control. | TextInput | ||
![]() | hideFocus():void
If the visual indicator of focus has been displayed by
showFocus(), call this function to hide it. | FeathersControl | |
![]() | invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending. | FeathersControl | |
![]() | isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not. | FeathersControl | |
![]() | move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single
function call. | 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. | TextInput | ||
![]() | setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single
function call. | FeathersControl | |
showFocus():void [override]
If the object has focus, an additional visual indicator may
optionally be displayed to highlight the object. | TextInput | ||
![]() | validate():void
Immediately validates the display object, if it is invalid. | FeathersControl |
Method | Defined By | ||
---|---|---|---|
autoSizeIfNeeded():Boolean
If the component's dimensions have not been set explicitly, it will
measure its content and determine an ideal size for itself. | TextInput | ||
![]() | clearInvalidationFlag(flag:String):void
Clears an invalidation flag. | FeathersControl | |
createTextEditor():void
Creates and adds the textEditor sub-component and
removes the old instance, if one exists. | TextInput | ||
![]() | draw():void
Override to customize layout and to adjust properties of children. | FeathersControl | |
![]() | 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 | |
![]() | 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 | |
![]() | 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 | |
layoutChildren():void
Positions and sizes the text input's children. | TextInput | ||
refreshBackgroundSkin():void
Sets the currentBackground property. | TextInput | ||
![]() | refreshFocusIndicator():void
Updates the focus indicator skin by showing or hiding it and
adjusting its position and dimensions. | FeathersControl | |
refreshIcon():void
Sets the currentIcon property. | TextInput | ||
![]() | setInvalidationFlag(flag:String):void
Sets an invalidation flag. | FeathersControl | |
![]() | setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of
invalidating or not. | FeathersControl |
Event | Summary | Defined By | ||
---|---|---|---|---|
Dispatched when the text input's text property changes. | TextInput | |||
![]() | Dispatched 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 | |||
![]() | Dispatched after initialize() has been called, but before the first time that draw() has been called. | FeathersControl | ||
![]() | Dispatched 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 deactivated by the text editor. | TextInput |
Constant | Defined By | ||
---|---|---|---|
ALTERNATE_NAME_SEARCH_TEXT_INPUT : String = feathers-search-text-input [static]
DEPRECATED: Replaced by TextInput.ALTERNATE_STYLE_NAME_SEARCH_TEXT_INPUT. | TextInput | ||
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 | ||
![]() | INVALIDATION_FLAG_ALL : String = all [static]
Flag to indicate that everything is invalid and should be redrawn. | FeathersControl | |
![]() | INVALIDATION_FLAG_DATA : String = data [static]
Invalidation flag to indicate that the primary data displayed by the
UI control has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_FOCUS : String = focus [static]
Invalidation flag to indicate that the focus of the UI control has
changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_LAYOUT : String = layout [static]
Invalidation flag to indicate that the layout of the UI control has
changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_SCROLL : String = scroll [static]
Invalidation flag to indicate that the scroll position of the UI
control has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_SELECTED : String = selected [static]
Invalidation flag to indicate that the selection of the UI control
has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_SIZE : String = size [static]
Invalidation flag to indicate that the dimensions of the UI control
have changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_SKIN : String = skin [static]
Invalidation flag to indicate that the skin of the UI control has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_STATE : String = state [static]
Invalidation flag to indicate that the state has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_STYLES : String = styles [static]
Invalidation flag to indicate that the styles or visual appearance of
the UI control has changed. | FeathersControl | |
STATE_DISABLED : String = disabled [static]
The TextInput is disabled. | TextInput | ||
STATE_ENABLED : String = enabled [static]
The TextInput is enabled and does not have focus. | TextInput | ||
STATE_FOCUSED : String = focused [static]
The TextInput is enabled and has focus. | TextInput | ||
VERTICAL_ALIGN_BOTTOM : String = bottom [static]
The text editor, icon, and prompt will be aligned vertically to the
bottom edge of the text input. | TextInput | ||
VERTICAL_ALIGN_JUSTIFY : String = justify [static]
The text editor will fill the full height of the text input (minus
top and bottom padding). | TextInput | ||
VERTICAL_ALIGN_MIDDLE : String = middle [static]
The text editor, icon, and prompt will be aligned vertically to the
middle of the text input. | TextInput | ||
VERTICAL_ALIGN_TOP : String = top [static]
The text editor, icon, and prompt will be aligned vertically to the
top edge of the text input. | TextInput |
backgroundDisabledSkin | property |
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 );
The default value is null
.
public function get backgroundDisabledSkin():DisplayObject
public function set backgroundDisabledSkin(value:DisplayObject):void
backgroundEnabledSkin | property |
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 );
The default value is null
.
public function get backgroundEnabledSkin():DisplayObject
public function set backgroundEnabledSkin(value:DisplayObject):void
See also
backgroundFocusedSkin | property |
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 );
The default value is null
.
public function get backgroundFocusedSkin():DisplayObject
public function set backgroundFocusedSkin(value:DisplayObject):void
backgroundSkin | property |
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
.
public function get backgroundSkin():DisplayObject
public function set backgroundSkin(value:DisplayObject):void
See also
baseline | property |
baseline:Number
[read-only] The baseline measurement of the text, in pixels.
public function get baseline():Number
currentBackground | property |
protected var currentBackground:DisplayObject
The currently selected background, based on state.
For internal use in subclasses.
currentIcon | property |
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.
currentState | property |
currentState:String
The current state of the input.
For internal use in subclasses.
protected function get currentState():String
protected function set currentState(value:String):void
defaultIcon | property |
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
.
public function get defaultIcon():DisplayObject
public function set defaultIcon(value:DisplayObject):void
See also
disabledIcon | property |
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 );
The default value is null
.
public function get disabledIcon():DisplayObject
public function set disabledIcon(value:DisplayObject):void
See also
displayAsPassword | property |
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
.
public function get displayAsPassword():Boolean
public function set displayAsPassword(value:Boolean):void
enabledIcon | property |
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 );
The default value is null
.
public function get enabledIcon():DisplayObject
public function set enabledIcon(value:DisplayObject):void
See also
focusedIcon | property |
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 );
The default value is null
.
public function get focusedIcon():DisplayObject
public function set focusedIcon(value:DisplayObject):void
See also
gap | property |
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
.
public function get gap():Number
public function set gap(value:Number):void
globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider
for all TextInput
components.
The default value is null
.
See also
hasFocus | property |
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.
public function get hasFocus():Boolean
isEditable | property |
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
.
public function get isEditable():Boolean
public function set isEditable(value:Boolean):void
maxChars | property |
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
.
public function get maxChars():int
public function set maxChars(value:int):void
nativeFocus | property |
nativeFocus:InteractiveObject
[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
.
public function get nativeFocus():InteractiveObject
See also
padding | property |
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
.
public function get padding():Number
public function set padding(value:Number):void
See also
paddingBottom | property |
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
.
public function get paddingBottom():Number
public function set paddingBottom(value:Number):void
paddingLeft | property |
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
.
public function get paddingLeft():Number
public function set paddingLeft(value:Number):void
paddingRight | property |
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
.
public function get paddingRight():Number
public function set paddingRight(value:Number):void
paddingTop | property |
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
.
public function get paddingTop():Number
public function set paddingTop(value:Number):void
prompt | property |
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
.
public function get prompt():String
public function set prompt(value:String):void
promptFactory | property |
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
.
public function get promptFactory():Function
public function set promptFactory(value:Function):void
See also
promptProperties | property |
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
.
public function get promptProperties():Object
public function set promptProperties(value:Object):void
See also
promptTextRenderer | property |
protected var promptTextRenderer:ITextRenderer
The prompt text renderer sub-component.
For internal use in subclasses.
restrict | property |
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
.
public function get restrict():String
public function set restrict(value:String):void
selectionBeginIndex | property |
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.
public function get selectionBeginIndex():int
selectionEndIndex | property |
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.
public function get selectionEndIndex():int
stateNames | property |
stateNames:Vector.<String>
[read-only]
A list of all valid state names for use with currentState
.
For internal use in subclasses.
protected function get stateNames():Vector.<String>
See also
stateToIconFunction | property |
stateToIconFunction:Function
Returns an icon for the current state.
The following function signature is expected:
function( target:TextInput, state:Object, oldIcon:DisplayObject = null ):DisplayObject
The default value is null
.
public function get stateToIconFunction():Function
public function set stateToIconFunction(value:Function):void
stateToSkinFunction | property |
stateToSkinFunction:Function
Returns a skin for the current state.
The following function signature is expected:
function( target:TextInput, state:Object, oldSkin:DisplayObject = null ):DisplayObject
The default value is null
.
public function get stateToSkinFunction():Function
public function set stateToSkinFunction(value:Function):void
text | property |
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 ""
.
public function get text():String
public function set text(value:String):void
See also
textEditor | property |
textEditorFactory | property |
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
.
public function get textEditorFactory():Function
public function set textEditorFactory(value:Function):void
See also
textEditorProperties | property |
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
.
public function get textEditorProperties():Object
public function set textEditorProperties(value:Object):void
See also
typicalText | property |
typicalText:String
The text used to measure the input when the dimensions are not set explicitly (in addition to using the background skin for measurement).
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
.
public function get typicalText():String
public function set typicalText(value:String):void
verticalAlign | property |
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 = TextInput.VERTICAL_ALIGN_TOP;
The default value is TextInput.VERTICAL_ALIGN_MIDDLE
.
public function get verticalAlign():String
public function set verticalAlign(value:String):void
See also
TextInput | () | Constructor |
public function TextInput()
Constructor.
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 setSizeInternal()
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.
ReturnsBoolean |
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
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.
showFocus | () | method |
override public function showFocus():void
If the object has focus, an additional visual indicator may optionally be displayed to highlight the object. Calling this function may have no effect. It's merely a suggestion to the object.
Important: This function will not give focus to
the display object if it doesn't have focus. To give focus to the
display object, you should set the focus
property on
the focus manager.
object.focusManager.focus = object;
change | Event |
starling.events.Event
starling.events.Event.CHANGE
Dispatched when the text input's text
property changes.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The 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 . |
data | null |
target | The 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. |
enter | Event |
starling.events.Event
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:
Property | Value |
---|---|
bubbles | false |
currentTarget | The 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 . |
data | null |
target | The 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. |
FeathersEventType.ENTER
event type is meant to
be used when the enter key has been pressed in an input control.
focusIn | Event |
starling.events.Event
feathers.events.FeathersEventType.FOCUS_IN
Dispatched when the text input receives focus.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The 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 . |
data | null |
target | The 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. |
FeathersEventType.FOCUS_IN
event type is used by
Feathers components to indicate when they have received focus.
focusOut | Event |
starling.events.Event
feathers.events.FeathersEventType.FOCUS_OUT
Dispatched when the text input loses focus.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The 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 . |
data | null |
target | The 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. |
FeathersEventType.FOCUS_OUT
event type is used by
Feathers components to indicate when they have lost focus.
softKeyboardActivate | Event |
starling.events.Event
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:
Property | Value |
---|---|
bubbles | false |
currentTarget | The 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 . |
data | null |
target | The 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. |
FeathersEventType.SOFT_KEYBOARD_ACTIVATE
event type
is used by Feathers text editors when they activate a device's soft
keyboard.
softKeyboardDeactivate | Event |
starling.events.Event
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:
Property | Value |
---|---|
bubbles | false |
currentTarget | The 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 . |
data | null |
target | The 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. |
FeathersEventType.SOFT_KEYBOARD_DEACTIVATE
event type
is used by Feathers text editors when they deactivate a device's soft
keyboard.
ALTERNATE_NAME_SEARCH_TEXT_INPUT | Constant |
public static const ALTERNATE_NAME_SEARCH_TEXT_INPUT:String = feathers-search-text-input
DEPRECATED: Replaced by TextInput.ALTERNATE_STYLE_NAME_SEARCH_TEXT_INPUT
.
DEPRECATION WARNING: This property is deprecated starting with Feathers 2.1. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.
See also
ALTERNATE_STYLE_NAME_SEARCH_TEXT_INPUT | Constant |
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
STATE_DISABLED | Constant |
public static const STATE_DISABLED:String = disabled
The TextInput
is disabled.
STATE_ENABLED | Constant |
public static const STATE_ENABLED:String = enabled
The TextInput
is enabled and does not have focus.
STATE_FOCUSED | Constant |
public static const STATE_FOCUSED:String = focused
The TextInput
is enabled and has focus.
VERTICAL_ALIGN_BOTTOM | Constant |
public static const VERTICAL_ALIGN_BOTTOM:String = bottom
The text editor, icon, and prompt will be aligned vertically to the bottom edge of the text input.
See also
VERTICAL_ALIGN_JUSTIFY | Constant |
public static const VERTICAL_ALIGN_JUSTIFY:String = justify
The text editor will fill the full height of the text input (minus top and bottom padding).
See also
VERTICAL_ALIGN_MIDDLE | Constant |
public static const VERTICAL_ALIGN_MIDDLE:String = middle
The text editor, icon, and prompt will be aligned vertically to the middle of the text input.
See also
VERTICAL_ALIGN_TOP | Constant |
public static const VERTICAL_ALIGN_TOP:String = top
The text editor, icon, and prompt will be aligned vertically to the top edge of the text input.
See also