| Package | feathers.controls.text |
| Class | public class TextFieldTextEditorViewPort |
| Inheritance | TextFieldTextEditorViewPort  TextFieldTextEditor BaseTextEditor FeathersControl starling.display.Sprite |
| Implements | ITextEditorViewPort |
| Product Version : | Feathers 1.1.0 |
TextArea component that uses
flash.text.TextField.
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 TextFieldTextEditorViewPort
components. | TextFieldTextEditorViewPort | ||
| 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 | |
| maxVisibleHeight : Number | TextFieldTextEditorViewPort | ||
| maxVisibleWidth : Number | TextFieldTextEditorViewPort | ||
| 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 | |
| minVisibleHeight : Number | TextFieldTextEditorViewPort | ||
| minVisibleWidth : Number | TextFieldTextEditorViewPort | ||
| 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 | |
| padding : Number
Quickly sets all padding properties to the same value. | TextFieldTextEditorViewPort | ||
| paddingBottom : Number
The minimum space, in pixels, between the view port's bottom edge and
the view port's content. | TextFieldTextEditorViewPort | ||
| paddingLeft : Number
The minimum space, in pixels, between the view port's left edge and
the view port's content. | TextFieldTextEditorViewPort | ||
| paddingRight : Number
The minimum space, in pixels, between the view port's right edge and
the view port's content. | TextFieldTextEditorViewPort | ||
| paddingTop : Number
The minimum space, in pixels, between the view port's top edge and
the view port's content. | TextFieldTextEditorViewPort | ||
| 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 | |
| visibleHeight : Number | TextFieldTextEditorViewPort | ||
| visibleWidth : Number | TextFieldTextEditorViewPort | ||
| width : Number [override]
The width of the component, in pixels. | FeathersControl | |
| wordWrap : Boolean
Determines if the TextField wraps text to the next line. | TextFieldTextEditor | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | TextFieldTextEditorViewPort | ||
| 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 | |
| globalStyleProvider | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic static var globalStyleProvider:IStyleProvider
The default IStyleProvider for all TextFieldTextEditorViewPort
components.
The default value is null.
See also
| maxVisibleHeight | property |
maxVisibleHeight:Number public function get maxVisibleHeight():Number public function set maxVisibleHeight(value:Number):void| maxVisibleWidth | property |
maxVisibleWidth:Number public function get maxVisibleWidth():Number public function set maxVisibleWidth(value:Number):void| minVisibleHeight | property |
minVisibleHeight:Number public function get minVisibleHeight():Number public function set minVisibleHeight(value:Number):void| minVisibleWidth | property |
minVisibleWidth:Number public function get minVisibleWidth():Number public function set minVisibleWidth(value:Number):void| padding | property |
padding:Number
Quickly sets all padding properties to the same value. The
padding getter always returns the value of
paddingTop, but the other padding values may be
different.
The default value is 0.
public function get padding():Number public function set padding(value:Number):voidSee also
| paddingBottom | property |
paddingBottom:NumberThe minimum space, in pixels, between the view port's bottom edge and the view port's content.
The default value is 0.
public function get paddingBottom():Number public function set paddingBottom(value:Number):void| paddingLeft | property |
paddingLeft:NumberThe minimum space, in pixels, between the view port's left edge and the view port's content.
The default value is 0.
public function get paddingLeft():Number public function set paddingLeft(value:Number):void| paddingRight | property |
paddingRight:NumberThe minimum space, in pixels, between the view port's right edge and the view port's content.
The default value is 0.
public function get paddingRight():Number public function set paddingRight(value:Number):void| paddingTop | property |
paddingTop:NumberThe minimum space, in pixels, between the view port's top edge and the view port's content.
The default value is 0.
public function get paddingTop():Number public function set paddingTop(value:Number):void| visibleHeight | property |
visibleHeight:Number public function get visibleHeight():Number public function set visibleHeight(value:Number):void| visibleWidth | property |
visibleWidth:Number public function get visibleWidth():Number public function set visibleWidth(value:Number):void| TextFieldTextEditorViewPort | () | Constructor |
public function TextFieldTextEditorViewPort()Constructor.