Packagefeathers.controls.text
Interfacepublic interface ITextEditorViewPort extends ITextEditor, IViewPort, IFeathersControl, IFeathersControl, ITextBaselineControl, IValidating, IMeasureDisplayObject
Implementors TextFieldTextEditorViewPort

Product Version : Feathers 1.1.0

Handles the editing of multiline text.

See also

feathers.controls.TextArea


Public Properties
 PropertyDefined By
 Inheritedalpha : Number
The opacity of the display object.
IFeathersDisplayObject
 Inheritedbase : DisplayObject
[read-only] The top-most object of the display tree that the display object is connected to.
IFeathersDisplayObject
 Inheritedbaseline : Number
[read-only] Returns the text baseline measurement, in pixels.
ITextBaselineControl
 InheritedblendMode : String
The blend mode used when rendering the display object.
IFeathersDisplayObject
 Inheritedbounds : Rectangle
[read-only] The bounds of the display object in its local coordinate space.
IFeathersDisplayObject
 InheritedcontentX : Number
[read-only]
IViewPort
 InheritedcontentY : Number
[read-only]
IViewPort
 Inheriteddepth : int
[read-only] The component's depth in the display list, relative to the stage.
IValidating
 InheriteddisplayAsPassword : Boolean
Determines if the entered text will be masked so that it cannot be seen, such as for a password input.
ITextEditor
 InheritedeffectsSuspended : Boolean
[read-only] Indicates if effects have been suspended.
IFeathersControl
 InheritedexplicitHeight : Number
[read-only] The height value explicitly set by passing a value to the height setter or by calling the setSize() function.
IMeasureDisplayObject
 InheritedexplicitMaxHeight : Number
[read-only] The maximum height value explicitly set by passing a value to the maxHeight setter.
IMeasureDisplayObject
 InheritedexplicitMaxWidth : Number
[read-only] The maximum width value explicitly set by passing a value to the maxWidth setter.
IMeasureDisplayObject
 InheritedexplicitMinHeight : Number
[read-only] The minimum height value explicitly set by passing a value to the minHeight setter.
IMeasureDisplayObject
 InheritedexplicitMinWidth : Number
[read-only] The minimum width value explicitly set by passing a value to the minWidth setter.
IMeasureDisplayObject
 InheritedexplicitWidth : Number
[read-only] The width value explicitly set by passing a value to the width setter or to the setSize() method.
IMeasureDisplayObject
 Inheritedfilter : FragmentFilter
The filter used when rendering the display object.
IFeathersDisplayObject
 InheritedfontStyles : FontStylesSet
The internal font styles used to render the text that are passed down from the parent component.
ITextEditor
 Inheritedheight : Number
The height of the display object in the parent's coordinate space.
IFeathersDisplayObject
 InheritedhorizontalScrollPosition : Number
IViewPort
 InheritedhorizontalScrollStep : Number
[read-only]
IViewPort
 InheritedisCreated : Boolean
[read-only] Determines if the component has been initialized and validated for the first time.
IFeathersControl
 InheritedisEditable : Boolean
Determines if the text is editable.
ITextEditor
 InheritedisEnabled : Boolean
Indicates whether the control is interactive or not.
IFeathersControl
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
IFeathersControl
 InheritedisSelectable : Boolean
If the isEditable property is set to false, the isSelectable property determines if the text is selectable.
ITextEditor
 Inheritedmask : DisplayObject
The display object's mask.
IFeathersDisplayObject
 InheritedmaxChars : int
The maximum number of characters that may be entered.
ITextEditor
 InheritedmaxHeight : Number
The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
IMeasureDisplayObject
 InheritedmaxVisibleHeight : Number
IViewPort
 InheritedmaxVisibleWidth : Number
IViewPort
 InheritedmaxWidth : Number
The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
IMeasureDisplayObject
 InheritedminHeight : Number
The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
IMeasureDisplayObject
 InheritedminVisibleHeight : Number
IViewPort
 InheritedminVisibleWidth : Number
IViewPort
 InheritedminWidth : Number
The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
IMeasureDisplayObject
 Inheritedname : String
The name of the display object.
IFeathersDisplayObject
  paddingBottom : Number
The padding between the bottom edge of the viewport and the text.
ITextEditorViewPort
  paddingLeft : Number
The padding between the left edge of the viewport and the text.
ITextEditorViewPort
  paddingRight : Number
The padding between the right edge of the viewport and the text.
ITextEditorViewPort
  paddingTop : Number
The padding between the top edge of the viewport and the text.
ITextEditorViewPort
 Inheritedparent : DisplayObjectContainer
[read-only] The display object's parent, or null if it doesn't have a parent.
IFeathersDisplayObject
 InheritedpivotX : Number
The x coordinate of the display object's origin in its own coordinate space.
IFeathersDisplayObject
 InheritedpivotY : Number
The y coordinate of the display object's origin in its own coordinate space.
IFeathersDisplayObject
 InheritedrequiresMeasurementOnScroll : Boolean
[read-only]
IViewPort
 Inheritedrestrict : String
Limits the set of characters that may be entered.
ITextEditor
 Inheritedroot : DisplayObject
[read-only]
IFeathersDisplayObject
 Inheritedrotation : Number
The rotation of the display object, in radians.
IFeathersDisplayObject
 InheritedscaleX : Number
This horizontal scale factor.
IFeathersDisplayObject
 InheritedscaleY : Number
The vertical scale factor.
IFeathersDisplayObject
 InheritedselectionBeginIndex : int
