feathers.controls.text.StageTextTextEditor

Public Properties

	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
		clipRect : Rectangle [override]	FeathersControl
		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 that is attached to the display object.	DisplayObject
		focusManager : IFocusManager The current focus manager for this component.	FeathersControl
		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
		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
		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
		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
		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 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

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		StageTextTextEditor() Constructor.	StageTextTextEditor
		addChild(child:DisplayObject):DisplayObject Adds a child to the container.	DisplayObjectContainer
		addChildAt(child:DisplayObject, index:int):DisplayObject 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.	StageTextTextEditor
		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
		removeChild(child:DisplayObject, dispose:Boolean = false):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.	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
		swapChildren(child1:DisplayObject, child2:DisplayObject):void 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

	Method	Defined By
		draw():void Override to customize layout and to adjust properties of children.	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
		setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean Sets the width and height of the control, with the option of invalidating or not.	FeathersControl

Summary	Defined By
added	Dispatched when an object is added to a parent.	DisplayObject
addedToStage	Dispatched when an object is connected to the stage (directly or indirectly).	DisplayObject
change	Dispatched when the text property changes.	StageTextTextEditor
enter	Dispatched when the user presses the Enter key while the editor has focus.	StageTextTextEditor
enterFrame	Dispatched once every frame on every object that is connected to the stage.	DisplayObject
flatten	Dispatched on all children when the object is flattened.	Sprite
focusIn	Dispatched when the text editor receives focus.	StageTextTextEditor
focusOut	Dispatched when the text editor loses focus.	StageTextTextEditor
initialize	Dispatched after initialize() has been called, but before the first time that draw() has been called.	FeathersControl
keyDown	Dispatched when a key on the keyboard is pressed.	DisplayObject
keyUp	Dispatched when a key on the keyboard is released.	DisplayObject
removed	Dispatched when an object is removed from its parent.	DisplayObject
removedFromStage	Dispatched when an object is removed from the stage and won't be rendered any longer.	DisplayObject
resize	Dispatched when the width or height of the control changes.	FeathersControl
touch	Dispatched when an object is touched.	DisplayObject

	Constant	Defined By
		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_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

Property Detail

autoCapitalize

property

autoCapitalize:String

Same as the StageText property with the same name.

Implementation
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.

Implementation
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.

Implementation
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.

Implementation
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.

Implementation
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.

Implementation
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.

Implementation
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.

Implementation
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.

Implementation
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.

Implementation
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.

Implementation
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.

Implementation
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.

Implementation
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.

Implementation
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.

Implementation
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.

Implementation
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.

Constructor Detail

StageTextTextEditor

()

Constructor

public function StageTextTextEditor()

Constructor.

Method Detail

clearFocus

()

method

public function clearFocus():void

Removes focus from the text editor.

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.

Thu Jan 16 2014, 01:11 PM +08:00

GODPAPER	All Packages \| All Classes \| Index \| Frames No Frames
StageTextTextEditor	Properties \| Methods \| Events \| Constants

Package	feathers.controls.text
Class	public class StageTextTextEditor
Inheritance	StageTextTextEditor FeathersControl Sprite DisplayObjectContainer DisplayObject EventDispatcher Object
Implements	ITextEditor