Packagefeathers.controls.text
Classpublic class StageTextTextEditor
InheritanceStageTextTextEditor Inheritance FeathersControl Inheritance Sprite Inheritance DisplayObjectContainer Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Implements ITextEditor

A Feathers text editor that uses the native StageText class in AIR, and the custom StageTextField class (that simulates StageText) in Flash Player.

See also

http://wiki.starling-framework.org/feathers/text-editors
flash.text.StageText
feathers.text.StageTextField


Public Properties
 PropertyDefined By
 Inheritedalpha : Number
The opacity of the object.
DisplayObject
  autoCapitalize : String
Same as the StageText property with the same name.
StageTextTextEditor
  autoCorrect : Boolean
Same as the StageText property with the same name.
StageTextTextEditor
 Inheritedbase : DisplayObject
[read-only] The topmost object in the display tree the object is part of.
DisplayObject
 InheritedblendMode : String
The blend mode determines how the object is blended with the objects underneath.
DisplayObject
 Inheritedbounds : Rectangle
[read-only] The bounds of the object relative to the local coordinates of the parent.
DisplayObject
  color : uint
Same as the StageText property with the same name.
StageTextTextEditor
 InheriteddefaultTextEditorFactory : Function
[static] A function used by all UI controls that support text editor to create an ITextEditor instance.
FeathersControl
 InheriteddefaultTextRendererFactory : Function
[static] A function used by all UI controls that support text renderers to create an ITextRenderer instance.
FeathersControl
  displayAsPassword : Boolean
Same as the StageText property with the same name.
StageTextTextEditor
  editable : Boolean
Same as the StageText property with the same name.
StageTextTextEditor
 Inheritedfilter : FragmentFilter
The filter or filter group that is attached to the display object.
DisplayObject
  fontFamily : String
Same as the StageText property with the same name.
StageTextTextEditor
  fontPosture : String
Same as the StageText property with the same name.
StageTextTextEditor
  fontSize : int
Same as the StageText property with the same name.
StageTextTextEditor
  fontWeight : String
Same as the StageText property with the same name.
StageTextTextEditor
 InheritedhasVisibleArea : Boolean
[read-only] Indicates if an object occupies any visible area.
DisplayObject
 Inheritedheight : Number
[override] The height of the component, in pixels.
FeathersControl
 InheritedisEnabled : Boolean
Indicates whether the control is interactive or not.
FeathersControl
 InheritedisFlattened : Boolean
[read-only] Indicates if the sprite was flattened.
Sprite
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
FeathersControl
 InheritedisQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list.
FeathersControl
  locale : String
Same as the StageText property with the same name.
StageTextTextEditor
  maxChars : int
Same as the StageText property with the same name.
StageTextTextEditor
 InheritedmaxHeight : Number
The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmaxWidth : Number
The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminHeight : Number
The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded.
FeathersControl
 InheritedminTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded.
FeathersControl
 InheritedminWidth : Number
The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 Inheritedname : String
[override] The concatenated nameList, with each name separated by spaces.
FeathersControl
 InheritednameList : TokenList
[read-only] Contains a list of all "names" assigned to this control.
FeathersControl
 InheritednumChildren : int
[read-only] The number of children of this container.
DisplayObjectContainer
 Inheritedparent : DisplayObjectContainer
[read-only] The display object container that contains this display object.
DisplayObject
 InheritedpivotX : Number
The x coordinate of the object's origin in its own coordinate space (default: 0).
DisplayObject
 InheritedpivotY : Number
The y coordinate of the object's origin in its own coordinate space (default: 0).
DisplayObject
  restrict : String
Same as the StageText property with the same name.
StageTextTextEditor
  returnKeyLabel : String
Same as the StageText property with the same name.
StageTextTextEditor
 Inheritedroot : DisplayObject
