GODPAPER | All Packages | All Classes | Index | Frames No Frames |
ITextEditor

Package | feathers.core
Interface | public interface ITextEditor extends IFeathersControl, IFeathersDisplayObject, IFeathersEventDispatcher
Implementors | StageTextTextEditor, TextFieldTextEditor

Handles the editing of text.

See also

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

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | alpha : Number | IFeathersDisplayObject
|  | base : DisplayObject [read-only] | IFeathersDisplayObject
|  | blendMode : String | IFeathersDisplayObject
|  | bounds : Rectangle [read-only] | IFeathersDisplayObject
|  | filter : FragmentFilter | IFeathersDisplayObject
|  | hasVisibleArea : Boolean [read-only] | IFeathersDisplayObject
|  | height : Number | IFeathersDisplayObject
|  | isEnabled : Boolean Indicates whether the control is interactive or not. | IFeathersControl
|  | isInitialized : Boolean [read-only] Determines if the component has been initialized yet. | IFeathersControl
|  | maxHeight : Number The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component. | IFeathersControl
|  | maxWidth : Number The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component. | IFeathersControl
|  | minHeight : Number The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component. | IFeathersControl
|  | minWidth : Number The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component. | IFeathersControl
|  | name : String | IFeathersDisplayObject
|  | nameList : TokenList [read-only] Contains a list of all "names" assigned to this control. | IFeathersControl
|  | parent : DisplayObjectContainer [read-only] | IFeathersDisplayObject
|  | pivotX : Number | IFeathersDisplayObject
|  | pivotY : Number | IFeathersDisplayObject
|  | root : DisplayObject [read-only] | IFeathersDisplayObject
|  | rotation : Number | IFeathersDisplayObject
|  | scaleX : Number | IFeathersDisplayObject
|  | scaleY : Number | IFeathersDisplayObject
|  | skewX : Number | IFeathersDisplayObject
|  | skewY : Number | IFeathersDisplayObject
|  | stage : Stage [read-only] | IFeathersDisplayObject
|  | text : String The text displayed by the editor. | ITextEditor
|  | touchable : Boolean | IFeathersDisplayObject
|  | transformationMatrix : Matrix [read-only] | IFeathersDisplayObject
|  | useHandCursor : Boolean | IFeathersDisplayObject
|  | visible : Boolean | IFeathersDisplayObject
|  | width : Number | IFeathersDisplayObject
|  | x : Number | IFeathersDisplayObject
|  | y : Number | IFeathersDisplayObject

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | addEventListener(type:String, listener:Function):void | IFeathersEventDispatcher
|  | clearFocus():void Removes focus from the text editor. | ITextEditor
|  | dispatchEvent(event:Event):void | IFeathersEventDispatcher
|  | dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void | IFeathersEventDispatcher
|  | dispose():void | IFeathersDisplayObject
|  | getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle | IFeathersDisplayObject
|  | getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix | IFeathersDisplayObject
|  | globalToLocal(globalPoint:Point, resultPoint:Point = null):Point | IFeathersDisplayObject
|  | hasEventListener(type:String):Boolean | IFeathersEventDispatcher
|  | hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject | IFeathersDisplayObject
|  | localToGlobal(localPoint:Point, resultPoint:Point = null):Point | IFeathersDisplayObject
|  | removeEventListener(type:String, listener:Function):void | IFeathersEventDispatcher
|  | removeEventListeners(type:String = null):void | IFeathersEventDispatcher
|  | removeFromParent(dispose:Boolean = false):void | IFeathersDisplayObject
|  | render(support:RenderSupport, parentAlpha:Number):void | IFeathersDisplayObject
|  | selectRange(startIndex:int, endIndex:int):void Sets the range of selected characters. | ITextEditor
|  | setFocus(position:Point = null):void Gives focus to the text editor. | ITextEditor
|  | setSize(width:Number, height:Number):void Sets both the width and the height of the control. | IFeathersControl
|  | validate():void Immediately validates the control, which triggers a redraw, if one is pending. | IFeathersControl

Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | change | Dispatched when the text property changes. | ITextEditor
|  | enter | Dispatched when the user presses the Enter key while the editor has focus. | ITextEditor
|  | focusIn | Dispatched when the text editor receives focus. | ITextEditor
|  | focusOut | Dispatched when the text editor loses focus. | ITextEditor

Property Detail

text | property

`text:String`

The text displayed by the editor.

Implementation
`public function get text():String`
`public function set text(value:String):void`
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