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

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
  contentX : Number
[read-only]
TextFieldTextEditorViewPort
  contentY : Number
[read-only]
TextFieldTextEditorViewPort
 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
The font and styles used to draw the text when the component is disabled.
TextFieldTextEditor
 InheriteddisplayAsPassword : Boolean
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
Determines if the TextField should use an embedded font or not.
TextFieldTextEditor
 InheritedfocusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.
FeathersControl
 InheritedfocusManager : IFocusManager
FeathersControl
 InheritedfocusOwner : IFocusDisplayObject
FeathersControl
 InheritedfocusPadding : Number
Quickly sets all focus padding properties to the same value.
FeathersControl
 InheritedfocusPaddingBottom : Number
The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin.
FeathersControl
 InheritedfocusPaddingLeft : Number
The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin.
FeathersControl
 InheritedfocusPaddingRight : Number
The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin.
FeathersControl
 InheritedfocusPaddingTop : Number
The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin.
FeathersControl
 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
  horizontalScrollPosition : Number
TextFieldTextEditorViewPort
  horizontalScrollStep : Number
[read-only]
TextFieldTextEditorViewPort
 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
Determines if the text input is editable.
TextFieldTextEditor
 InheritedisEnabled : Boolean
Indicates whether the control is interactive or not.
FeathersControl
 InheritedisFocusEnabled : Boolean
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
 InheritedlayoutData : ILayoutData
Extra parameters associated with this display object that will be used by the layout algorithm.
FeathersControl
 InheritedmaxChars : int
The maximum number of characters that the text field can contain, as entered by a user.
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 : 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.
TextFieldTextEditor
 InheritednextTabFocus : IFocusDisplayObject
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
FeathersControl
 Inheritedrestrict : String
Indicates the set of characters that a user can enter into the text field.
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
 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.
TextFieldTextEditor
 InheritedtextFormat : TextFormat
The format of the text, such as font and styles.
TextFieldTextEditor
 Inheritedthickness : Number
The thickness of the glyph edges in this text field.
TextFieldTextEditor
 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
  verticalScrollPosition : Number
TextFieldTextEditorViewPort
  verticalScrollStep : Number
[read-only]
TextFieldTextEditorViewPort
  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
 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 globalStyleProvider property is set to this value.
FeathersControl
 InheritedexplicitHeight : Number = NaN
The height value explicitly set by calling the height setter or setSize().
FeathersControl
 InheritedexplicitWidth : Number = NaN
The width value explicitly set by calling the width setter or setSize().
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
hideFocus():void
If the visual indicator of focus has been displayed by showFocus(), call this function to hide it.
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
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
showFocus():void
If the object has focus, an additional visual indicator may optionally be displayed to highlight the object.
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
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
Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.
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 deactivated.TextFieldTextEditor
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
contentXproperty
contentX:Number  [read-only]


Implementation
    public function get contentX():Number
contentYproperty 
contentY:Number  [read-only]


Implementation
    public function get contentY():Number
horizontalScrollPositionproperty 
horizontalScrollPosition:Number


Implementation
    public function get horizontalScrollPosition():Number
    public function set horizontalScrollPosition(value:Number):void
horizontalScrollStepproperty 
horizontalScrollStep:Number  [read-only]


Implementation
    public function get horizontalScrollStep():Number
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
verticalScrollPositionproperty 
verticalScrollPosition:Number


Implementation
    public function get verticalScrollPosition():Number
    public function set verticalScrollPosition(value:Number):void
verticalScrollStepproperty 
verticalScrollStep:Number  [read-only]


Implementation
    public function get verticalScrollStep():Number
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.