[read-only] The index of the first character of the selection.
ITextEditor
 InheritedselectionEndIndex : int
[read-only] The index of the last character of the selection.
ITextEditor
 InheritedsetTouchFocusOnEndedPhase : Boolean
[read-only] Determines if the owner should call setFocus() on TouchPhase.ENDED or on TouchPhase.BEGAN.
ITextEditor
 InheritedskewX : Number
The horizontal skew, in radians.
IFeathersDisplayObject
 InheritedskewY : Number
The vertical skew, in radians.
IFeathersDisplayObject
 Inheritedstage : Stage
[read-only] The stage that the display object is connected to, or null if it is not connected to a stage.
IFeathersDisplayObject
 InheritedstyleName : String
The concatenated styleNameList, with values separated by spaces.
IFeathersControl
 InheritedstyleNameList : TokenList
[read-only] Contains a list of all "styles" assigned to this control.
IFeathersControl
 InheritedstyleProvider : IStyleProvider
When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.
IFeathersControl
 Inheritedtext : String
The text displayed by the editor.
ITextEditor
 InheritedtoolTip : String
Text to display in a tool tip to when hovering over this component, if the ToolTipManager is enabled.
IFeathersControl
 Inheritedtouchable : Boolean
Determines if the display object may be touched.
IFeathersDisplayObject
 InheritedtransformationMatrix : Matrix
[read-only] The transformation matrix of the display object, relative to its parent.
IFeathersDisplayObject
 InheriteduseHandCursor : Boolean
Determines if the mouse cursor should turn into a hand when the mouse is over the display object.
IFeathersDisplayObject
 InheritedverticalScrollPosition : Number
IViewPort
 InheritedverticalScrollStep : Number
[read-only]
IViewPort
 Inheritedvisible : Boolean
Determines the visibility of the display object.
IFeathersDisplayObject
 InheritedvisibleHeight : Number
IViewPort
 InheritedvisibleWidth : Number
IViewPort
 Inheritedwidth : Number
The width of the display object in the parent's coordinate space.
IFeathersDisplayObject
 Inheritedx : Number
The x, or horizontal, position of the display object in the parent's coordinate space.
IFeathersDisplayObject
 Inheritedy : Number
The y, or vertical, position of the display object in the parent's coordinate space.
IFeathersDisplayObject
Public Methods
 MethodDefined By
 Inherited
addEventListener(type:String, listener:Function):void
Adds a listener for an event type.
IFeathersEventDispatcher
 Inherited
clearFocus():void
Removes focus from the text editor.
ITextEditor
 Inherited
dispatchEvent(event:Event):void
Dispatches an event to all listeners added for the specified event type.
IFeathersEventDispatcher
 Inherited
dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void
Dispatches an event from the pool with the specified to all listeners for the specified event type.
IFeathersEventDispatcher
 Inherited
dispose():void
Disposes the display object.
IFeathersDisplayObject
 Inherited
getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle
Gets the display object's bounds in the target coordinate space.
IFeathersDisplayObject
 Inherited
getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix
Calculates a transformation matrix to convert values from the display object's coordinate space to a target coordinate space.
IFeathersDisplayObject
 Inherited
globalToLocal(globalPoint:Point, resultPoint:Point = null):Point
Converts a point from the stage's coordinate space to the display object's coordinate space.
IFeathersDisplayObject
 Inherited
hasEventListener(type:String, listener:Function = null):Boolean
Checks if a listener has been added for the specified event type.
IFeathersEventDispatcher
 Inherited
hitTest(localPoint:Point):DisplayObject
Determines if a point exists within the display object's bounds.
IFeathersDisplayObject
 Inherited
If the component has not yet initialized, initializes immediately.
IFeathersControl
 Inherited
localToGlobal(localPoint:Point, resultPoint:Point = null):Point
Converts a point from the display object's coordinate space to the stage's coordinate space.
IFeathersDisplayObject
 Inherited
measureText(result:Point = null):Point
Measures the text's bounds (without a full validation, if possible).
ITextEditor
 Inherited
move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single function call.
IFeathersControl
 Inherited
removeEventListener(type:String, listener:Function):void
Removes a listener for an event type.
IFeathersEventDispatcher
 Inherited
removeEventListeners(type:String = null):void
Removes all listeners for an event type.
IFeathersEventDispatcher
 Inherited
removeFromParent(dispose:Boolean = false):void
Removes a display object from its parent.
IFeathersDisplayObject
 Inherited
render(painter:Painter):void
Renders the display object.
IFeathersDisplayObject
 Inherited
Resets the styleProvider property to its default value, which is usually the global style provider for the component.
IFeathersControl
 Inherited
Indicates that effects should be re-activated after being suspended.
IFeathersControl
 Inherited
selectRange(startIndex:int, endIndex:int):void
Sets the range of selected characters.
ITextEditor
 Inherited
setFocus(position:Point = null):void
Gives focus to the text editor.
ITextEditor
 Inherited
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single function call.
IFeathersControl
 Inherited
Indicates that effects should not be activated temporarily.
IFeathersControl
 Inherited
validate():void
Immediately validates the display object, if it is invalid.
IValidating
Property Detail
paddingBottomproperty
paddingBottom:Number

The padding between the bottom edge of the viewport and the text.


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

The padding between the left edge of the viewport and the text.


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

The padding between the right edge of the viewport and the text.


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

The padding between the top edge of the viewport and the text.


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