Packagefeathers.controls.text
Classpublic class TextFieldTextEditorViewPort
InheritanceTextFieldTextEditorViewPort Inheritance TextFieldTextEditor Inheritance BaseTextEditor Inheritance FeathersControl Inheritance starling.display.Sprite
Implements ITextEditorViewPort

Product Version : Feathers 1.1.0

A text editor view port for the TextArea component that uses flash.text.TextField.

See also

feathers.controls.TextArea


Public Properties
 PropertyDefined By
 InheritedalwaysShowSelection : 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
 InheritedantiAliasType : String
The type of anti-aliasing used for this text field, defined as constants in the flash.text.AntiAliasType class.
TextFieldTextEditor
 Inheritedbackground : Boolean
Specifies whether the text field has a background fill.
TextFieldTextEditor
 InheritedbackgroundColor : uint
The color of the text field background that is displayed if the background property is set to true.
TextFieldTextEditor
 Inheritedbaseline : Number
[read-only] Returns the text baseline measurement, in pixels.
TextFieldTextEditor
 Inheritedborder : Boolean
Specifies whether the text field has a border.
TextFieldTextEditor
 InheritedborderColor : uint
The color of the text field border that is displayed if the border property is set to true.
TextFieldTextEditor
 InheritedcurrentTextFormat : TextFormat
[read-only] For debugging purposes, the current flash.text.TextFormat used to render the text.
TextFieldTextEditor
 InheriteddefaultTextEditorFactory : Function
[static] A function used by all UI controls that support text editor to create an ITextEditor instance.
FeathersControl
 InheriteddefaultTextRendererFactory : Function
[static] A function used by all UI controls that support text renderers to create an ITextRenderer instance.
FeathersControl
 Inheriteddepth : int
[read-only] The component's depth in the display list, relative to the stage.
FeathersControl
 InheriteddisabledTextFormat : 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
 InheriteddisplayAsPassword : 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
 InheritedembedFonts : Boolean
If advanced flash.text.TextFormat styles are specified, determines if the TextField should use an embedded font or not.
TextFieldTextEditor
 InheritedexplicitHeight : Number
[read-only] The height value explicitly set by passing a value to the height setter or by calling the setSize() function.
FeathersControl
 InheritedexplicitMaxHeight : Number
[read-only] The maximum height value explicitly set by passing a value to the maxHeight setter.
FeathersControl
 InheritedexplicitMaxWidth : Number
[read-only] The maximum width value explicitly set by passing a value to the maxWidth setter.
FeathersControl
 InheritedexplicitMinHeight : Number
[read-only] The minimum height value explicitly set by passing a value to the minHeight setter.
FeathersControl
 InheritedexplicitMinWidth : Number
[read-only] The minimum width value explicitly set by passing a value to the minWidth setter.
FeathersControl
 InheritedexplicitWidth : Number
[read-only] The width value explicitly set by passing a value to the width setter or to the setSize() method.
FeathersControl
 InheritedfocusManager : 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
 InheritedfocusOwner : 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
 InheritedfontStyles : 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
 InheritedgridFitType : 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
 Inheritedheight : Number
[override] The height of the component, in pixels.
FeathersControl
 InheritedincludeInLayout : Boolean
Determines if the ILayout should use this object or ignore it.
FeathersControl
 InheritedisCreated : Boolean
[read-only] Determines if the component has been initialized and validated for the first time.
FeathersControl
 InheritedisEditable : Boolean
This property is managed by the TextInput. Determines if the text input is editable.
TextFieldTextEditor
 InheritedisEnabled : Boolean
Indicates whether the control is interactive or not.
FeathersControl
 InheritedisFocusEnabled : 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
 InheritedisHTML : Boolean
Determines if the TextField should display the value of the text property as HTML or not.
TextFieldTextEditor
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
FeathersControl
 InheritedisQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list.
FeathersControl
 InheritedisSelectable : 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
 InheritedisShowingFocus : 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
 InheritedlayoutData : ILayoutData
Extra parameters associated with this display object that will be used by the layout algorithm.
FeathersControl
 InheritedmaintainTouchFocus : Boolean
[override] If enabled, the text editor will remain in focus, even if something else is touched.
TextFieldTextEditor
 InheritedmaxChars : int
This property is managed by the TextInput. The maximum number of characters that may be entered.
TextFieldTextEditor
 InheritedmaxHeight : 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
 InheritedmaxWidth : Number
The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminHeight : Number
The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded.
FeathersControl
 InheritedminTouchWidth : 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
 InheritedminWidth : Number
The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 Inheritedmultiline : Boolean
Indicates whether field is a multiline text field.
TextFieldTextEditor
 InheritednativeFocus : 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
 InheritednextDownFocus : 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
 InheritednextLeftFocus : 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
 InheritednextRightFocus : 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
 InheritednextTabFocus : 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
 InheritednextUpFocus : 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
 InheritedpreviousTabFocus : 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
 Inheritedrestrict : String
