| Package | feathers.controls.text |
| Class | public class TextFieldTextRenderer |
| Inheritance | TextFieldTextRenderer  FeathersControl Sprite DisplayObjectContainer DisplayObject EventDispatcher Object |
| Implements | ITextRenderer |
flash.text.TextField.
See also
| Property | Defined By | ||
|---|---|---|---|
 | alpha : Number The opacity of the object. | DisplayObject | |
| antiAliasType : String
Same as the TextField property with the same name. | TextFieldTextRenderer | ||
| background : Boolean
Same as the TextField property with the same name. | TextFieldTextRenderer | ||
| backgroundColor : uint
Same as the TextField property with the same name. | TextFieldTextRenderer | ||
| base : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject | |
| baseline : Number [read-only]
The baseline measurement of the text. | TextFieldTextRenderer | ||
| blendMode : String The blend mode determines how the object is blended with the objects underneath. | DisplayObject | |
| border : Boolean
Same as the TextField property with the same name. | TextFieldTextRenderer | ||
| borderColor : uint
Same as the TextField property with the same name. | TextFieldTextRenderer | ||
| bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject | |
| clipRect : Rectangle [override] | FeathersControl | |
| condenseWhite : Boolean
Same as the TextField property with the same name. | TextFieldTextRenderer | ||
| 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 | |
| displayAsPassword : Boolean
Same as the TextField property with the same name. | TextFieldTextRenderer | ||
| embedFonts : Boolean
Determines if the TextField should use an embedded font or not. | TextFieldTextRenderer | ||
| filter : FragmentFilter The filter that is attached to the display object. | DisplayObject | |
| focusManager : IFocusManager
The current focus manager for this component. | FeathersControl | |
| gridFitType : String
Same as the TextField property with the same name. | TextFieldTextRenderer | ||
| hasVisibleArea : Boolean [read-only] Indicates if an object occupies any visible area. | DisplayObject | |
| height : Number [override]
The height of the component, in pixels. | FeathersControl | |
| includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
| isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
| isFlattened : Boolean [read-only] Indicates if the sprite was flattened. | Sprite | |
| isFocusEnabled : Boolean
Determines if this component can receive focus. | FeathersControl | |
| isHTML : Boolean
Determines if the TextField should display the text as HTML or not. | TextFieldTextRenderer | ||
| isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
| isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
| layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
| 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 | |
| name : String [override]
The concatenated nameList, with each name separated by
spaces. | FeathersControl | |
| nameList : TokenList [read-only]
Contains a list of all "names" assigned to this control. | FeathersControl | |
| nextTabFocus : IFocusDisplayObject
The next object that will receive focus when the tab key is pressed. | FeathersControl | |
| numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer | |
| parent : DisplayObjectContainer [read-only] The display object container that contains this display object. | DisplayObject | |
| pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| root : DisplayObject [read-only] The root object the display object is connected to (i.e. | DisplayObject | |
| rotation : Number The rotation of the object in radians. | DisplayObject | |
| scaleX : Number The horizontal scale factor. | DisplayObject | |
| scaleY : Number The vertical scale factor. | DisplayObject | |
| sharpness : Number
Same as the TextField property with the same name. | TextFieldTextRenderer | ||
| skewX : Number The horizontal skew angle in radians. | DisplayObject | |
| skewY : Number The vertical skew angle in radians. | DisplayObject | |
| snapToPixels : Boolean
Determines if the text should be snapped to the nearest whole pixel
when rendered. | TextFieldTextRenderer | ||
| stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected
to the stage. | DisplayObject | |
| styleSheet : StyleSheet
The StyleSheet object to pass to the TextField. | TextFieldTextRenderer | ||
| text : String
The text to render. | TextFieldTextRenderer | ||
| textFormat : TextFormat
The font and styles used to draw the text. | TextFieldTextRenderer | ||
| thickness : Number
Same as the TextField property with the same name. | TextFieldTextRenderer | ||
| touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject | |
| transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject | |
| useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite. | DisplayObject | |
| visible : Boolean The visibility of the object. | DisplayObject | |
| width : Number [override]
The width of the component, in pixels. | FeathersControl | |
| wordWrap : Boolean
Determines if the TextField wraps text to the next line. | TextFieldTextRenderer | ||
| x : Number The x coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| y : Number The y coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | TextFieldTextRenderer | ||
| Adds a child to the container. | DisplayObjectContainer | |
| Adds a child to the container at a certain index. | DisplayObjectContainer | |
| addEventListener(type:String, listener:Function):void [override] | DisplayObject | |
| alignPivot(hAlign:String = center, vAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system
of the object. | DisplayObject | |
| broadcastEvent(event:Event):void Dispatches an event on all children (recursively). | DisplayObjectContainer | |
| broadcastEventWith(type:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively). | DisplayObjectContainer | |
| contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively). | DisplayObjectContainer | |
| dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher | |
| dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered
listeners for the given type. | EventDispatcher | |
| dispose():void [override] Disposes the resources of all children. | Sprite | |
| flatten():void Optimizes the sprite for optimal rendering performance. | Sprite | |
| getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Returns a rectangle that completely encloses the object as it appears in another
coordinate system. | Sprite | |
| getChildAt(index:int):DisplayObject Returns a child object at a certain index. | DisplayObjectContainer | |
| getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively). | DisplayObjectContainer | |
| getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found. | DisplayObjectContainer | |
| getClipRect(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle Returns the bounds of the container's clipRect in the given coordinate space, or
null if the sprite doens't have a clipRect. | Sprite | |
| getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
| globalToLocal(globalPoint:Point, resultPoint:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
| hasEventListener(type:String):Boolean Returns if there are listeners registered for a certain event type. | EventDispatcher | |
| hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil if
the test fails. | Sprite | |
| 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 | |
| localToGlobal(localPoint:Point, resultPoint:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
measureText(result:Point = null):Point
Measures the text's bounds (without a full validation, if
possible). | TextFieldTextRenderer | ||
| Removes a child from the container. | DisplayObjectContainer | |
| removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index. | DisplayObjectContainer | |
| removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included). | DisplayObjectContainer | |
| removeEventListener(type:String, listener:Function):void [override] | DisplayObject | |
| removeEventListeners(type:String = null):void [override] | DisplayObject | |
| removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject | |
| render(support:RenderSupport, parentAlpha:Number):void [override] Renders the display object with the help of a support object. | Sprite | |
| setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer | |
| setSize(width:Number, height:Number):void
Sets both the width and the height of the control. | FeathersControl | |
| sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function
of the Vector class). | DisplayObjectContainer | |
| Swaps the indexes of two children. | DisplayObjectContainer | |
| swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer | |
| unflatten():void Removes the rendering optimizations that were created when flattening the sprite. | Sprite | |
| validate():void
Immediately validates the control, which triggers a redraw, if one
is pending. | FeathersControl | |
| antiAliasType | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesantiAliasType:StringSame as the TextField property with the same name.
public function get antiAliasType():String public function set antiAliasType(value:String):voidSee also
| background | property |
background:BooleanSame as the TextField property with the same name.
public function get background():Boolean public function set background(value:Boolean):voidSee also
| backgroundColor | property |
backgroundColor:uintSame as the TextField property with the same name.
public function get backgroundColor():uint public function set backgroundColor(value:uint):voidSee also
| baseline | property |
baseline:Number [read-only] The baseline measurement of the text.
public function get baseline():Number| border | property |
border:BooleanSame as the TextField property with the same name.
public function get border():Boolean public function set border(value:Boolean):voidSee also
| borderColor | property |
borderColor:uintSame as the TextField property with the same name.
public function get borderColor():uint public function set borderColor(value:uint):voidSee also
| condenseWhite | property |
condenseWhite:BooleanSame as the TextField property with the same name.
public function get condenseWhite():Boolean public function set condenseWhite(value:Boolean):voidSee also
| displayAsPassword | property |
displayAsPassword:BooleanSame as the TextField property with the same name.
public function get displayAsPassword():Boolean public function set displayAsPassword(value:Boolean):voidSee also
| embedFonts | property |
embedFonts:BooleanDetermines if the TextField should use an embedded font or not.
public function get embedFonts():Boolean public function set embedFonts(value:Boolean):void| gridFitType | property |
gridFitType:StringSame as the TextField property with the same name.
public function get gridFitType():String public function set gridFitType(value:String):voidSee also
| isHTML | property |
isHTML:BooleanDetermines if the TextField should display the text as HTML or not.
public function get isHTML():Boolean public function set isHTML(value:Boolean):voidSee also
| sharpness | property |
sharpness:NumberSame as the TextField property with the same name.
public function get sharpness():Number public function set sharpness(value:Number):voidSee also
| snapToPixels | property |
snapToPixels:Boolean
Determines if the text should be snapped to the nearest whole pixel
when rendered. When this is false, text may be displayed
on sub-pixels, which often results in blurred rendering.
public function get snapToPixels():Boolean public function set snapToPixels(value:Boolean):void| styleSheet | property |
styleSheet:StyleSheet
The StyleSheet object to pass to the TextField.
public function get styleSheet():StyleSheet public function set styleSheet(value:StyleSheet):voidSee also
| text | property |
text:StringThe text to render.
public function get text():String public function set text(value:String):void| textFormat | property |
textFormat:TextFormatThe font and styles used to draw the text.
public function get textFormat():TextFormat public function set textFormat(value:TextFormat):voidSee also
| thickness | property |
thickness:NumberSame as the TextField property with the same name.
public function get thickness():Number public function set thickness(value:Number):voidSee also
| wordWrap | property |
wordWrap:BooleanDetermines if the TextField wraps text to the next line.
public function get wordWrap():Boolean public function set wordWrap(value:Boolean):void| TextFieldTextRenderer | () | Constructor |
public function TextFieldTextRenderer()Constructor.
| measureText | () | method |
public function measureText(result:Point = null):PointMeasures the text's bounds (without a full validation, if possible).
Parameters
result:Point (default = null) |
Point |