feathers.controls.text.StageTextTextEditor

Public Properties

	Property		Defined By
		addedEffect : Function An optional effect that is activated when the component is added to the stage.	FeathersControl
		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
		clearButtonMode : String Determines when the clear button is displayed or hidden by the StageText object.	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 This property is managed by the TextInput. Determines if the entered text will be masked so that it cannot be seen, such as for a password input.	StageTextTextEditor
		effectsSuspended : Boolean [read-only] Indicates if effects have been suspended.	FeathersControl
		explicitHeight : Number [read-only] The height value explicitly set by passing a value to the height setter or by calling the setSize() function.	FeathersControl
		explicitMaxHeight : Number [read-only] The maximum height value explicitly set by passing a value to the maxHeight setter.	FeathersControl
		explicitMaxWidth : Number [read-only] The maximum width value explicitly set by passing a value to the maxWidth setter.	FeathersControl
		explicitMinHeight : Number [read-only] The minimum height value explicitly set by passing a value to the minHeight setter.	FeathersControl
		explicitMinWidth : Number [read-only] The minimum width value explicitly set by passing a value to the minWidth setter.	FeathersControl
		explicitWidth : Number [read-only] The width value explicitly set by passing a value to the width setter or to the setSize() method.	FeathersControl
		focusInEffect : Function An optional effect that is activated when the component receives focus.	FeathersControl
		focusManager : IFocusManager The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The current focus manager for this component.	FeathersControl
		focusOutEffect : Function An optional effect that is activated when the component loses focus.	FeathersControl
		focusOwner : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Used for associating focusable display objects that are not direct children with an "owner" focusable display object, such as pop-ups.	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
		fontStyles : FontStylesSet The internal font styles used to render the text that are passed down from the parent component.	BaseTextEditor
		fontWeight : String Specifies the font weight, using constants defined in the flash.text.engine.FontWeight class.	StageTextTextEditor
		globalStyleProvider : IStyleProvider [static] The default IStyleProvider for all StageTextTextEditor components.	StageTextTextEditor
		height : Number [override] The height of the component, in pixels.	FeathersControl
		hideEffect : Function An optional effect that is activated when the component is hidden.	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 This property is managed by the TextInput. Determines if the text input is editable.	StageTextTextEditor
		isEnabled : Boolean Indicates whether the control is interactive or not.	FeathersControl
		isFocusEnabled : Boolean The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. 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
		isSelectable : Boolean Warning: This property is ignored because flash.text.StageText does not support selectable text that is not editable. If the isEditable property is set to false, the isSelectable property determines if the text is selectable.	StageTextTextEditor
		isShowingFocus : Boolean [read-only] The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Indicates if the showFocus() method has been called on the object when it has focus.	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
		maintainTouchFocus : Boolean [override] If enabled, the text editor will remain in focus, even if something else is touched.	StageTextTextEditor
		maxChars : int This property is managed by the TextInput. The maximum number of characters that may be entered.	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
		moveEffect : Function An optional effect that is activated when the component is moved to a new position.	FeathersControl
		multiline : Boolean Indicates whether the StageText object can display more than one line of text.	StageTextTextEditor
		nativeFocus : Object [read-only] An object external to Starling that must be given focus when this Feathers component is given focus by a focus manager.	StageTextTextEditor
		nextDownFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.DOWN is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		nextLeftFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.LEFT is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		nextRightFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.RIGHT is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		nextTabFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when the tab key is pressed when a focus manager is enabled.	FeathersControl
		nextUpFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.UP is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		previousTabFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The previous object that will receive focus when the tab key is pressed while holding shift when a focus manager is enabled.	FeathersControl
		resizeEffect : Function An optional effect that is activated when the component is resized with new dimensions.	FeathersControl
		restrict : String This property is managed by the TextInput. Limits the set of characters that may be entered.	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
		showEffect : Function An optional effect that is activated when the component is shown.	FeathersControl
		softKeyboardType : String Controls the appearance of the soft keyboard.	StageTextTextEditor
		stateContext : IStateContext When the text editor observes a state context, the text editor may change its font styles based on the current state of that context.	BaseTextEditor
		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 editor.	BaseTextEditor
		textAlign : String Indicates the paragraph alignment.	StageTextTextEditor
		toolTip : String Text to display in a tool tip to when hovering over this component, if the ToolTipManager is enabled.	FeathersControl
		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
		actualMinHeight : Number = 0 The final minimum height value that should be used for layout.	FeathersControl
		actualMinWidth : Number = 0 The final minimum width 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 styleProvider property is set to this value.	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
		StageTextTextEditor() Constructor.	StageTextTextEditor
		clearFocus():void Removes focus from the text editor.	StageTextTextEditor
		getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Feathers components use an optimized getBounds() implementation that may sometimes behave differently than regular Starling display objects.	FeathersControl
		hideFocus():void The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.	FeathersControl
		initializeNow():void If the component has not yet initialized, initializes immediately.	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
		removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void Plays an effect before removing the component from its parent.	FeathersControl
		resetStyleProvider():void Resets the styleProvider property to its default value, which is usually the global style provider for the component.	FeathersControl
		resumeEffects():void Indicates that effects should be re-activated after being suspended.	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 The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.	FeathersControl
		suspendEffects():void Indicates that effects should not be activated temporarily.	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
		ignoreNextStyleRestriction():void The next style that is set will not be restricted.	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
		processStyleRestriction(key:Object):Boolean Used by setters for properties that are considered "styles" to determine if the setter has been called directly on the component or from a style provider.	FeathersControl
		refreshFocusIndicator():void Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.	FeathersControl
		saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean Saves the dimensions and minimum dimensions calculated for the component.	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