This property is managed by the TextInput. Limits the set of characters that may be entered.
TextFieldTextEditor
 InheritedselectionBeginIndex : int
[read-only] The index of the first character of the selection.
TextFieldTextEditor
 InheritedselectionEndIndex : int
[read-only] The index of the last character of the selection.
TextFieldTextEditor
 InheritedsetTouchFocusOnEndedPhase : Boolean
[read-only] Determines if the owner should call setFocus() on TouchPhase.ENDED or on TouchPhase.BEGAN.
TextFieldTextEditor
 Inheritedsharpness : Number
The sharpness of the glyph edges in this text field.
TextFieldTextEditor
 InheritedstateContext : 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
 InheritedstyleName : String
The concatenated styleNameList, with values separated by spaces.
FeathersControl
 InheritedstyleNameList : TokenList
[read-only] Contains a list of all "styles" assigned to this control.
FeathersControl
 InheritedstyleProvider : IStyleProvider
When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.
FeathersControl
 Inheritedtext : String
The text displayed by the editor.
BaseTextEditor
 InheritedtextFormat : 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
 Inheritedthickness : Number
The thickness of the glyph edges in this text field.
TextFieldTextEditor
 InheritedtoolTip : String
Text to display in a tool tip to when hovering over this component, if the ToolTipManager is enabled.
FeathersControl
 InheritedupdateSnapshotOnScaleChange : Boolean
Refreshes the texture snapshot every time that the text editor is scaled.
TextFieldTextEditor
 InheriteduseGutter : Boolean
Determines if the 2-pixel gutter around the edges of the flash.text.TextField will be used in measurement and layout.
TextFieldTextEditor
 InheriteduseSnapshotDelayWorkaround : 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
 Inheritedwidth : Number
[override] The width of the component, in pixels.
FeathersControl
 InheritedwordWrap : Boolean
Determines if the TextField wraps text to the next line.
TextFieldTextEditor
Protected Properties
 PropertyDefined By
 InheritedactualHeight : Number = 0
The final height value that should be used for layout.
FeathersControl
 InheritedactualMinHeight : Number = 0
The final minimum height value that should be used for layout.
FeathersControl
 InheritedactualMinWidth : Number = 0
The final minimum width value that should be used for layout.
FeathersControl
 InheritedactualWidth : Number = 0
The final width value that should be used for layout.
FeathersControl
 InheriteddefaultStyleProvider : IStyleProvider
[read-only] When the FeathersControl constructor is called, the styleProvider property is set to this value.
FeathersControl
 InheritedmeasureTextField : TextField
The separate text field sub-component used for measurement.
TextFieldTextEditor
 InheritedtextField : TextField
The text field sub-component.
TextFieldTextEditor
 InheritedtextSnapshot : Image
An image that displays a snapshot of the native TextField in the Starling display list when the editor doesn't have focus.
TextFieldTextEditor
Public Methods
 MethodDefined By
  
Constructor.
TextFieldTextEditorViewPort
 Inherited
clearFocus():void
Removes focus from the text editor.
TextFieldTextEditor
 Inherited
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
 Inherited
getTextFormatForState(state:String):TextFormat
Gets the advanced flash.text.TextFormat font formatting passed in using setTextFormatForState() for the specified state.
TextFieldTextEditor
 Inherited
hideFocus():void
The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.
FeathersControl
 Inherited
If the component has not yet initialized, initializes immediately.
FeathersControl
 Inherited
invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending.
FeathersControl
 Inherited
isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not.
FeathersControl
 Inherited
measureText(result:Point = null):Point
Measures the text's bounds (without a full validation, if possible).
TextFieldTextEditor
 Inherited
move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single function call.
FeathersControl
 Inherited
Resets the styleProvider property to its default value, which is usually the global style provider for the component.
FeathersControl
 Inherited
selectRange(beginIndex:int, endIndex:int):void
Sets the range of selected characters.
TextFieldTextEditor
 Inherited
setFocus(position:Point = null):void
Gives focus to the text editor.
TextFieldTextEditor
 Inherited
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single function call.
FeathersControl
 Inherited
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
 Inherited
showFocus():void
The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.
FeathersControl
 Inherited
validate():void
Immediately validates the display object, if it is invalid.
FeathersControl
Protected Methods
 MethodDefined By
 Inherited
If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself.
TextFieldTextEditor
 Inherited
clearInvalidationFlag(flag:String):void
Clears an invalidation flag.
FeathersControl
 Inherited
draw():void
Override to customize layout and to adjust properties of children.
FeathersControl
 Inherited
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
 Inherited
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
 Inherited
