Package | feathers.controls.text |
Class | public class StageTextTextEditor |
Inheritance | StageTextTextEditor ![]() ![]() |
Implements | IMultilineTextEditor |
flash.text.StageText
class in Adobe AIR, and the custom feathers.text.StageTextField
class (that simulates StageText
using
flash.text.TextField
) in Adobe Flash Player.
Note: Due to quirks with how the runtime manages focus with
StageText
, StageTextTextEditor
is not
compatible with the Feathers FocusManager
.
See also
Property | Defined By | ||
---|---|---|---|
autoCapitalize : String
Controls how a device applies auto capitalization to user input. | StageTextTextEditor | ||
autoCorrect : Boolean
Indicates whether a device auto-corrects user input for spelling or
punctuation mistakes. | StageTextTextEditor | ||
baseline : Number [read-only]
Returns the text baseline measurement, in pixels. | StageTextTextEditor | ||
color : uint
Specifies text color as a number containing three 8-bit RGB
components. | 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 | |
![]() | depth : int [read-only]
The component's depth in the display list, relative to the stage. | FeathersControl | |
disabledColor : uint
Specifies text color when the component is disabled as a number
containing three 8-bit RGB components. | StageTextTextEditor | ||
displayAsPassword : Boolean
Indicates whether the text field is a password text field that hides
input characters using a substitute character. | StageTextTextEditor | ||
![]() | focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be
displayed above the component when showFocus() is
called. | FeathersControl | |
![]() | focusManager : IFocusManager | FeathersControl | |
![]() | focusOwner : IFocusDisplayObject | FeathersControl | |
![]() | focusPadding : Number
Quickly sets all focus padding properties to the same value. | FeathersControl | |
![]() | focusPaddingBottom : Number
The minimum space, in pixels, between the object's bottom edge and the
bottom edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingLeft : Number
The minimum space, in pixels, between the object's left edge and the
left edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingRight : Number
The minimum space, in pixels, between the object's right edge and the
right edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingTop : Number
The minimum space, in pixels, between the object's top edge and the
top edge of the focus indicator skin. | FeathersControl | |
fontFamily : String
Indicates the name of the current font family. | StageTextTextEditor | ||
fontPosture : String
Specifies the font posture, using constants defined in the
flash.text.engine.FontPosture class. | StageTextTextEditor | ||
fontSize : int
The size in pixels for the current font family. | StageTextTextEditor | ||
fontWeight : String
Specifies the font weight, using constants defined in the
flash.text.engine.FontWeight class. | StageTextTextEditor | ||
![]() | 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 | |
![]() | isCreated : Boolean [read-only]
Determines if the component has been initialized and validated for
the first time. | FeathersControl | |
isEditable : Boolean
Determines if the text input is editable. | StageTextTextEditor | ||
![]() | isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
![]() | isFocusEnabled : Boolean | 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
Indicates the locale of the text. | StageTextTextEditor | ||
maxChars : int
Indicates the maximum number of characters that a user can enter into
the text editor. | 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 | |
multiline : Boolean
Indicates whether the StageText object can display more than one line
of text. | StageTextTextEditor | ||
![]() | nextTabFocus : IFocusDisplayObject | FeathersControl | |
![]() | previousTabFocus : IFocusDisplayObject | FeathersControl | |
restrict : String
Restricts the set of characters that a user can enter into the text
field. | StageTextTextEditor | ||
returnKeyLabel : String
Indicates the label on the Return key for devices that feature a soft
keyboard. | StageTextTextEditor | ||
selectionBeginIndex : int [read-only]
The index of the first character of the selection. | StageTextTextEditor | ||
selectionEndIndex : int [read-only]
The index of the last character of the selection. | StageTextTextEditor | ||
setTouchFocusOnEndedPhase : Boolean [read-only]
Determines if the owner should call setFocus() on
TouchPhase.ENDED or on TouchPhase.BEGAN. | StageTextTextEditor | ||
softKeyboardType : String
Controls the appearance of the soft keyboard. | StageTextTextEditor | ||
![]() | styleName : String
The concatenated styleNameList, with values separated
by spaces. | FeathersControl | |
![]() | styleNameList : TokenList [read-only]
Contains a list of all "styles" assigned to this control. | FeathersControl | |
![]() | styleProvider : IStyleProvider
When a component initializes, a style provider may be used to set
properties that affect the component's visual appearance. | FeathersControl | |
text : String
The text displayed by the input. | StageTextTextEditor | ||
textAlign : String
Indicates the paragraph alignment. | StageTextTextEditor | ||
updateSnapshotOnScaleChange : Boolean
Refreshes the texture snapshot every time that the text editor is
scaled. | StageTextTextEditor | ||
![]() | width : Number [override]
The width of the component, in pixels. | FeathersControl |
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 | |
![]() | defaultStyleProvider : IStyleProvider [read-only]
When the FeathersControl constructor is called, the
globalStyleProvider property is set to this value. | 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 | ||
clearFocus():void
Removes focus from the text editor. | StageTextTextEditor | ||
![]() | hideFocus():void
If the visual indicator of focus has been displayed by
showFocus(), call this function to hide it. | FeathersControl | |
![]() | 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 | |
measureText(result:Point = null):Point
Measures the text's bounds (without a full validation, if
possible). | StageTextTextEditor | ||
![]() | move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single
function call. | FeathersControl | |
selectRange(beginIndex:int, endIndex:int):void
Sets the range of selected characters. | StageTextTextEditor | ||
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 in a single
function call. | FeathersControl | |
![]() | showFocus():void
If the object has focus, an additional visual indicator may
optionally be displayed to highlight the object. | FeathersControl | |
![]() | validate():void
Immediately validates the display object, if it is invalid. | FeathersControl |
Method | Defined By | ||
---|---|---|---|
autoSizeIfNeeded():Boolean
If the component's dimensions have not been set explicitly, it will
measure its content and determine an ideal size for itself. | StageTextTextEditor | ||
![]() | clearInvalidationFlag(flag:String):void
Clears an invalidation flag. | FeathersControl | |
createStageText():void
Creates and adds the stageText instance. | StageTextTextEditor | ||
![]() | draw():void
Override to customize layout and to adjust properties of children. | FeathersControl | |
![]() | focusInHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_IN
that may be overridden in subclasses to perform additional actions
when the component receives focus. | FeathersControl | |
![]() | focusOutHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_OUT
that may be overridden in subclasses to perform additional actions
when the component loses focus. | 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 | |
![]() | refreshFocusIndicator():void
Updates the focus indicator skin by showing or hiding it and
adjusting its position and dimensions. | FeathersControl | |
![]() | setInvalidationFlag(flag:String):void
Sets an invalidation flag. | 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 |
Event | Summary | Defined By | ||
---|---|---|---|---|
Dispatched when the text property changes. | StageTextTextEditor | |||
![]() | Dispatched after the component has validated for the first time. | FeathersControl | ||
Dispatched when the user presses the Enter key while the editor has focus. | StageTextTextEditor | |||
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 the width or height of the control changes. | FeathersControl | ||
Dispatched when the soft keyboard is activated. | StageTextTextEditor | |||
Dispatched when the soft keyboard is deactivated. | StageTextTextEditor |
autoCapitalize | property |
autoCapitalize:String
Controls how a device applies auto capitalization to user input. This property is only a hint to the underlying platform, because not all devices and operating systems support this functionality.
In the following example, the auto capitalize behavior is changed:
textEditor.autoCapitalize = AutoCapitalize.WORD;
The default value is flash.text.AutoCapitalize.NONE
.
public function get autoCapitalize():String
public function set autoCapitalize(value:String):void
See also
autoCorrect | property |
autoCorrect:Boolean
Indicates whether a device auto-corrects user input for spelling or punctuation mistakes. This property is only a hint to the underlying platform, because not all devices and operating systems support this functionality.
In the following example, auto correct is enabled:
textEditor.autoCorrect = true;
The default value is false
.
public function get autoCorrect():Boolean
public function set autoCorrect(value:Boolean):void
See also
baseline | property |
baseline:Number
[read-only] Returns the text baseline measurement, in pixels.
public function get baseline():Number
color | property |
color:uint
Specifies text color as a number containing three 8-bit RGB components.
In the following example, the text color is changed:
textEditor.color = 0xff9900;
The default value is 0x000000
.
public function get color():uint
public function set color(value:uint):void
See also
disabledColor | property |
disabledColor:uint
Specifies text color when the component is disabled as a number containing three 8-bit RGB components.
In the following example, the text color is changed:
textEditor.isEnabled = false; textEditor.disabledColor = 0xff9900;
The default value is 0x999999
.
public function get disabledColor():uint
public function set disabledColor(value:uint):void
See also
displayAsPassword | property |
displayAsPassword:Boolean
Indicates whether the text field is a password text field that hides input characters using a substitute character.
In the following example, the text is displayed as a password:
textEditor.displayAsPassword = true;
The default value is false
.
public function get displayAsPassword():Boolean
public function set displayAsPassword(value:Boolean):void
See also
fontFamily | property |
fontFamily:String
Indicates the name of the current font family. A value of null indicates the system default.
In the following example, the font family is changed:
textEditor.fontFamily = "Source Sans Pro";
The default value is null
.
public function get fontFamily():String
public function set fontFamily(value:String):void
See also
fontPosture | property |
fontPosture:String
Specifies the font posture, using constants defined in the
flash.text.engine.FontPosture
class.
In the following example, the font posture is changed:
textEditor.fontPosture = FontPosture.ITALIC;
The default value is flash.text.engine.FontPosture.NORMAL
.
public function get fontPosture():String
public function set fontPosture(value:String):void
See also
fontSize | property |
fontSize:int
The size in pixels for the current font family.
In the following example, the font size is increased to 16 pixels:
textEditor.fontSize = 16;
The default value is 12
.
public function get fontSize():int
public function set fontSize(value:int):void
See also
fontWeight | property |
fontWeight:String
Specifies the font weight, using constants defined in the
flash.text.engine.FontWeight
class.
In the following example, the font weight is changed to bold:
textEditor.fontWeight = FontWeight.BOLD;
The default value is flash.text.engine.FontWeight.NORMAL
.
public function get fontWeight():String
public function set fontWeight(value:String):void
See also
isEditable | property |
isEditable:Boolean
Determines if the text input is editable. If the text input is not editable, it will still appear enabled.
In the following example, the text is not editable:
textEditor.isEditable = false;
The default value is true
.
public function get isEditable():Boolean
public function set isEditable(value:Boolean):void
locale | property |
locale:String
Indicates the locale of the text. StageText
uses the
standard locale identifiers. For example "en"
,
"en_US"
and "en-US"
are all English.
In the following example, the locale is changed to Russian:
textEditor.locale = "ru";
The default value is "en"
.
public function get locale():String
public function set locale(value:String):void
See also
maxChars | property |
maxChars:int
Indicates the maximum number of characters that a user can enter into
the text editor. A script can insert more text than maxChars
allows. If maxChars
equals zero, a user can enter an
unlimited amount of text into the text editor.
In the following example, the maximum character count is changed:
textEditor.maxChars = 10;
The default value is 0
.
public function get maxChars():int
public function set maxChars(value:int):void
See also
multiline | property |
multiline:Boolean
Indicates whether the StageText object can display more than one line
of text. This property is configurable after the text editor is
created, unlike a regular StageText
instance. The text
editor will dispose and recreate its internal StageText
instance if the value of the multiline
property is
changed after the StageText
is initially created.
In the following example, multiline is enabled:
textEditor.multiline = true;
true
, it is recommended
that the text input's verticalAlign
property is set to
TextInput.VERTICAL_ALIGN_JUSTIFY
.
The default value is false
.
public function get multiline():Boolean
public function set multiline(value:Boolean):void
See also
restrict | property |
restrict:String
Restricts the set of characters that a user can enter into the text field. Only user interaction is restricted; a script can put any text into the text field.
In the following example, the text is restricted to numbers:
textEditor.restrict = "0-9";
The default value is null
.
public function get restrict():String
public function set restrict(value:String):void
See also
returnKeyLabel | property |
returnKeyLabel:String
Indicates the label on the Return key for devices that feature a soft
keyboard. The available values are constants defined in the
flash.text.ReturnKeyLabel
class. This property is only a
hint to the underlying platform, because not all devices and
operating systems support this functionality.
In the following example, the return key label is changed:
textEditor.returnKeyLabel = ReturnKeyLabel.GO;
The default value is flash.text.ReturnKeyLabel.DEFAULT
.
public function get returnKeyLabel():String
public function set returnKeyLabel(value:String):void
See also
selectionBeginIndex | property |
selectionBeginIndex:int
[read-only] The index of the first character of the selection. If no text is selected, then this is the value of the caret index.
public function get selectionBeginIndex():int
selectionEndIndex | property |
selectionEndIndex:int
[read-only] The index of the last character of the selection. If no text is selected, then this is the value of the caret index.
public function get selectionEndIndex():int
setTouchFocusOnEndedPhase | property |
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
.
The default value is true
.
public function get setTouchFocusOnEndedPhase():Boolean
softKeyboardType | property |
softKeyboardType:String
Controls the appearance of the soft keyboard. Valid values are
defined as constants in the flash.text.SoftKeyboardType
class. This property is only a hint to the underlying platform,
because not all devices and operating systems support this
functionality.
In the following example, the soft keyboard type is changed:
textEditor.softKeyboardType = SoftKeyboardType.NUMBER;
The default value is flash.text.SoftKeyboardType.DEFAULT
.
public function get softKeyboardType():String
public function set softKeyboardType(value:String):void
See also
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.
In the following example, the text is changed:
textEditor.text = "Lorem ipsum";
The default value is ""
.
public function get text():String
public function set text(value:String):void
textAlign | property |
textAlign:String
Indicates the paragraph alignment. Valid values are defined as
constants in the flash.text.TextFormatAlign
class.
In the following example, the text is centered:
textEditor.textAlign = TextFormatAlign.CENTER;
The default value is flash.text.TextFormatAlign.START
.
public function get textAlign():String
public function set textAlign(value:String):void
See also
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.
updateSnapshotOnScaleChange | property |
updateSnapshotOnScaleChange:Boolean
Refreshes the texture snapshot every time that the text editor is scaled. Based on the scale in global coordinates, so scaling the parent will require a new snapshot.
Warning: setting this property to true may result in reduced performance because every change of the scale requires uploading a new texture to the GPU. Use with caution. Consider setting this property to false temporarily during animations that modify the scale.
In the following example, the snapshot will be updated when the text editor is scaled:
textEditor.updateSnapshotOnScaleChange = true;
The default value is false
.
public function get updateSnapshotOnScaleChange():Boolean
public function set updateSnapshotOnScaleChange(value:Boolean):void
StageTextTextEditor | () | Constructor |
public function StageTextTextEditor()
Constructor.
autoSizeIfNeeded | () | method |
protected function autoSizeIfNeeded():Boolean
If the component's dimensions have not been set explicitly, it will
measure its content and determine an ideal size for itself. If the
explicitWidth
or explicitHeight
member
variables are set, those value will be used without additional
measurement. If one is set, but not the other, the dimension with the
explicit value will not be measured, but the other non-explicit
dimension will still need measurement.
Calls setSizeInternal()
to set up the
actualWidth
and actualHeight
member
variables used for layout.
Meant for internal use, and subclasses may override this function with a custom implementation.
ReturnsBoolean |
clearFocus | () | method |
public function clearFocus():void
Removes focus from the text editor.
createStageText | () | method |
protected function createStageText():void
Creates and adds the stageText
instance.
Meant for internal use, and subclasses may override this function with a custom implementation.
measureText | () | method |
public function measureText(result:Point = null):Point
Measures the text's bounds (without a full validation, if possible).
Parameters
result:Point (default = null )
|
Point |
selectRange | () | method |
public function selectRange(beginIndex: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
beginIndex: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 |
starling.events.Event
Dispatched when the text property changes.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | null |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |
enter | Event |
starling.events.Event
feathers.events.FeathersEventType.ENTER
Dispatched when the user presses the Enter key while the editor has
focus. This event may not be dispatched on some platforms, depending on
the value of returnKeyLabel
. This issue may even occur when
using the default value of returnKeyLabel
!
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | null |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |
FeathersEventType.ENTER
event type is meant to
be used when the enter key has been pressed in an input control.
See also
focusIn | Event |
starling.events.Event
feathers.events.FeathersEventType.FOCUS_IN
Dispatched when the text editor receives focus.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | null |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |
FeathersEventType.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.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | null |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |
FeathersEventType.FOCUS_OUT
event type is used by
Feathers components to indicate when they have lost focus.
softKeyboardActivate | Event |
starling.events.Event
feathers.events.FeathersEventType.SOFT_KEYBOARD_ACTIVATE
Dispatched when the soft keyboard is activated. Not all text editors will activate a soft keyboard.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | null |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |
FeathersEventType.SOFT_KEYBOARD_ACTIVATE
event type
is used by Feathers text editors when they activate a device's soft
keyboard.
softKeyboardDeactivate | Event |
starling.events.Event
feathers.events.FeathersEventType.SOFT_KEYBOARD_DEACTIVATE
Dispatched when the soft keyboard is deactivated. Not all text editors will activate a soft keyboard.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | null |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |
FeathersEventType.SOFT_KEYBOARD_DEACTIVATE
event type
is used by Feathers text editors when they deactivate a device's soft
keyboard.