[read-only] The root object the display object is connected to (i.e.
DisplayObject
 Inheritedrotation : Number
The rotation of the object in radians.
DisplayObject
 InheritedscaleX : Number
The horizontal scale factor.
DisplayObject
 InheritedscaleY : Number
The vertical scale factor.
DisplayObject
 InheritedskewX : Number
The horizontal skew angle in radians.
DisplayObject
 InheritedskewY : Number
The vertical skew angle in radians.
DisplayObject
  softKeyboardType : String
Same as the StageText property with the same name.
StageTextTextEditor
 Inheritedstage : 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 input.
StageTextTextEditor
  textAlign : String
Same as the StageText property with the same name.
StageTextTextEditor
 Inheritedtouchable : Boolean
Indicates if this object (and its children) will receive touch events.
DisplayObject
 InheritedtransformationMatrix : Matrix
The transformation matrix of the object relative to its parent.
DisplayObject
 InheriteduseHandCursor : Boolean
Indicates if the mouse cursor should transform into a hand while it's over the sprite.
DisplayObject
 Inheritedvisible : Boolean
The visibility of the object.
DisplayObject
 Inheritedwidth : Number
[override] The width of the component, in pixels.
FeathersControl
 Inheritedx : Number
The x coordinate of the object relative to the local coordinates of the parent.
DisplayObject
 Inheritedy : Number
The y coordinate of the object relative to the local coordinates of the parent.
DisplayObject
Protected Properties
 PropertyDefined By
 InheritedactualHeight : Number = 0
The final height value that should be used for layout.
FeathersControl
 InheritedactualWidth : Number = 0
The final width value that should be used for layout.
FeathersControl
 InheritedexplicitHeight : Number = NaN
The height value explicitly set by calling the height setter or setSize().
FeathersControl
 InheritedexplicitWidth : Number = NaN
The width value explicitly set by calling the width setter or setSize().
FeathersControl
  stageText : Object
The StageText instance.
StageTextTextEditor
  textSnapshot : Image
An image that displays a snapshot of the native StageText in the Starling display list when the editor doesn't have focus.
StageTextTextEditor
Public Methods
 MethodDefined By
  
Constructor.
StageTextTextEditor
 Inherited
Adds a child to the container.
DisplayObjectContainer
 Inherited
Adds a child to the container at a certain index.
DisplayObjectContainer
 Inherited
addEventListener(type:String, listener:Function):void
Registers an event listener at a certain object.
EventDispatcher
 Inherited
broadcastEvent(event:Event):void
Dispatches an event on all children (recursively).
DisplayObjectContainer
 Inherited
broadcastEventWith(type:String, data:Object = null):void
Dispatches an event with the given parameters on all children (recursively).
DisplayObjectContainer
 Inherited
contains(child:DisplayObject):Boolean
Determines if a certain object is a child of the container (recursively).
DisplayObjectContainer
 Inherited
dispatchEvent(event:Event):void
Dispatches an event to all objects that have registered listeners for its type.
EventDispatcher
 Inherited
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
 Inherited
dispose():void
[override] Disposes the resources of all children.
Sprite
 Inherited
flatten():void
Optimizes the sprite for optimal rendering performance.
Sprite
 Inherited
getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle
[override] Returns a rectangle that completely encloses the object as it appears in another coordinate system.
DisplayObjectContainer
 Inherited
Returns a child object at a certain index.
DisplayObjectContainer
 Inherited
Returns a child object with a certain name (non-recursively).
DisplayObjectContainer
 Inherited
Returns the index of a child within the container, or "-1" if it is not found.
DisplayObjectContainer
 Inherited
getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix
Creates a matrix that represents the transformation from the local coordinate system to another.
DisplayObject
 Inherited
globalToLocal(globalPoint:Point, resultPoint:Point = null):Point
Transforms a point from global (stage) coordinates to the local coordinate system.
DisplayObject
 Inherited
hasEventListener(type:String):Boolean
Returns if there are listeners registered for a certain event type.
EventDispatcher
 Inherited
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.
DisplayObjectContainer
 Inherited
invalidate(flag:String):void
When called, the UI control will redraw within one frame.
FeathersControl
 Inherited
isInvalid(flag:String = null):Boolean
Indicates whether the control is invalid or not.
FeathersControl
 Inherited
localToGlobal(localPoint:Point, resultPoint:Point = null):Point
Transforms a point from the local coordinate system to global (stage) coordinates.
DisplayObject
 Inherited
removeChild(child:DisplayObject, dispose:Boolean = false):DisplayObject
Removes a child from the container.
DisplayObjectContainer
 Inherited
removeChildAt(index:int, dispose:Boolean = false):DisplayObject
Removes a child at a certain index.
DisplayObjectContainer
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void
Removes a range of children from the container (endIndex included).
DisplayObjectContainer
 Inherited
removeEventListener(type:String, listener:Function):void
Removes an event listener from the object.
EventDispatcher
 Inherited
removeEventListeners(type:String = null):void
Removes all event listeners with a certain type, or all of them if type is null.
EventDispatcher
 Inherited
removeFromParent(dispose:Boolean = false):void
Removes the object from its parent, if it has one.
DisplayObject
 Inherited
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.
StageTextTextEditor
 Inherited
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.
StageTextTextEditor
 Inherited
setSize(width:Number, height:Number):void
Sets both the width and the height of the control.
FeathersControl
 Inherited
sortChildren(compareFunction:Function):void
Sorts the children according to a given function (that works just like the sort function of the Vector class).
DisplayObjectContainer
 Inherited
Swaps the indexes of two children.
DisplayObjectContainer
 Inherited
swapChildrenAt(index1:int, index2:int):void
Swaps the indexes of two children.
DisplayObjectContainer
 Inherited
unflatten():void
Removes the rendering optimizations that were created when flattening the sprite.
Sprite
 Inherited
validate():void
Immediately validates the control, which triggers a redraw, if one is pending.
FeathersControl
Protected Methods
 MethodDefined By
 Inherited
draw():void
Override to customize layout and to adjust properties of children.
FeathersControl
 Inherited
initialize():void
Override to initialize the UI control.
FeathersControl
 Inherited
setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of invalidating or not.
FeathersControl
Events
 Event Summary Defined By
 InheritedDispatched when an object is added to a parent.DisplayObject
 InheritedDispatched when an object is connected to the stage (directly or indirectly).DisplayObject
  Dispatched when the text property changes.StageTextTextEditor
  Dispatched when the user presses the Enter key while the editor has focus.StageTextTextEditor
 InheritedDispatched once every frame on every object that is connected to the stage.DisplayObject
 InheritedDispatched on all children when the object is flattened.Sprite
  Dispatched when the text editor receives focus.StageTextTextEditor
  Dispatched when the text editor loses focus.StageTextTextEditor
 InheritedDispatched after initialize() has been called, but before the first time that draw() has been called.FeathersControl
 InheritedDispatched when an object is removed from its parent.DisplayObject
 InheritedDispatched when an object is removed from the stage and won't be rendered any longer.DisplayObject
 InheritedDispatched when the width or height of the control changes.FeathersControl
 InheritedDispatched when an object is touched.DisplayObject
Public Constants
 ConstantDefined By
 InheritedINVALIDATION_FLAG_ALL : String = all
[static] Flag to indicate that everything is invalid and should be redrawn.
FeathersControl
 InheritedINVALIDATION_FLAG_DATA : String = data
[static] Invalidation flag to indicate that the primary data displayed by the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_LAYOUT : String = layout
[static] Invalidation flag to indicate that the layout of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SCROLL : String = scroll
[static] Invalidation flag to indicate that the scroll position of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SELECTED : String = selected
[static] Invalidation flag to indicate that the selection of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SIZE : String = size
[static] Invalidation flag to indicate that the dimensions of the UI control have changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SKIN : String = skin
[static] Invalidation flag to indicate that the skin of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STATE : String = state
[static] Invalidation flag to indicate that the state has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STYLES : String = styles
[static] Invalidation flag to indicate that the styles or visual appearance of the UI control has changed.
FeathersControl
Property Detail
autoCapitalizeproperty
autoCapitalize:String

Same as the StageText property with the same name.


Implementation
    public function get autoCapitalize():String
    public function set autoCapitalize(value:String):void
autoCorrectproperty 
autoCorrect:Boolean

Same as the StageText property with the same name.


Implementation
    public function get autoCorrect():Boolean
    public function set autoCorrect(value:Boolean):void
colorproperty 
color:uint

Same as the StageText property with the same name.


Implementation
    public function get color():uint
    public function set color(value:uint):void
displayAsPasswordproperty 
displayAsPassword:Boolean

Same as the StageText property with the same name.


Implementation
    public function get displayAsPassword():Boolean
    public function set displayAsPassword(value:Boolean):void
editableproperty 
editable:Boolean

Same as the StageText property with the same name.


Implementation
    public function get editable():Boolean
    public function set editable(value:Boolean):void
fontFamilyproperty 
fontFamily:String

Same as the StageText property with the same name.


Implementation
    public function get fontFamily():String
    public function set fontFamily(value:String):void
fontPostureproperty 
fontPosture:String

Same as the StageText property with the same name.


Implementation
    public function get fontPosture():String
    public function set fontPosture(value:String):void
fontSizeproperty 
fontSize:int

Same as the StageText property with the same name.


Implementation
    public function get fontSize():int
    public function set fontSize(value:int):void
fontWeightproperty 
fontWeight:String

Same as the StageText property with the same name.


Implementation
    public function get fontWeight():String
    public function set fontWeight(value:String):void
localeproperty 
locale:String

Same as the StageText property with the same name.


Implementation
    public function get locale():String
    public function set locale(value:String):void
maxCharsproperty 
maxChars:int

Same as the StageText property with the same name.


Implementation
    public function get maxChars():int
    public function set maxChars(value:int):void
restrictproperty 
restrict:String

Same as the StageText property with the same name.


Implementation
    public function get restrict():String
    public function set restrict(value:String):void
returnKeyLabelproperty 
returnKeyLabel:String

Same as the StageText property with the same name.


Implementation
    public function get returnKeyLabel():String
    public function set returnKeyLabel(value:String):void
softKeyboardTypeproperty 
softKeyboardType:String

Same as the StageText property with the same name.


Implementation
    public function get softKeyboardType():String
    public function set softKeyboardType(value:String):void
stageTextproperty 
protected var stageText:Object

The StageText instance. It's typed Object so that a replacement class can be used in browser-based Flash Player.

textproperty 
text:String

The text displayed by the input.


Implementation
    public function get text():String
    public function set text(value:String):void
textAlignproperty 
textAlign:String

Same as the StageText property with the same name.


Implementation
    public function get textAlign():String
    public function set textAlign(value:String):void
textSnapshotproperty 
protected var textSnapshot:Image

An image that displays a snapshot of the native StageText in the Starling display list when the editor doesn't have focus.

Constructor Detail
StageTextTextEditor()Constructor
public function StageTextTextEditor()

Constructor.

Method Detail
selectRange()method
public function selectRange(startIndex:int, endIndex:int):void

Sets 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):void

Gives 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)

Event Detail
change Event
Event Object Type: starling.events.Event

Dispatched when the text property changes.

enter Event  
Event Object Type: starling.events.Event
Event.type property = feathers.events.FeathersEventType.ENTER

Dispatched when the user presses the Enter key while the editor has focus.

The FeathersEventType.ENTER event type is meant to be used when the enter key has been pressed in an input control.
focusIn Event  
Event Object Type: starling.events.Event
Event.type property = feathers.events.FeathersEventType.FOCUS_IN

Dispatched when the text editor receives focus.

The FeathersEventType.FOCUS_IN event type is used by Feathers components to indicate when they have received focus.
focusOut Event  
Event Object Type: starling.events.Event
Event.type property = feathers.events.FeathersEventType.FOCUS_OUT

Dispatched when the text editor loses focus.

The FeathersEventType.FOCUS_OUT event type is used by Feathers components to indicate when they have lost focus.