Summary	Defined By
change	Dispatched when the text property changes.	StageTextTextEditor
creationComplete	Dispatched after the component has validated for the first time.	FeathersControl
enter	Dispatched when the user presses the Enter key while the editor has focus.	StageTextTextEditor
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
resize	Dispatched when the width or height of the control changes.	FeathersControl
softKeyboardActivate	Dispatched when the soft keyboard is activated.	StageTextTextEditor
softKeyboardActivating	Dispatched when the soft keyboard is about to activate.	StageTextTextEditor
softKeyboardDeactivate	Dispatched when the soft keyboard is deactivated.	StageTextTextEditor

	Style	Defined By
		focusIndicatorSkin : DisplayObject If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.	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

	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_FOCUS : String = "focus" [static] Invalidation flag to indicate that the focus of 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

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.

Implementation
public function get autoCapitalize():String
public function set autoCapitalize(value:String):void

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.

Implementation
public function get autoCorrect():Boolean
public function set autoCorrect(value:Boolean):void

baseline

property

baseline:Number [read-only]

Returns the text baseline measurement, in pixels.

Implementation
public function get baseline():Number

clearButtonMode

property

clearButtonMode:String

Determines when the clear button is displayed or hidden by the StageText object.

In the following example, the clear button is always hidden:

textEditor.clearButtonMode = StageTextClearButtonMode.NEVER;

Requires -swf-version=34 or newer.

The default value is flash.text.StageTextClearButtonMode.WHILE_EDITING.

Implementation
public function get clearButtonMode():String
public function set clearButtonMode(value:String):void

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.

Implementation
public function get color():uint
public function set color(value:uint):void

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.

Implementation
public function get disabledColor():uint
public function set disabledColor(value:uint):void

displayAsPassword

property

displayAsPassword:Boolean

This property is managed by the TextInput.

Determines if the entered text will be masked so that it cannot be seen, such as for a password input.

In the following example, the text input's text is displayed as a password:

input.displayAsPassword = true;

Implementation
public function get displayAsPassword():Boolean
public function set displayAsPassword(value:Boolean):void

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.

Implementation
public function get fontFamily():String
public function set fontFamily(value:String):void

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.

Implementation
public function get fontPosture():String
public function set fontPosture(value:String):void

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.

Implementation
public function get fontSize():int
public function set fontSize(value:int):void

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.

Implementation
public function get fontWeight():String
public function set fontWeight(value:String):void

globalStyleProvider

property

public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all StageTextTextEditor components.

The default value is null.

isEditable

property

isEditable:Boolean

This property is managed by the TextInput.

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 input is not editable:

input.isEditable = false;

Implementation
public function get isEditable():Boolean
public function set isEditable(value:Boolean):void

See also

feathers.controls.TextInput.isEditable

isSelectable

property

isSelectable:Boolean

Warning: This property is ignored because flash.text.StageText does not support selectable text that is not editable.

