Packagefeathers.core
Interfacepublic interface ITextRenderer extends IStateObserver, IFeathersControl, ITextBaselineControl, IValidating, IMeasureDisplayObject, IFeathersDisplayObject, IFeathersDisplayObject
Implementors BitmapFontTextRenderer, TextBlockTextRenderer, TextFieldTextRenderer

Interface that handles common capabilities of rendering text.

See also

Introduction to Feathers text renderers


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
 Inheriteddepth : int
[read-only] The component's depth in the display list, relative to the stage.
IValidating
 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
  fontStyles : FontStylesSet
The internal font styles used to render the text that are passed down from the parent component.
ITextRenderer
 Inheritedheight : Number
The height of the display object in the parent's coordinate space.
IFeathersDisplayObject
 InheritedisCreated : Boolean
[read-only] Determines if the component has been initialized and validated for the first time.
IFeathersControl
 InheritedisEnabled : Boolean
Indicates whether the control is interactive or not.
IFeathersControl
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
IFeathersControl
 Inheritedmask : DisplayObject
The display object's mask.
IFeathersDisplayObject
 InheritedmaxHeight : Number
The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
IMeasureDisplayObject
 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
 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
  numLines : int
[read-only] The number of text lines in the text renderer.
ITextRenderer
 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
 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
 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
 InheritedstateContext : IStateContext
IStateObserver
 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
  text : String
The text to render.
ITextRenderer
 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
 Inheritedvisible : Boolean
Determines the visibility of the display object.
IFeathersDisplayObject
 Inheritedwidth : Number
The width of the display object in the parent's coordinate space.
IFeathersDisplayObject
  wordWrap : Boolean
Determines if the text wraps to the next line when it reaches the width (or max width) of the component.
ITextRenderer
 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
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
  
measureText(result:Point = null):Point
Measures the text's bounds (without a full validation, if possible).
ITextRenderer
 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
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single function call.
IFeathersControl
 Inherited
validate():void
Immediately validates the display object, if it is invalid.
IValidating
Property Detail
fontStylesproperty
fontStyles:FontStylesSet

The internal font styles used to render the text that are passed down from the parent component. Generally, most developers will set font styles on the parent component.

Warning: The fontStyles property may be ignored if more advanced styles defined by the text renderer implementation have been set.


Implementation
    public function get fontStyles():FontStylesSet
    public function set fontStyles(value:FontStylesSet):void

See also

numLinesproperty 
numLines:int  [read-only]

The number of text lines in the text renderer. The text renderer may contain multiple text lines if the text contains line breaks or if the wordWrap property is enabled.


Implementation
    public function get numLines():int
textproperty 
text:String

The text to render.

If using the Label component, this property should be set on the Label, and it will be passed down to the text renderer.


Implementation
    public function get text():String
    public function set text(value:String):void
wordWrapproperty 
wordWrap:Boolean

Determines if the text wraps to the next line when it reaches the width (or max width) of the component.

This property is sometimes controlled by the parent component, such as on a Label component. If using the Label component, this property must be set on the Label, and it will be passed down to the text renderer automatically.


Implementation
    public function get wordWrap():Boolean
    public function set wordWrap(value:Boolean):void
Method Detail
measureText()method
public function measureText(result:Point = null):Point

Measures the text's bounds (without a full validation, if possible).

Parameters

result:Point (default = null)

Returns
Point