| Package | feathers.core |
| Interface | public interface ITextRenderer extends IStateObserver, IFeathersControl, ITextBaselineControl, IValidating, IMeasureDisplayObject, IFeathersDisplayObject, IFeathersDisplayObject |
| Implementors | BitmapFontTextRenderer, TextBlockTextRenderer, TextFieldTextRenderer |
| Product Version : | Feathers 1.0.0 |
See also
| Property | Defined By | ||
|---|---|---|---|
 | alpha : Number
The opacity of the display object. | IFeathersDisplayObject | |
| base : DisplayObject [read-only]
The top-most object of the display tree that the display object is
connected to. | IFeathersDisplayObject | |
| baseline : Number [read-only]
Returns the text baseline measurement, in pixels. | ITextBaselineControl | |
| blendMode : String
The blend mode used when rendering the display object. | IFeathersDisplayObject | |
| bounds : Rectangle [read-only]
The bounds of the display object in its local coordinate space. | IFeathersDisplayObject | |
| depth : int [read-only]
The component's depth in the display list, relative to the stage. | IValidating | |
| effectsSuspended : Boolean [read-only]
Indicates if effects have been suspended. | IFeathersControl | |
| explicitHeight : Number [read-only]
The height value explicitly set by passing a value to the
height setter or by calling the setSize()
function. | IMeasureDisplayObject | |
| explicitMaxHeight : Number [read-only]
The maximum height value explicitly set by passing a value to the
maxHeight setter. | IMeasureDisplayObject | |
| explicitMaxWidth : Number [read-only]
The maximum width value explicitly set by passing a value to the
maxWidth setter. | IMeasureDisplayObject | |
| explicitMinHeight : Number [read-only]
The minimum height value explicitly set by passing a value to the
minHeight setter. | IMeasureDisplayObject | |
| explicitMinWidth : Number [read-only]
The minimum width value explicitly set by passing a value to the
minWidth setter. | IMeasureDisplayObject | |
| explicitWidth : Number [read-only]
The width value explicitly set by passing a value to the
width setter or to the setSize() method. | IMeasureDisplayObject | |
| filter : 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 | ||
| height : Number
The height of the display object in the parent's coordinate space. | IFeathersDisplayObject | |
| isCreated : Boolean [read-only]
Determines if the component has been initialized and validated for
the first time. | IFeathersControl | |
| isEnabled : Boolean
Indicates whether the control is interactive or not. | IFeathersControl | |
| isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | IFeathersControl | |
| mask : DisplayObject
The display object's mask. | IFeathersDisplayObject | |
| maxHeight : Number
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | IMeasureDisplayObject | |
| maxWidth : Number
The maximum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | IMeasureDisplayObject | |
| minHeight : Number
The minimum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | IMeasureDisplayObject | |
| minWidth : Number
The minimum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | IMeasureDisplayObject | |
| name : String
The name of the display object. | IFeathersDisplayObject | |
| numLines : int [read-only]
The number of text lines in the text renderer. | ITextRenderer | ||
| parent : DisplayObjectContainer [read-only]
The display object's parent, or null if it doesn't have
a parent. | IFeathersDisplayObject | |
| pivotX : Number
The x coordinate of the display object's origin in its own coordinate
space. | IFeathersDisplayObject | |
| pivotY : Number
The y coordinate of the display object's origin in its own coordinate
space. | IFeathersDisplayObject | |
| root : DisplayObject [read-only]
| IFeathersDisplayObject | |
| rotation : Number
The rotation of the display object, in radians. | IFeathersDisplayObject | |
| scaleX : Number
This horizontal scale factor. | IFeathersDisplayObject | |
| scaleY : Number
The vertical scale factor. | IFeathersDisplayObject | |
| skewX : Number
The horizontal skew, in radians. | IFeathersDisplayObject | |
| skewY : Number
The vertical skew, in radians. | IFeathersDisplayObject | |
| stage : Stage [read-only]
The stage that the display object is connected to, or null
if it is not connected to a stage. | IFeathersDisplayObject | |
| stateContext : IStateContext
The current state context that is being observed. | IStateObserver | |
| styleName : String
The concatenated styleNameList, with values separated
by spaces. | IFeathersControl | |
| styleNameList : TokenList [read-only]
Contains a list of all "styles" assigned to this control. | IFeathersControl | |
| styleProvider : 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 | ||
| toolTip : String
Text to display in a tool tip to when hovering over this component,
if the ToolTipManager is enabled. | IFeathersControl | |
| touchable : Boolean
Determines if the display object may be touched. | IFeathersDisplayObject | |
| transformationMatrix : Matrix [read-only]
The transformation matrix of the display object, relative to its
parent. | IFeathersDisplayObject | |
| useHandCursor : Boolean
Determines if the mouse cursor should turn into a hand when the mouse
is over the display object. | IFeathersDisplayObject | |
| visible : Boolean
Determines the visibility of the display object. | IFeathersDisplayObject | |
| width : 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 | ||
| x : Number
The x, or horizontal, position of the display object in the parent's
coordinate space. | IFeathersDisplayObject | |
| y : Number
The y, or vertical, position of the display object in the parent's
coordinate space. | IFeathersDisplayObject | |
| Method | Defined By | ||
|---|---|---|---|
| addEventListener(type:String, listener:Function):void
Adds a listener for an event type. | IFeathersEventDispatcher | |
| dispatchEvent(event:Event):void
Dispatches an event to all listeners added for the specified event type. | IFeathersEventDispatcher | |
| 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 | |
| dispose():void
Disposes the display object. | IFeathersDisplayObject | |
| getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle
Gets the display object's bounds in the target coordinate space. | IFeathersDisplayObject | |
| 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 | |
| globalToLocal(globalPoint:Point, resultPoint:Point = null):Point
Converts a point from the stage's coordinate space to the display
object's coordinate space. | IFeathersDisplayObject | |
| hasEventListener(type:String, listener:Function = null):Boolean
Checks if a listener has been added for the specified event type. | IFeathersEventDispatcher | |
| hitTest(localPoint:Point):DisplayObject
Determines if a point exists within the display object's bounds. | IFeathersDisplayObject | |
| initializeNow():void
If the component has not yet initialized, initializes immediately. | IFeathersControl | |
| 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 | ||
| move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single
function call. | IFeathersControl | |
| removeEventListener(type:String, listener:Function):void
Removes a listener for an event type. | IFeathersEventDispatcher | |
| removeEventListeners(type:String = null):void
Removes all listeners for an event type. | IFeathersEventDispatcher | |
| removeFromParent(dispose:Boolean = false):void
Removes a display object from its parent. | IFeathersDisplayObject | |
| render(painter:Painter):void
Renders the display object. | IFeathersDisplayObject | |
| resetStyleProvider():void
Resets the styleProvider property to its default value,
which is usually the global style provider for the component. | IFeathersControl | |
| resumeEffects():void
Indicates that effects should be re-activated after being suspended. | IFeathersControl | |
| setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single
function call. | IFeathersControl | |
| suspendEffects():void
Indicates that effects should not be activated temporarily. | IFeathersControl | |
| validate():void
Immediately validates the display object, if it is invalid. | IValidating | |
| fontStyles | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesfontStyles:FontStylesSetThe 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.
public function get fontStyles():FontStylesSet public function set fontStyles(value:FontStylesSet):voidSee also
| numLines | property |
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.
public function get numLines():int| text | property |
text:StringThe 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.
public function get text():String public function set text(value:String):void| wordWrap | property |
wordWrap:BooleanDetermines 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.
public function get wordWrap():Boolean public function set wordWrap(value:Boolean):void| 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 |