Package | feathers.controls.text |
Class | public class TextFieldTextEditor |
Inheritance | TextFieldTextEditor BaseTextEditor FeathersControl starling.display.Sprite |
Implements | ITextEditor, INativeFocusOwner |
Subclasses | TextFieldTextEditorViewPort |
Product Version : | Feathers 1.0.0 |
TextInput
component, using the native
flash.text.TextField
class with its type
property set to flash.text.TextInputType.INPUT
. When not in
focus, the TextField
is drawn to BitmapData
and
uploaded to a texture on the GPU. Textures are managed internally by this
component, and they will be automatically disposed when the component is
disposed.
For desktop apps, TextFieldTextEditor
is recommended
instead of StageTextTextEditor
. StageTextTextEditor
will still work in desktop apps, but it is more appropriate for mobile
apps.
The following example shows how to use
TextFieldTextEditor
with a TextInput
:
var input:TextInput = new TextInput(); input.textEditorFactory = function():ITextEditor { return new TextFieldTextEditor(); }; this.addChild( input );
See also
Property | Defined By | ||
---|---|---|---|
addedEffect : Function
An optional effect that is activated when the component is added to
the stage. | FeathersControl | ||
alwaysShowSelection : Boolean
When set to true and the text field is not in focus,
Flash Player highlights the selection in the text field in gray. | TextFieldTextEditor | ||
antiAliasType : String
The type of anti-aliasing used for this text field, defined as
constants in the flash.text.AntiAliasType class. | TextFieldTextEditor | ||
background : Boolean
Specifies whether the text field has a background fill. | TextFieldTextEditor | ||
backgroundColor : uint
The color of the text field background that is displayed if the
background property is set to true. | TextFieldTextEditor | ||
baseline : Number [read-only]
Returns the text baseline measurement, in pixels. | TextFieldTextEditor | ||
border : Boolean
Specifies whether the text field has a border. | TextFieldTextEditor | ||
borderColor : uint
The color of the text field border that is displayed if the
border property is set to true. | TextFieldTextEditor | ||
currentTextFormat : TextFormat [read-only]
For debugging purposes, the current
flash.text.TextFormat used to render the text. | TextFieldTextEditor | ||
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 | ||
disabledTextFormat : TextFormat
Advanced font formatting used to draw the text when the component is
disabled, if disabledFontStyles and
starling.text.TextFormat cannot be used on the parent
component because the full capabilities of
flash.text.TextField are required. | TextFieldTextEditor | ||
displayAsPassword : Boolean
This property is managed by the TextInput.
Specifies whether the text field is a password text field that hides
the input characters using asterisks instead of the actual
characters. | TextFieldTextEditor | ||
effectsSuspended : Boolean [read-only]
Indicates if effects have been suspended. | FeathersControl | ||
embedFonts : Boolean
If advanced flash.text.TextFormat styles are specified,
determines if the TextField should use an embedded font or not. | TextFieldTextEditor | ||
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 | ||
fontStyles : FontStylesSet
The internal font styles used to render the text that are passed down
from the parent component. | BaseTextEditor | ||
globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all TextFieldTextEditor
components. | TextFieldTextEditor | ||
gridFitType : String
Determines whether Flash Player forces strong horizontal and vertical
lines to fit to a pixel or subpixel grid, or not at all using the
constants defined in the flash.text.GridFitType class. | TextFieldTextEditor | ||
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. | TextFieldTextEditor | ||
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 | ||
isHTML : Boolean
Determines if the TextField should display the value of the
text property as HTML or not. | TextFieldTextEditor | ||
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
This property is managed by the TextInput.
If the isEditable property is set to false,
the isSelectable property determines if the text is
selectable. | TextFieldTextEditor | ||
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 | ||
maintainTouchFocus : Boolean [override]
If enabled, the text editor will remain in focus, even if something
else is touched. | TextFieldTextEditor | ||
maxChars : int
This property is managed by the TextInput.
The maximum number of characters that may be entered. | TextFieldTextEditor | ||
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 field is a multiline text field. | TextFieldTextEditor | ||
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. | TextFieldTextEditor | ||
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 | ||
resetScrollOnFocusOut : Boolean
Indicates of the text editor resets its current scroll position to
0 on focus out. | TextFieldTextEditor | ||
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. | TextFieldTextEditor | ||
selectionBeginIndex : int [read-only]
The index of the first character of the selection. | TextFieldTextEditor | ||
selectionEndIndex : int [read-only]
The index of the last character of the selection. | TextFieldTextEditor | ||
setTouchFocusOnEndedPhase : Boolean [read-only]
Determines if the owner should call setFocus() on
TouchPhase.ENDED or on TouchPhase.BEGAN. | TextFieldTextEditor | ||
sharpness : Number
The sharpness of the glyph edges in this text field. | TextFieldTextEditor | ||
showEffect : Function
An optional effect that is activated when the component is shown. | FeathersControl | ||
softKeyboard : String
Customizes the soft keyboard that is displayed on a touch screen
when the text editor has focus. | TextFieldTextEditor | ||
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 | ||
textFormat : TextFormat
Advanced font formatting used to draw the text, if
fontStyles and starling.text.TextFormat
cannot be used on the parent component because the full capabilities
of flash.text.TextField are required. | TextFieldTextEditor | ||
thickness : Number
The thickness of the glyph edges in this text field. | TextFieldTextEditor | ||
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. | TextFieldTextEditor | ||
useGutter : Boolean
Determines if the 2-pixel gutter around the edges of the
flash.text.TextField will be used in measurement and
layout. | TextFieldTextEditor | ||
useSnapshotDelayWorkaround : Boolean
Fixes an issue where flash.text.TextField renders
incorrectly when drawn to BitmapData by waiting one
frame. | TextFieldTextEditor | ||
width : Number [override]
The width of the component, in pixels. | FeathersControl | ||
wordWrap : Boolean
Determines if the TextField wraps text to the next line. | TextFieldTextEditor |
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 | ||
measureTextField : TextField
The separate text field sub-component used for measurement. | TextFieldTextEditor | ||
textField : TextField
The text field sub-component. | TextFieldTextEditor | ||
textSnapshot : Image
An image that displays a snapshot of the native TextField
in the Starling display list when the editor doesn't have focus. | TextFieldTextEditor |
Method | Defined By | ||
---|---|---|---|
Constructor. | TextFieldTextEditor | ||
clearFocus():void
Removes focus from the text editor. | TextFieldTextEditor | ||
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 | ||
getTextFormatForState(state:String):TextFormat
Gets the advanced flash.text.TextFormat font formatting
passed in using setTextFormatForState() for the
specified state. | TextFieldTextEditor | ||
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). | TextFieldTextEditor | ||
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. | TextFieldTextEditor | ||
setFocus(position:Point = null):void
Gives focus to the text editor. | TextFieldTextEditor | ||
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single
function call. | FeathersControl | ||
setTextFormatForState(state:String, textFormat:TextFormat):void
Sets the advanced flash.text.TextFormat font formatting
to be used by the text editor when the currentState
property of the stateContext matches the specified state
value. | TextFieldTextEditor | ||
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. | TextFieldTextEditor | ||
clearInvalidationFlag(flag:String):void
Clears an invalidation flag. | FeathersControl | ||
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 |
Event | Summary | Defined By | ||
---|---|---|---|---|
Dispatched when the text property changes. | TextFieldTextEditor | |||
Dispatched after the component has validated for the first time. | FeathersControl | |||
Dispatched when the user presses the Enter key while the editor has focus. | TextFieldTextEditor | |||
Dispatched when the text editor receives focus. | TextFieldTextEditor | |||
Dispatched when the text editor loses focus. | TextFieldTextEditor | |||
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. | TextFieldTextEditor | |||
Dispatched when the soft keyboard is about to activate. | TextFieldTextEditor | |||
Dispatched when the soft keyboard is deactivated. | TextFieldTextEditor |
alwaysShowSelection | property |
alwaysShowSelection:Boolean
When set to true
and the text field is not in focus,
Flash Player highlights the selection in the text field in gray. When
set to false
and the text field is not in focus, Flash
Player does not highlight the selection in the text field.
In the following example, the selection is always shown:
textEditor.alwaysShowSelection = true;
The default value is false
.
public function get alwaysShowSelection():Boolean
public function set alwaysShowSelection(value:Boolean):void
See also
antiAliasType | property |
antiAliasType:String
The type of anti-aliasing used for this text field, defined as
constants in the flash.text.AntiAliasType
class. You can
control this setting only if the font is embedded (with the
embedFonts
property set to true).
In the following example, the anti-alias type is changed:
textRenderer.antiAliasType = AntiAliasType.NORMAL;
The default value is flash.text.AntiAliasType.ADVANCED
.
public function get antiAliasType():String
public function set antiAliasType(value:String):void
See also
background | property |
background:Boolean
Specifies whether the text field has a background fill. Use the
backgroundColor
property to set the background color of
a text field.
In the following example, the background is enabled:
textRenderer.background = true; textRenderer.backgroundColor = 0xff0000;
The default value is false
.
public function get background():Boolean
public function set background(value:Boolean):void
See also
backgroundColor | property |
backgroundColor:uint
The color of the text field background that is displayed if the
background
property is set to true
.
In the following example, the background color is changed:
textRenderer.background = true; textRenderer.backgroundColor = 0xff000ff;
The default value is 0xffffff
.
public function get backgroundColor():uint
public function set backgroundColor(value:uint):void
See also
baseline | property |
baseline:Number
[read-only] Returns the text baseline measurement, in pixels.
public function get baseline():Number
border | property |
border:Boolean
Specifies whether the text field has a border. Use the
borderColor
property to set the border color.
Note: If border
is set to true
, the
component will behave as if useGutter
is also set to
true
because the border will not render correctly
without the gutter.
In the following example, the border is enabled:
textRenderer.border = true; textRenderer.borderColor = 0xff0000;
The default value is false
.
public function get border():Boolean
public function set border(value:Boolean):void
See also
borderColor | property |
borderColor:uint
The color of the text field border that is displayed if the
border
property is set to true
.
In the following example, the border color is changed:
textRenderer.border = true; textRenderer.borderColor = 0xff00ff;
The default value is 0x000000
.
public function get borderColor():uint
public function set borderColor(value:uint):void
See also
currentTextFormat | property |
currentTextFormat:TextFormat
[read-only]
For debugging purposes, the current
flash.text.TextFormat
used to render the text. Updated
during validation, and may be null
before the first
validation.
Do not modify this value. It is meant for testing and debugging
only. Use the parent's starling.text.TextFormat
font
styles APIs instead.
public function get currentTextFormat():TextFormat
disabledTextFormat | property |
disabledTextFormat:TextFormat
Advanced font formatting used to draw the text when the component is
disabled, if disabledFontStyles
and
starling.text.TextFormat
cannot be used on the parent
component because the full capabilities of
flash.text.TextField
are required.
In the following example, the disabled text format is changed:
Warning: If this property is not
null
, any starling.text.TextFormat
font
styles that are passed in from the parent component may be ignored.
In other words, advanced font styling with
flash.text.TextFormat
will always take precedence.
textEditor.isEnabled = false; textEditor.disabledTextFormat = new TextFormat( "Source Sans Pro" );
The default value is null
.
public function get disabledTextFormat():TextFormat
public function set disabledTextFormat(value:TextFormat):void
See also
displayAsPassword | property |
displayAsPassword:Boolean
This property is managed by the TextInput
.
public function get displayAsPassword():Boolean
public function set displayAsPassword(value:Boolean):void
See also
embedFonts | property |
embedFonts:Boolean
If advanced flash.text.TextFormat
styles are specified,
determines if the TextField should use an embedded font or not. If
the specified font is not embedded, the text may not be displayed at
all.
If the font styles are passed in from the parent component, the
text renderer will automatically detect if a font is embedded or not,
and the embedFonts
property will be ignored if it is set
to false
. Setting it to true
will force the
TextField
to always try to use embedded fonts.
In the following example, the font is embedded:
textEditor.embedFonts = true;
The default value is false
.
public function get embedFonts():Boolean
public function set embedFonts(value:Boolean):void
See also
globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider
for all TextFieldTextEditor
components.
The default value is null
.
See also
gridFitType | property |
gridFitType:String
Determines whether Flash Player forces strong horizontal and vertical
lines to fit to a pixel or subpixel grid, or not at all using the
constants defined in the flash.text.GridFitType
class.
This property applies only if the antiAliasType
property
of the text field is set to flash.text.AntiAliasType.ADVANCED
.
In the following example, the grid fit type is changed:
textRenderer.gridFitType = GridFitType.SUBPIXEL;
The default value is flash.text.GridFitType.PIXEL
.
public function get gridFitType():String
public function set gridFitType(value:String):void
See also
isEditable | property |
isEditable:Boolean
This property is managed by the TextInput
.
In the following example, the text input is not editable:
input.isEditable = false;
public function get isEditable():Boolean
public function set isEditable(value:Boolean):void
See also
isHTML | property |
isHTML:Boolean
Determines if the TextField should display the value of the
text
property as HTML or not.
In the following example, the text is displayed as HTML:
textEditor.isHTML = true;
The default value is false
.
public function get isHTML():Boolean
public function set isHTML(value:Boolean):void
See also
isSelectable | property |
isSelectable:Boolean
This property is managed by the TextInput
.
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;
public function get isSelectable():Boolean
public function set isSelectable(value:Boolean):void
See also
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
.
public function get maintainTouchFocus():Boolean
public function set maintainTouchFocus(value:Boolean):void
maxChars | property |
maxChars:int
This property is managed by the TextInput
.
0
,
any number of characters may be entered.
In the following example, the text input's maximum characters is specified:
input.maxChars = 10;
public function get maxChars():int
public function set maxChars(value:int):void
See also
measureTextField | property |
protected var measureTextField:TextField
The separate text field sub-component used for measurement. Typically, the main text field often doesn't report correct values for a full frame if its dimensions are changed too often.
multiline | property |
multiline:Boolean
Indicates whether field is a multiline text field.
In the following example, multiline is enabled:
textEditor.multiline = true;
The default value is false
.
public function get multiline():Boolean
public function set multiline(value:Boolean):void
See also
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
.
public function get nativeFocus():Object
resetScrollOnFocusOut | property |
resetScrollOnFocusOut:Boolean
Indicates of the text editor resets its current scroll position to 0 on focus out.
In the following example, the scroll position is not reset on focus out:
textEditor.resetScrollOnFocusOut = false;
The default value is true
.
public function get resetScrollOnFocusOut():Boolean
public function set resetScrollOnFocusOut(value:Boolean):void
restrict | property |
restrict:String
This property is managed by the TextInput
.
In the following example, the text input's allowed characters are restricted:
input.restrict = "0-9";
public function get restrict():String
public function set restrict(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. This value will
always be smaller than selectionEndIndex
.
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
.
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
.
public function get setTouchFocusOnEndedPhase():Boolean
sharpness | property |
sharpness:Number
The sharpness of the glyph edges in this text field. This property
applies only if the antiAliasType
property of the text
field is set to flash.text.AntiAliasType.ADVANCED
. The
range for sharpness
is a number from -400
to 400
.
In the following example, the sharpness is changed:
textRenderer.sharpness = 200;
The default value is 0
.
public function get sharpness():Number
public function set sharpness(value:Number):void
See also
softKeyboard | property |
softKeyboard:String
Customizes the soft keyboard that is displayed on a touch screen when the text editor has focus.
In the following example, the soft keyboard type is customized:
textEditor.softKeyboard = SoftKeyboardType.NUMBER;
The default value is flash.text.SoftKeyboardType.DEFAULT
.
public function get softKeyboard():String
public function set softKeyboard(value:String):void
See also
textField | property |
protected var textField:TextField
The text field sub-component.
textFormat | property |
textFormat:TextFormat
Advanced font formatting used to draw the text, if
fontStyles
and starling.text.TextFormat
cannot be used on the parent component because the full capabilities
of flash.text.TextField
are required.
In the following example, the text format is changed:
textEditor.textFormat = new TextFormat( "Source Sans Pro" );;
Warning: If this property is not
null
, any starling.text.TextFormat
font
styles that are passed in from the parent component may be ignored.
In other words, advanced font styling with
flash.text.TextFormat
will always take precedence.
The default value is null
.
public function get textFormat():TextFormat
public function set textFormat(value:TextFormat):void
See also
textSnapshot | property |
protected var textSnapshot:Image
An image that displays a snapshot of the native TextField
in the Starling display list when the editor doesn't have focus.
thickness | property |
thickness:Number
The thickness of the glyph edges in this text field. This property
applies only if the antiAliasType
property is set to
flash.text.AntiAliasType.ADVANCED
. The range for
thickness
is a number from -200
to
200
.
In the following example, the thickness is changed:
textRenderer.thickness = 100;
The default value is 0
.
public function get thickness():Number
public function set thickness(value:Number):void
See also
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
useGutter | property |
useGutter:Boolean
Determines if the 2-pixel gutter around the edges of the
flash.text.TextField
will be used in measurement and
layout. To visually align with other text renderers and text editors,
it is often best to leave the gutter disabled.
Returns true
if the border
property is
true
.
In the following example, the gutter is enabled:
textEditor.useGutter = true;
The default value is false
.
public function get useGutter():Boolean
public function set useGutter(value:Boolean):void
useSnapshotDelayWorkaround | property |
useSnapshotDelayWorkaround:Boolean
Fixes an issue where flash.text.TextField
renders
incorrectly when drawn to BitmapData
by waiting one
frame.
Warning: enabling this workaround may cause slight flickering
after the text
property is changed.
In the following example, the workaround is enabled:
textEditor.useSnapshotDelayWorkaround = true;
The default value is false
.
public function get useSnapshotDelayWorkaround():Boolean
public function set useSnapshotDelayWorkaround(value:Boolean):void
wordWrap | property |
wordWrap:Boolean
Determines if the TextField wraps text to the next line.
In the following example, word wrap is enabled:
textEditor.wordWrap = true;
The default value is false
.
public function get wordWrap():Boolean
public function set wordWrap(value:Boolean):void
See also
TextFieldTextEditor | () | Constructor |
public function TextFieldTextEditor()
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 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.
ReturnsBoolean |
clearFocus | () | method |
public function clearFocus():void
Removes focus from the text editor.
getTextFormatForState | () | method |
public function getTextFormatForState(state:String):TextFormat
Gets the advanced flash.text.TextFormat
font formatting
passed in using setTextFormatForState()
for the
specified state.
If an flash.text.TextFormat
is not defined for a
specific state, returns null
.
Parameters
state:String |
TextFormat |
See also
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 )
|
setTextFormatForState | () | method |
public function setTextFormatForState(state:String, textFormat:TextFormat):void
Sets the advanced flash.text.TextFormat
font formatting
to be used by the text editor when the currentState
property of the stateContext
matches the specified state
value.
If an TextFormat
is not defined for a specific
state, the value of the textFormat
property will be
used instead.
If the disabledTextFormat
property is not
null
and the isEnabled
property is
false
, all other text formats will be ignored.
Parameters
state:String | |
textFormat:TextFormat |
See also
change | Event |
starling.events.Event
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
enter | Event |
starling.events.Event
feathers.events.FeathersEventType.ENTER
Dispatched when the user presses the Enter key while the editor has 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.ENTER
event type is meant to
be used when the enter key has been pressed in an input control.
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.
softKeyboardActivating | Event |
starling.events.Event
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. |
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 |
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.