The next style that is set will not be restricted.
FeathersControl
 Inherited
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
 Inherited
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
 Inherited
Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.
FeathersControl
 Inherited
saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean
Saves the dimensions and minimum dimensions calculated for the component.
FeathersControl
 Inherited
setInvalidationFlag(flag:String):void
Sets an invalidation flag.
FeathersControl
 Inherited
setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of invalidating or not.
FeathersControl
Events
 Event Summary Defined By
 InheritedDispatched when the text property changes.TextFieldTextEditor
 InheritedDispatched after the component has validated for the first time.FeathersControl
 InheritedDispatched when the user presses the Enter key while the editor has focus.TextFieldTextEditor
 InheritedDispatched when the text editor receives focus.TextFieldTextEditor
 InheritedDispatched when the text editor loses focus.TextFieldTextEditor
 InheritedDispatched after initialize() has been called, but before the first time that draw() has been called.FeathersControl
 InheritedDispatched when the width or height of the control changes.FeathersControl
 InheritedDispatched when the soft keyboard is activated.TextFieldTextEditor
 InheritedDispatched when the soft keyboard is about to activate.TextFieldTextEditor
 InheritedDispatched when the soft keyboard is deactivated.TextFieldTextEditor
Styles
 StyleDefined By
 Inherited
focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.
FeathersControl
 Inherited
focusPadding : Number
Quickly sets all focus padding properties to the same value.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin.
FeathersControl
Public Constants
 ConstantDefined By
 InheritedINVALIDATION_FLAG_ALL : String = "all"
[static] Flag to indicate that everything is invalid and should be redrawn.
FeathersControl
 InheritedINVALIDATION_FLAG_DATA : String = "data"
[static] Invalidation flag to indicate that the primary data displayed by the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_FOCUS : String = "focus"
[static] Invalidation flag to indicate that the focus of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_LAYOUT : String = "layout"
[static] Invalidation flag to indicate that the layout of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SCROLL : String = "scroll"
[static] Invalidation flag to indicate that the scroll position of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SELECTED : String = "selected"
[static] Invalidation flag to indicate that the selection of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SIZE : String = "size"
[static] Invalidation flag to indicate that the dimensions of the UI control have changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SKIN : String = "skin"
[static] Invalidation flag to indicate that the skin of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STATE : String = "state"
[static] Invalidation flag to indicate that the state has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STYLES : String = "styles"
[static] Invalidation flag to indicate that the styles or visual appearance of the UI control has changed.
FeathersControl
Property Detail
globalStyleProviderproperty
public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all TextFieldTextEditorViewPort components.

The default value is null.

See also

maxVisibleHeightproperty 
maxVisibleHeight:Number


Implementation
    public function get maxVisibleHeight():Number
    public function set maxVisibleHeight(value:Number):void
maxVisibleWidthproperty 
maxVisibleWidth:Number


Implementation
    public function get maxVisibleWidth():Number
    public function set maxVisibleWidth(value:Number):void
minVisibleHeightproperty 
minVisibleHeight:Number


Implementation
    public function get minVisibleHeight():Number
    public function set minVisibleHeight(value:Number):void
minVisibleWidthproperty 
minVisibleWidth:Number


Implementation
    public function get minVisibleWidth():Number
    public function set minVisibleWidth(value:Number):void
paddingproperty 
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.


Implementation
    public function get padding():Number
    public function set padding(value:Number):void

See also

paddingBottomproperty 
paddingBottom:Number

The minimum space, in pixels, between the view port's bottom edge and the view port's content.

The default value is 0.


Implementation
    public function get paddingBottom():Number
    public function set paddingBottom(value:Number):void
paddingLeftproperty 
paddingLeft:Number

The minimum space, in pixels, between the view port's left edge and the view port's content.

The default value is 0.


Implementation
    public function get paddingLeft():Number
    public function set paddingLeft(value:Number):void
paddingRightproperty 
paddingRight:Number

The minimum space, in pixels, between the view port's right edge and the view port's content.

The default value is 0.


Implementation
    public function get paddingRight():Number
    public function set paddingRight(value:Number):void
paddingTopproperty 
paddingTop:Number

The minimum space, in pixels, between the view port's top edge and the view port's content.

The default value is 0.


Implementation
    public function get paddingTop():Number
    public function set paddingTop(value:Number):void
visibleHeightproperty 
visibleHeight:Number


Implementation
    public function get visibleHeight():Number
    public function set visibleHeight(value:Number):void
visibleWidthproperty 
visibleWidth:Number


Implementation
    public function get visibleWidth():Number
    public function set visibleWidth(value:Number):void
Constructor Detail
TextFieldTextEditorViewPort()Constructor
public function TextFieldTextEditorViewPort()

Constructor.