Package | feathers.controls.text |
Class | public class StageTextTextEditor |
Inheritance | StageTextTextEditor ![]() ![]() ![]() ![]() ![]() ![]() |
Implements | ITextEditor |
StageText
class
in AIR, and the custom StageTextField
class (that simulates
StageText
) in Flash Player.
See also
Property | Defined By | ||
---|---|---|---|
![]() | alpha : 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 | ||
![]() | 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 | |
color : uint
Same as the StageText property with the same name. | StageTextTextEditor | ||
![]() | 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 StageText property with the same name. | StageTextTextEditor | ||
editable : Boolean
Same as the StageText property with the same name. | StageTextTextEditor | ||
![]() | filter : 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 | ||
![]() | hasVisibleArea : Boolean [read-only] Indicates if an object occupies any visible area. | DisplayObject | |
![]() | height : Number [override]
The height of the component, in pixels. | FeathersControl | |
![]() | isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
![]() | isFlattened : Boolean [read-only] Indicates if the sprite was flattened. | Sprite | |
![]() | isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
![]() | isQuickHitAreaEnabled : 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 | ||
![]() | 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 | |
![]() | 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 StageText property with the same name. | StageTextTextEditor | ||
returnKeyLabel : String
Same as the StageText property with the same name. | StageTextTextEditor | ||
![]() | 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 | |
softKeyboardType : String
Same as the StageText property with the same name. | StageTextTextEditor | ||
![]() | 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 input. | StageTextTextEditor | ||
textAlign : String
Same as the StageText property with the same name. | StageTextTextEditor | ||
![]() | 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 | |
![]() | 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 | |
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 |
Method | Defined By | ||
---|---|---|---|
Constructor. | StageTextTextEditor | ||
![]() | Adds a child to the container. | DisplayObjectContainer | |
![]() | Adds a child to the container at a certain index. | DisplayObjectContainer | |
![]() | addEventListener(type:String, listener:Function):void Registers an event listener at a certain object. | EventDispatcher | |
![]() | 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 | |
![]() | 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. | DisplayObjectContainer | |
![]() | 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 | |
![]() | 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. | DisplayObjectContainer | |
![]() | invalidate(flag:String):void
When called, the UI control will redraw within one frame. | FeathersControl | |
![]() | isInvalid(flag:String = null):Boolean
Indicates whether the control is invalid 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 Removes an event listener from the object. | EventDispatcher | |
![]() | removeEventListeners(type:String = null):void Removes all event listeners with a certain type, or all of them if type is null. | EventDispatcher | |
![]() | removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one. | 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. | StageTextTextEditor | ||
![]() | 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 | ||
![]() | 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. | StageTextTextEditor | |||
Dispatched when the user presses the Enter key while the editor has focus. | StageTextTextEditor | |||
![]() | 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. | StageTextTextEditor | |||
Dispatched when the text editor loses focus. | StageTextTextEditor | |||
![]() | Dispatched after initialize() has been called, but before the first time that draw() has been called. | FeathersControl | ||
![]() | 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 |
autoCapitalize | property |
autoCapitalize:String
Same as the StageText
property with the same name.
public function get autoCapitalize():String
public function set autoCapitalize(value:String):void
autoCorrect | property |
autoCorrect:Boolean
Same as the StageText
property with the same name.
public function get autoCorrect():Boolean
public function set autoCorrect(value:Boolean):void
color | property |
color:uint
Same as the StageText
property with the same name.
public function get color():uint
public function set color(value:uint):void
displayAsPassword | property |
displayAsPassword:Boolean
Same as the StageText
property with the same name.
public function get displayAsPassword():Boolean
public function set displayAsPassword(value:Boolean):void
editable | property |
editable:Boolean
Same as the StageText
property with the same name.
public function get editable():Boolean
public function set editable(value:Boolean):void
fontFamily | property |
fontFamily:String
Same as the StageText
property with the same name.
public function get fontFamily():String
public function set fontFamily(value:String):void
fontPosture | property |
fontPosture:String
Same as the StageText
property with the same name.
public function get fontPosture():String
public function set fontPosture(value:String):void
fontSize | property |
fontSize:int
Same as the StageText
property with the same name.
public function get fontSize():int
public function set fontSize(value:int):void
fontWeight | property |
fontWeight:String
Same as the StageText
property with the same name.
public function get fontWeight():String
public function set fontWeight(value:String):void
locale | property |
locale:String
Same as the StageText
property with the same name.
public function get locale():String
public function set locale(value:String):void
maxChars | property |
maxChars:int
Same as the StageText
property with the same name.
public function get maxChars():int
public function set maxChars(value:int):void
restrict | property |
restrict:String
Same as the StageText
property with the same name.
public function get restrict():String
public function set restrict(value:String):void
returnKeyLabel | property |
returnKeyLabel:String
Same as the StageText
property with the same name.
public function get returnKeyLabel():String
public function set returnKeyLabel(value:String):void
softKeyboardType | property |
softKeyboardType:String
Same as the StageText
property with the same name.
public function get softKeyboardType():String
public function set softKeyboardType(value:String):void
stageText | property |
protected var stageText:Object
The StageText instance. It's typed Object so that a replacement class can be used in browser-based Flash Player.
text | property |
text:String
The text displayed by the input.
public function get text():String
public function set text(value:String):void
textAlign | property |
textAlign:String
Same as the StageText
property with the same name.
public function get textAlign():String
public function set textAlign(value:String):void
textSnapshot | property |
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.
StageTextTextEditor | () | Constructor |
public function StageTextTextEditor()
Constructor.
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 )
|
change | Event |
enter | Event |
starling.events.Event
feathers.events.FeathersEventType.ENTER
Dispatched 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.Event
feathers.events.FeathersEventType.FOCUS_IN
Dispatched 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.Event
feathers.events.FeathersEventType.FOCUS_OUT
Dispatched when the text editor loses focus.
TheFeathersEventType.FOCUS_OUT
event type is used by
Feathers components to indicate when they have lost focus.