| Package | feathers.controls.text |
| Class | public class TextFieldTextEditor |
| Inheritance | TextFieldTextEditor  FeathersControl Sprite DisplayObjectContainer DisplayObject EventDispatcher Object |
| Implements | ITextEditor |
TextField class
set to TextInputType.INPUT.
See also
| Property | Defined By | ||
|---|---|---|---|
 | alpha : Number The opacity of the object. | DisplayObject | |
| alwaysShowSelection : Boolean
Same as the flash.text.TextField property with the same name. | TextFieldTextEditor | ||
| base : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject | |
| blendMode : String The blend mode determines how the object is blended with the objects underneath. | DisplayObject | |
| bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject | |
| clipRect : Rectangle [override] | FeathersControl | |
| 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 | |
| displayAsPassword : Boolean
Same as the flash.text.TextField property with the same name. | TextFieldTextEditor | ||
| embedFonts : Boolean
Determines if the TextField should use an embedded font or not. | TextFieldTextEditor | ||
| filter : FragmentFilter The filter that is attached to the display object. | DisplayObject | |
| focusManager : IFocusManager
The current focus manager for this component. | FeathersControl | |
| hasVisibleArea : Boolean [read-only] Indicates if an object occupies any visible area. | DisplayObject | |
| 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 | |
| isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
| isFlattened : Boolean [read-only] Indicates if the sprite was flattened. | Sprite | |
| isFocusEnabled : Boolean
Determines if this component can receive focus. | FeathersControl | |
| isHTML : Boolean
Determines if the TextField should display the text as HTML or not. | TextFieldTextEditor | ||
| 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
Same as the flash.text.TextField property with the same name. | TextFieldTextEditor | ||
| 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 | |
| name : String [override]
The concatenated nameList, with each name separated by
spaces. | FeathersControl | |
| nameList : TokenList [read-only]
Contains a list of all "names" assigned to this control. | FeathersControl | |
| nextTabFocus : IFocusDisplayObject
The next object that will receive focus when the tab key is pressed. | FeathersControl | |
| numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer | |
| parent : DisplayObjectContainer [read-only] The display object container that contains this display object. | DisplayObject | |
| pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| restrict : String
Same as the flash.text.TextField property with the same name. | TextFieldTextEditor | ||
| root : DisplayObject [read-only] The root object the display object is connected to (i.e. | DisplayObject | |
| rotation : Number The rotation of the object in radians. | DisplayObject | |
| scaleX : Number The horizontal scale factor. | DisplayObject | |
| scaleY : Number The vertical scale factor. | DisplayObject | |
| skewX : Number The horizontal skew angle in radians. | DisplayObject | |
| skewY : Number The vertical skew angle in radians. | DisplayObject | |
| stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected
to the stage. | DisplayObject | |
| text : String
The text displayed by the editor. | TextFieldTextEditor | ||
| textFormat : TextFormat
The format of the text, such as font and styles. | TextFieldTextEditor | ||
| touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject | |
| transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject | |
| useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite. | DisplayObject | |
| visible : Boolean The visibility of the object. | DisplayObject | |
| width : Number [override]
The width of the component, in pixels. | FeathersControl | |
| wordWrap : Boolean
Determines if the TextField wraps text to the next line. | TextFieldTextEditor | ||
| x : Number The x coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| y : Number The y coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| 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 | |
| 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 | |
| textField : TextField
The text field sub-component. | TextFieldTextEditor | ||
| textSnapshot : Image
An image that displays a snapshot of the native TextField
in the Starling display list when the editor doesn't have focus. | TextFieldTextEditor | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | TextFieldTextEditor | ||
| Adds a child to the container. | DisplayObjectContainer | |
| Adds a child to the container at a certain index. | DisplayObjectContainer | |
| addEventListener(type:String, listener:Function):void [override] | DisplayObject | |
| alignPivot(hAlign:String = center, vAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system
of the object. | DisplayObject | |
| broadcastEvent(event:Event):void Dispatches an event on all children (recursively). | DisplayObjectContainer | |
| broadcastEventWith(type:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively). | DisplayObjectContainer | |
clearFocus():void
Removes focus from the text editor. | TextFieldTextEditor | ||
| contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively). | DisplayObjectContainer | |
| dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher | |
| dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered
listeners for the given type. | EventDispatcher | |
| dispose():void [override] Disposes the resources of all children. | Sprite | |
| flatten():void Optimizes the sprite for optimal rendering performance. | Sprite | |
| getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Returns a rectangle that completely encloses the object as it appears in another
coordinate system. | Sprite | |
| getChildAt(index:int):DisplayObject Returns a child object at a certain index. | DisplayObjectContainer | |
| getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively). | DisplayObjectContainer | |
| getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found. | DisplayObjectContainer | |
| getClipRect(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle Returns the bounds of the container's clipRect in the given coordinate space, or
null if the sprite doens't have a clipRect. | Sprite | |
| getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
| globalToLocal(globalPoint:Point, resultPoint:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
| hasEventListener(type:String):Boolean Returns if there are listeners registered for a certain event type. | EventDispatcher | |
| hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil if
the test fails. | Sprite | |
| 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 | |
| localToGlobal(localPoint:Point, resultPoint:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
| Removes a child from the container. | DisplayObjectContainer | |
| removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index. | DisplayObjectContainer | |
| removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included). | DisplayObjectContainer | |
| removeEventListener(type:String, listener:Function):void [override] | DisplayObject | |
| removeEventListeners(type:String = null):void [override] | DisplayObject | |
| removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject | |
| render(support:RenderSupport, parentAlpha:Number):void [override] Renders the display object with the help of a support object. | Sprite | |
selectRange(startIndex:int, endIndex:int):void
Sets the range of selected characters. | TextFieldTextEditor | ||
| setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer | |
setFocus(position:Point = null):void
Gives focus to the text editor. | TextFieldTextEditor | ||
| setSize(width:Number, height:Number):void
Sets both the width and the height of the control. | FeathersControl | |
| sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function
of the Vector class). | DisplayObjectContainer | |
| Swaps the indexes of two children. | DisplayObjectContainer | |
| swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer | |
| unflatten():void Removes the rendering optimizations that were created when flattening the sprite. | Sprite | |
| validate():void
Immediately validates the control, which triggers a redraw, if one
is pending. | FeathersControl | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when an object is added to a parent. | DisplayObject | ||
| Dispatched when an object is connected to the stage (directly or indirectly). | DisplayObject | ||
| Dispatched when the text property changes. | TextFieldTextEditor | |||
| Dispatched when the user presses the Enter key while the editor has focus. | TextFieldTextEditor | |||
| Dispatched once every frame on every object that is connected to the stage. | DisplayObject | ||
| Dispatched on all children when the object is flattened. | Sprite | ||
| Dispatched when the text editor receives focus. | TextFieldTextEditor | |||
| Dispatched when the text editor loses focus. | TextFieldTextEditor | |||
| Dispatched after initialize() has been called, but before the first time that draw() has been called. | FeathersControl | ||
| Dispatched when a key on the keyboard is pressed. | DisplayObject | ||
| Dispatched when a key on the keyboard is released. | DisplayObject | ||
| Dispatched when an object is removed from its parent. | DisplayObject | ||
| Dispatched when an object is removed from the stage and won't be rendered any longer. | DisplayObject | ||
| Dispatched when the width or height of the control changes. | FeathersControl | ||
| Dispatched when an object is touched. | DisplayObject | ||
| alwaysShowSelection | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesalwaysShowSelection:Boolean
Same as the flash.text.TextField property with the same name.
public function get alwaysShowSelection():Boolean public function set alwaysShowSelection(value:Boolean):void| displayAsPassword | property |
displayAsPassword:Boolean
Same as the flash.text.TextField property with the same name.
public function get displayAsPassword():Boolean public function set displayAsPassword(value:Boolean):void| embedFonts | property |
embedFonts:BooleanDetermines if the TextField should use an embedded font or not.
public function get embedFonts():Boolean public function set embedFonts(value:Boolean):void| isHTML | property |
isHTML:BooleanDetermines if the TextField should display the text as HTML or not.
public function get isHTML():Boolean public function set isHTML(value:Boolean):void| maxChars | property |
maxChars:int
Same as the flash.text.TextField property with the same name.
public function get maxChars():int public function set maxChars(value:int):void| restrict | property |
restrict:String
Same as the flash.text.TextField property with the same name.
public function get restrict():String public function set restrict(value:String):void| text | property |
text:StringThe text displayed by the editor.
public function get text():String public function set text(value:String):void| textField | property |
protected var textField:TextFieldThe text field sub-component.
| textFormat | property |
textFormat:TextFormatThe format of the text, such as font and styles.
public function get textFormat():TextFormat public function set textFormat(value:TextFormat):void| textSnapshot | property |
protected var textSnapshot:Image
An image that displays a snapshot of the native TextField
in the Starling display list when the editor doesn't have focus.
| wordWrap | property |
wordWrap:BooleanDetermines if the TextField wraps text to the next line.
public function get wordWrap():Boolean public function set wordWrap(value:Boolean):void| TextFieldTextEditor | () | Constructor |
public function TextFieldTextEditor()Constructor.
| clearFocus | () | method |
public function clearFocus():voidRemoves focus from the text editor.
| selectRange | () | method |
public function selectRange(startIndex:int, endIndex:int):voidSets the range of selected characters. If both values are the same, the text insertion position is changed and nothing is selected.
Parameters
startIndex:int | |
endIndex:int |
| setFocus | () | method |
public function setFocus(position:Point = null):voidGives focus to the text editor. Includes an optional position which may be used by the text editor to determine the cursor position. The position may be outside of the editors bounds.
Parameters
position:Point (default = null) |
| change | Event |
| enter | Event |
starling.events.Eventfeathers.events.FeathersEventType.ENTERDispatched when the user presses the Enter key while the editor has focus.
TheFeathersEventType.ENTER event type is meant to
be used when the enter key has been pressed in an input control.
| focusIn | Event |
starling.events.Eventfeathers.events.FeathersEventType.FOCUS_INDispatched when the text editor receives focus.
TheFeathersEventType.FOCUS_IN event type is used by
Feathers components to indicate when they have received focus.
| focusOut | Event |
starling.events.Eventfeathers.events.FeathersEventType.FOCUS_OUTDispatched when the text editor loses focus.
TheFeathersEventType.FOCUS_OUT event type is used by
Feathers components to indicate when they have lost focus.