ITextEditor
public interface
feathers.core.ITextEditor
Description
Handles the editing of text.
See also:
feathers.controls.TextInput
http://wiki.starling-framework.org/feathers/text-editors
API overview
Constructor
ITextEditor
()
Attributes
Public attributes
| displayAsPassword: Boolean |
Determines if the entered text will be masked so that it cannot be seen, such as for a password input |
| isEditable: Boolean |
Determines if the text is editable |
| keyboardType: LoomKeyboardType |
Determines the type of keyboard opened when focus is gained |
| maxChars: Number |
The maximum number of characters that may be entered |
| restrict: String |
Limits the set of characters that may be entered |
| setTouchFocusOnEndedPhase: Boolean |
read-only
Determines if the owner should call |
| text: String |
The text displayed by the editor |
Functions
Public functions
| clearFocus (): Void |
Removes focus from the text editor |
| measureText (): Point |
Measures the text's bounds (without a full validation, if possible) |
| selectRange ( startIndex: Number , endIndex: Number ): Void |
Sets the range of selected characters |
| setFocus (): Void |
Gives focus to the text editor |
Constructor
ITextEditor ()
Attributes
base: DisplayObject
Inherited from IFeathersDisplayObject
read-only
See also:
loom2d.display.DisplayObject#base
blendMode: String
Inherited from IFeathersDisplayObject
See also:
loom2d.display.DisplayObject#blendMode
bounds: Rectangle
Inherited from IFeathersDisplayObject
read-only
See also:
loom2d.display.DisplayObject#bounds
displayAsPassword: Boolean
Determines if the entered text will be masked so that it cannot be seen, such as for a password input.
hasVisibleArea: Boolean
Inherited from IFeathersDisplayObject
read-only
isEnabled: Boolean
Inherited from IFeathersControl
Indicates whether the control is interactive or not.
isInitialized: Boolean
Inherited from IFeathersControl
read-only
Determines if the component has been initialized yet. The
initialize() function is called one time only, when the
Feathers UI control is added to the display list for the first time.
maxHeight: Number
Inherited from IFeathersControl
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. This value
is not strictly enforced in all cases. An explicit height value that
is larger than maxHeight may be set and will not be
affected by the maximum.
maxWidth: Number
Inherited from IFeathersControl
The maximum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. This value
is not strictly enforced in all cases. An explicit width value that
is larger than maxWidth may be set and will not be
affected by the maximum.
minHeight: Number
Inherited from IFeathersControl
The minimum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. This value
is not strictly enforced in all cases. An explicit height value that
is smaller than minHeight may be set and will not be
affected by the minimum.
minWidth: Number
Inherited from IFeathersControl
The minimum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. This value
is not strictly enforced in all cases. An explicit width value that
is smaller than minWidth may be set and will not be
affected by the minimum.
nameList: TokenList
Inherited from IFeathersControl
read-only
Contains a list of all "names" assigned to this control. Names are
like classes in CSS selectors. They are a non-unique identifier that
can differentiate multiple styles of the same type of UI control. A
single control may have many names, and many controls can share a
single name. Names may be added, removed, or toggled on the nameList.
See also:
#name
parent: DisplayObjectContainer
Inherited from IFeathersDisplayObject
read-only
See also:
loom2d.display.DisplayObject#parent
root: DisplayObject
Inherited from IFeathersDisplayObject
read-only
See also:
loom2d.display.DisplayObject#root
rotation: Number
Inherited from IFeathersDisplayObject
See also:
loom2d.display.DisplayObject#rotation
setTouchFocusOnEndedPhase: Boolean
read-only
Determines if the owner should call setFocus() on
TouchPhase.ENDED or on TouchPhase.BEGAN.
This is a hack because StageText doesn't like being
assigned focus on TouchPhase.BEGAN. In general, most
text editors should simply return false.
See also:
#setFocus()
stage: Stage
Inherited from IFeathersDisplayObject
read-only
See also:
loom2d.display.DisplayObject#stage
touchable: Boolean
Inherited from IFeathersDisplayObject
See also:
loom2d.display.DisplayObject#touchable
transformationMatrix: Matrix
Inherited from IFeathersDisplayObject
read-only
useHandCursor: Boolean
Inherited from IFeathersDisplayObject
visible: Boolean
Inherited from IFeathersDisplayObject
See also:
loom2d.display.DisplayObject#visible
Functions
addEventListener
(
type: String
,
listener: Function
): Void
Inherited from IFeathersEventDispatcher
See also:
loom2d.events.EventDispatcher#addEventListener()
Parameters
| type: String | |
| listener: Function |
dispatchEvent
(
event: Event
): Void
Inherited from IFeathersEventDispatcher
See also:
loom2d.events.EventDispatcher#dispatchEvent()
Parameters
| event: Event |
dispatchEventWith
(
type: String
,
bubbles: Boolean
= false
,
data: Object
= null
): Void
Inherited from IFeathersEventDispatcher
See also:
loom2d.events.EventDispatcher#dispatchEventWith()
Parameters
| type: String | |
| bubbles: Boolean = false | |
| data: Object = null |
dispose
(): Void
Inherited from IFeathersDisplayObject
See also:
loom2d.display.DisplayObject#dispose()
getBounds
(
targetSpace: DisplayObject
,
resultRect: Rectangle
= null
): Rectangle
Inherited from IFeathersDisplayObject
See also:
loom2d.display.DisplayObject#getBounds()
Parameters
| targetSpace: DisplayObject | |
| resultRect: Rectangle = null |
getTransformationMatrix
(
targetSpace: DisplayObject
,
resultMatrix: Matrix
= null
): Matrix
Inherited from IFeathersDisplayObject
See also:
loom2d.display.DisplayObject#getTransformationMatrix()
Parameters
| targetSpace: DisplayObject | |
| resultMatrix: Matrix = null |
globalToLocal
(
globalPoint: Point
): Point
Inherited from IFeathersDisplayObject
See also:
loom2d.display.DisplayObject#globalToLocal()
Parameters
| globalPoint: Point |
hasEventListener
(
type: String
): Boolean
Inherited from IFeathersEventDispatcher
See also:
loom2d.events.EventDispatcher#hasEventListener()
Parameters
| type: String |
hitTest
(
localPoint: Point
,
forTouch: Boolean
= false
): DisplayObject
Inherited from IFeathersDisplayObject
See also:
loom2d.display.DisplayObject#hitTest()
Parameters
| localPoint: Point | |
| forTouch: Boolean = false |
localToGlobal
(
localPoint: Point
): Point
Inherited from IFeathersDisplayObject
See also:
loom2d.display.DisplayObject#localToGlobal()
Parameters
| localPoint: Point |
removeEventListener
(
type: String
,
listener: Function
): Void
Inherited from IFeathersEventDispatcher
See also:
loom2d.events.EventDispatcher#removeEventListener()
Parameters
| type: String | |
| listener: Function |
removeEventListeners
(
type: String
= null
): Void
Inherited from IFeathersEventDispatcher
See also:
loom2d.events.EventDispatcher#removeEventListeners()
Parameters
| type: String = null |
removeFromParent
(
dispose: Boolean
= false
): Void
Inherited from IFeathersDisplayObject
See also:
loom2d.display.DisplayObject#removeFromParent()
Parameters
| dispose: Boolean = false |
render
(): Void
Inherited from IFeathersDisplayObject
See also:
loom2d.display.DisplayObject#render()
selectRange ( startIndex: Number , endIndex: Number ): 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: Number | |
| endIndex: Number |
setFocus (): 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.