Package | feathers.controls.text |
Class | public class BitmapFontTextEditor |
Inheritance | BitmapFontTextEditor BitmapFontTextRenderer BaseTextRenderer FeathersControl starling.display.Sprite |
Implements | ITextEditor, INativeFocusOwner |
Product Version : | Feathers 2.0.0 |
TextInput
component, rendered with
bitmap fonts.
The following example shows how to use
BitmapFontTextEditor
with a TextInput
:
var input:TextInput = new TextInput(); input.textEditorFactory = function():ITextEditor { return new BitmapFontTextEditor(); }; this.addChild( input );
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 | ||
---|---|---|---|
addedEffect : Function
An optional effect that is activated when the component is added to
the stage. | FeathersControl | ||
baseline : Number [read-only]
Returns the text baseline measurement, in pixels. | BitmapFontTextRenderer | ||
breakLongWords : Boolean
If wordWrap is true, determines if words
longer than the width of the text renderer will break in the middle
or if the word will extend outside the edges until it ends. | BitmapFontTextRenderer | ||
currentTextFormat : BitmapFontTextFormat [read-only]
For debugging purposes, the current
feathers.text.BitmapFontTextFormat used to render the
text. | BitmapFontTextRenderer | ||
cursorSkin : DisplayObject
The skin that indicates the current position where text may be
entered. | BitmapFontTextEditor | ||
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 : BitmapFontTextFormat
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 other features of bitmap fonts are required. | BitmapFontTextRenderer | ||
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. | BitmapFontTextEditor | ||
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 | ||
fontStyles : FontStylesSet
The internal font styles used to render the text that are passed down
from the parent component. | BaseTextRenderer | ||
globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all BitmapFontTextEditor
components. | BitmapFontTextEditor | ||
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. | BitmapFontTextEditor | ||
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
This property is managed by the TextInput.
If the isEditable property is set to false,
the isSelectable property determines if the text is
selectable. | BitmapFontTextEditor | ||
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 [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
If true, the display object should remain in focus,
even if something else is touched. | FeathersControl | ||
maxChars : int
This property is managed by the TextInput.
The maximum number of characters that may be entered. | BitmapFontTextEditor | ||
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 | ||
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. | BitmapFontTextEditor | ||
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 | ||
numLines : int [read-only]
The number of text lines in the text renderer. | BitmapFontTextRenderer | ||
passwordCharCode : int
The character code of the character used to display a password. | BitmapFontTextEditor | ||
pixelSnapping : Boolean
Determines if the position of the text should be snapped to the
nearest whole pixel when rendered. | BitmapFontTextRenderer | ||
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. | BitmapFontTextEditor | ||
selectedTextFormat : BitmapFontTextFormat
Advanced font formatting used to draw the text when the
stateContext is disabled, if
selectedFontStyles and
starling.text.TextFormat cannot be used on the parent
component because the other features of bitmap fonts are required. | BitmapFontTextRenderer | ||
selectionBeginIndex : int [read-only]
The index of the first character of the selection. | BitmapFontTextEditor | ||
selectionEndIndex : int [read-only]
The index of the last character of the selection. | BitmapFontTextEditor | ||
selectionSkin : DisplayObject
The skin that indicates the currently selected range of text. | BitmapFontTextEditor | ||
setTouchFocusOnEndedPhase : Boolean [read-only]
Determines if the owner should call setFocus() on
TouchPhase.ENDED or on TouchPhase.BEGAN. | BitmapFontTextEditor | ||
showEffect : Function
An optional effect that is activated when the component is shown. | FeathersControl | ||
stateContext : IStateContext
When the text renderer observes a state context, the text renderer
may change its font styles based on the current state of that
context. | BaseTextRenderer | ||
style : MeshStyle
The style that is used to render the text's mesh. | BitmapFontTextRenderer | ||
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 to render. | BaseTextRenderer | ||
textFormat : BitmapFontTextFormat
Advanced font formatting used to draw the text, if
fontStyles and starling.text.TextFormat
cannot be used on the parent component because the other features of
bitmap fonts are required. | BitmapFontTextRenderer | ||
textureSmoothing : String
A texture smoothing value passed to each character image. | BitmapFontTextRenderer | ||
toolTip : String
Text to display in a tool tip to when hovering over this component,
if the ToolTipManager is enabled. | FeathersControl | ||
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. | BitmapFontTextRenderer | ||
truncationText : String
The text to display at the end of the label if it is truncated. | BitmapFontTextRenderer | ||
useSeparateBatch : Boolean
Determines if the characters are batched normally by Starling or if
they're batched separately. | BitmapFontTextRenderer | ||
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. | BaseTextRenderer |
Method | Defined By | ||
---|---|---|---|
Constructor. | BitmapFontTextEditor | ||
clearFocus():void
Removes focus from the text editor. | BitmapFontTextEditor | ||
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):BitmapFontTextFormat
Gets the advanced BitmapFontTextFormat font formatting
passed in using setTextFormatForState() for the
specified state. | BitmapFontTextRenderer | ||
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). | BitmapFontTextRenderer | ||
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. | BitmapFontTextEditor | ||
setFocus(position:Point = null):void
Gives focus to the text editor. | BitmapFontTextEditor | ||
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:BitmapFontTextFormat):void
Sets the advanced BitmapFontTextFormat font formatting
to be used by the text renderer when the currentState
property of the stateContext matches the specified state
value. | BitmapFontTextRenderer | ||
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 |
Event | Summary | Defined By | ||
---|---|---|---|---|
Dispatched when the text property changes. | BitmapFontTextEditor | |||
Dispatched after the component has validated for the first time. | FeathersControl | |||
Dispatched when the user presses the Enter key while the editor has focus. | BitmapFontTextEditor | |||
Dispatched when the text editor receives focus. | BitmapFontTextEditor | |||
Dispatched when the text editor loses focus. | BitmapFontTextEditor | |||
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 |
cursorSkin | property |
cursorSkin:DisplayObject
The skin that indicates the current position where text may be entered.
public function get cursorSkin():DisplayObject
public function set cursorSkin(value:DisplayObject):void
displayAsPassword | property |
displayAsPassword:Boolean
This property is managed by the TextInput
.
In the following example, the text input's text is displayed as a password:
input.displayAsPassword = true;
public function get displayAsPassword():Boolean
public function set displayAsPassword(value:Boolean):void
See also
globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider
for all BitmapFontTextEditor
components.
The default value is null
.
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
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
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
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
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
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
See also
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
See also
selectionSkin | property |
selectionSkin:DisplayObject
The skin that indicates the currently selected range of text.
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
BitmapFontTextEditor | () | Constructor |
public function BitmapFontTextEditor()
Constructor.
clearFocus | () | method |
public function clearFocus():void
Removes focus from the text editor.
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
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.