If the isEditable property is set to false, the isSelectable property determines if the text is selectable. If the isEditable property is set to true, the text will always be selectable.

In the following example, the text input is not selectable:

input.isEditable = false;
input.isSelectable = false;

Implementation
public function get isSelectable():Boolean
public function set isSelectable(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".

Implementation
public function get locale():String
public function set locale(value:String):void

maintainTouchFocus

property

maintainTouchFocus:Boolean[override]

If enabled, the text editor will remain in focus, even if something else is touched.

Note: If the FocusManager is enabled, this property will be ignored.

In the following example, touch focus is maintained:

textEditor.maintainTouchFocus = true;

The default value is false.

Implementation
public function get maintainTouchFocus():Boolean
public function set maintainTouchFocus(value:Boolean):void

maxChars

property

maxChars:int

This property is managed by the TextInput.

The maximum number of characters that may be entered. If 0, any number of characters may be entered.

In the following example, the text input's maximum characters is specified:

input.maxChars = 10;

Implementation
public function get maxChars():int
public function set maxChars(value:int):void

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;

When setting this property to true, it is recommended that the text input's verticalAlign property is set to VerticalAlign.JUSTIFY.

The default value is false.

Implementation
public function get multiline():Boolean
public function set multiline(value:Boolean):void

nativeFocus

property

nativeFocus:Object [read-only]

An object external to Starling that must be given focus when this Feathers component is given focus by a focus manager.

This property may return null. When it returns null, the focus manager should treat this display object like any other display object that may receive focus but doesn't implement INativeFocusOwner.

If this property doesn't return a flash.display.InteractiveObject, the class must also implement IAdvancedNativeFocusOwner.

Implementation
public function get nativeFocus():Object

restrict

property

restrict:String

This property is managed by the TextInput.

Limits the set of characters that may be entered.

In the following example, the text input's allowed characters are restricted:

input.restrict = "0-9";

Implementation
public function get restrict():String
public function set restrict(value:String):void

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.

Implementation
public function get returnKeyLabel():String
public function set returnKeyLabel(value:String):void

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. This value will always be smaller than selectionEndIndex.

Implementation
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. This value will always be larger than selectionBeginIndex.

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

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

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.

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.

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.

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.

Implementation
public function get updateSnapshotOnScaleChange():Boolean
public function set updateSnapshotOnScaleChange(value:Boolean):void

Constructor Detail

StageTextTextEditor

()

Constructor

public function StageTextTextEditor()

Constructor.

Method Detail

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 saveMeasurements() 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.

Returns

Boolean

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)

Returns

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)

Event Detail

change

Event

Event Object Type: starling.events.Event
Event.type property = starling.events.Event.CHANGE

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.

See also

text

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

The FeathersEventType.ENTER event type is meant to be used when the enter key has been pressed in an input control.

See also

returnKeyLabel

focusIn

Event

Event Object Type: starling.events.Event
Event.type property = 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.

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

The FeathersEventType.FOCUS_OUT event type is used by Feathers components to indicate when they have lost focus.

softKeyboardActivate

Event

Event Object Type: starling.events.Event
Event.type property = 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.

The FeathersEventType.SOFT_KEYBOARD_ACTIVATE event type is used by Feathers text editors when they activate a device's soft keyboard.

softKeyboardActivating

Event

Event Object Type: starling.events.Event
Event.type property = feathers.events.FeathersEventType.SOFT_KEYBOARD_ACTIVATING

Dispatched when the soft keyboard is about to activate. 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.

The FeathersEventType.SOFT_KEYBOARD_ACTIVATING event type is used by Feathers text editors when they are about to activate a device's soft keyboard.

softKeyboardDeactivate

Event

Event Object Type: starling.events.Event
Event.type property = 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.

The FeathersEventType.SOFT_KEYBOARD_DEACTIVATE event type is used by Feathers text editors when they deactivate a device's soft keyboard.

Sat Jun 18 2022, 02:58 PM -07:00

Feathers (Starling) 4.1.1 API Reference	All Packages All Classes Index Frames No Frames
StageTextTextEditor	Properties Methods Events Styles Constants

Package	feathers.controls.text
Class	public class StageTextTextEditor
Inheritance	StageTextTextEditor BaseTextEditor FeathersControl starling.display.Sprite
Implements	IMultilineTextEditor, INativeFocusOwner