Package | feathers.controls.text |
Class | public class TextBlockTextEditor |
Inheritance | TextBlockTextEditor ![]() ![]() ![]() |
Implements | ITextEditor, INativeFocusOwner |
flash.text.engine.TextBlock
from
Flash Text Engine (FTE) that may be edited at runtime by the user. Draws
the text to BitmapData
to convert to Starling textures.
Textures are completely managed by this component, and they will be
automatically disposed when the component is disposed from the stage.
Warning: This text editor is intended for use in desktop applications only, and it does not provide support for software keyboards on mobile devices.
See also
Property | Defined By | ||
---|---|---|---|
![]() | applyNonLinearFontScaling : Boolean
Specifies that you want to enhance screen appearance at the expense
of what-you-see-is-what-you-get (WYSIWYG) print fidelity. | TextBlockTextRenderer | |
![]() | baseline : Number [read-only]
Returns the text baseline measurement, in pixels. | TextBlockTextRenderer | |
![]() | baselineFontDescription : FontDescription
The font used to determine the baselines for all the lines created from the block, independent of their content. | TextBlockTextRenderer | |
![]() | baselineFontSize : Number
The font size used to calculate the baselines for the lines created
from the block. | TextBlockTextRenderer | |
![]() | baselineZero : String
Specifies which baseline is at y=0 for lines created from this block. | TextBlockTextRenderer | |
![]() | bidiLevel : int
Specifies the bidirectional paragraph embedding level of the text
block. | TextBlockTextRenderer | |
![]() | content : ContentElement
Sets the contents of the TextBlock to a complex value
that is more than simple text. | TextBlockTextRenderer | |
cursorSkin : DisplayObject | TextBlockTextEditor | ||
![]() | 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 | |
![]() | disabledElementFormat : ElementFormat
The font and styles used to draw the text when the component is
disabled. | TextBlockTextRenderer | |
displayAsPassword : Boolean
Indicates whether the text field is a password text field that hides
input characters using a substitute character. | TextBlockTextEditor | ||
![]() | elementFormat : ElementFormat
The font and styles used to draw the text. | TextBlockTextRenderer | |
![]() | 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 | |
![]() | globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all TextBlockTextRenderer
components. | TextBlockTextRenderer | |
![]() | 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. | TextBlockTextEditor | ||
![]() | 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 | |
![]() | leading : Number
The amount of vertical space, in pixels, between lines. | TextBlockTextRenderer | |
![]() | lineRotation : String
Rotates the text lines in the text block as a unit. | TextBlockTextRenderer | |
maxChars : int
Indicates the maximum number of characters that a user can enter into
the text editor. | TextBlockTextEditor | ||
![]() | maxHeight : Number
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | maxTextureDimensions : int
The maximum size of individual textures that are managed by this text
renderer. | TextBlockTextRenderer | |
![]() | 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 | |
![]() | nativeFilters : Array
Native filters to pass to the flash.text.engine.TextLine
instances before creating the texture snapshot. | TextBlockTextRenderer | |
nativeFocus : InteractiveObject [read-only]
A display object on the native stage that is given focus when this
Feathers display object is given focus by a focus manager. | TextBlockTextEditor | ||
![]() | nextTabFocus : IFocusDisplayObject | FeathersControl | |
passwordCharCode : int
The character code of the character used to display a password. | TextBlockTextEditor | ||
![]() | previousTabFocus : IFocusDisplayObject | FeathersControl | |
restrict : String
Restricts the set of characters that a user can enter into the text
field. | TextBlockTextEditor | ||
selectionBeginIndex : int [read-only]
The index of the first character of the selection. | TextBlockTextEditor | ||
selectionEndIndex : int [read-only]
The index of the last character of the selection. | TextBlockTextEditor | ||
selectionSkin : DisplayObject | TextBlockTextEditor | ||
setTouchFocusOnEndedPhase : Boolean [read-only]
Determines if the owner should call setFocus() on
TouchPhase.ENDED or on TouchPhase.BEGAN. | TextBlockTextEditor | ||
![]() | snapToPixels : Boolean
Determines if the text should be snapped to the nearest whole pixel
when rendered. | TextBlockTextRenderer | |
![]() | 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 | |
![]() | tabStops : Vector.<TabStop>
Specifies the tab stops for the text in the text block, in the form
of a Vector of TabStop objects. | TextBlockTextRenderer | |
![]() | text : String
The text to render. | TextBlockTextRenderer | |
![]() | textAlign : String
The alignment of the text. | TextBlockTextRenderer | |
![]() | textJustifier : TextJustifier
Specifies the TextJustifier to use during line creation. | TextBlockTextRenderer | |
![]() | truncateToFit : Boolean
If word wrap is disabled, and the text is longer than the width of
the label, the text may be truncated using truncationText. | TextBlockTextRenderer | |
![]() | truncationText : String
The text to display at the end of the label if it is truncated. | TextBlockTextRenderer | |
![]() | updateSnapshotOnScaleChange : Boolean
Refreshes the texture snapshot every time that the text renderer is
scaled. | TextBlockTextRenderer | |
![]() | userData : *
Provides a way for the application to associate arbitrary data with
the text block. | TextBlockTextRenderer | |
![]() | width : Number [override]
The width of the component, in pixels. | FeathersControl | |
![]() | wordWrap : Boolean
Determines if the text wraps to the next line when it reaches the
width (or max width) of the component. | TextBlockTextRenderer |
Method | Defined By | ||
---|---|---|---|
Constructor. | TextBlockTextEditor | ||
clearFocus():void
Removes focus from the text editor. | TextBlockTextEditor | ||
![]() | 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). | TextBlockTextRenderer | |
![]() | 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. | TextBlockTextEditor | ||
setFocus(position:Point = null):void
Gives focus to the text editor. | TextBlockTextEditor | ||
![]() | 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. | TextBlockTextRenderer | |
![]() | clearInvalidationFlag(flag:String):void
Clears an invalidation flag. | FeathersControl | |
draw():void [override] | TextBlockTextEditor | ||
![]() | 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. | TextBlockTextEditor | |||
![]() | Dispatched after the component has validated for the first time. | FeathersControl | ||
Dispatched when the user presses the Enter key while the editor has focus. | TextBlockTextEditor | |||
Dispatched when the text editor receives focus. | TextBlockTextEditor | |||
Dispatched when the text editor loses focus. | TextBlockTextEditor | |||
![]() | 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 |
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 | |
TEXT_ALIGN_CENTER : String = center [static]
The text will be centered horizontally. | TextBlockTextEditor | ||
TEXT_ALIGN_LEFT : String = left [static]
The text will be positioned to the left edge. | TextBlockTextEditor | ||
TEXT_ALIGN_RIGHT : String = right [static]
The text will be positioned to the right edge. | TextBlockTextEditor |
cursorSkin | property |
cursorSkin:DisplayObject
public function get cursorSkin():DisplayObject
public function set cursorSkin(value:DisplayObject):void
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
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
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
nativeFocus | property |
nativeFocus:InteractiveObject
[read-only] A display object on the native stage that is given focus when this Feathers display object 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
.
public function get nativeFocus():InteractiveObject
passwordCharCode | property |
passwordCharCode:int
The character code of the character used to display a password.
In the following example, the substitute character for passwords is set to a bullet:
textEditor.displayAsPassword = true; textEditor.passwordCharCode = "•".charCodeAt(0);
The default value is 42 (asterisk)
.
public function get passwordCharCode():int
public function set passwordCharCode(value:int):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
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
selectionSkin | property |
selectionSkin:DisplayObject
public function get selectionSkin():DisplayObject
public function set selectionSkin(value:DisplayObject):void
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 false
.
public function get setTouchFocusOnEndedPhase():Boolean
TextBlockTextEditor | () | Constructor |
public function TextBlockTextEditor()
Constructor.
clearFocus | () | method |
public function clearFocus():void
Removes focus from the text editor.
draw | () | method |
override protected function draw():void
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.
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.
TEXT_ALIGN_CENTER | Constant |
public static const TEXT_ALIGN_CENTER:String = center
The text will be centered horizontally.
See also
TEXT_ALIGN_LEFT | Constant |
public static const TEXT_ALIGN_LEFT:String = left
The text will be positioned to the left edge.
See also
TEXT_ALIGN_RIGHT | Constant |
public static const TEXT_ALIGN_RIGHT:String = right
The text will be positioned to the right edge.
See also