ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
flashx.textLayout.compose 

TextLineRecycler  - AS3

Packageflashx.textLayout.compose
Classpublic class TextLineRecycler
InheritanceTextLineRecycler Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

The TextLineRecycler class provides support for recycling of TextLines. Some player versions support a recreateTextLine. Passing TextLines to the recycler makes them available for reuse. This improves Player performance.



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  textLineRecyclerEnabled : Boolean
[static] Controls if the TLF recycler enabled.
TextLineRecycler
Public Methods
 MethodDefined By
  
[static] Add a TextLine to the pool for reuse.
TextLineRecycler
  
[static] Return a TextLine from the pool for reuse.
TextLineRecycler
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail

textLineRecyclerEnabled

property
textLineRecyclerEnabled:Boolean

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Controls if the TLF recycler enabled. It can only be enabled in 10.1 or later players.



Implementation
    public static function get textLineRecyclerEnabled():Boolean
    public static function set textLineRecyclerEnabled(value:Boolean):void
Method Detail

addLineForReuse

()method
public static function addLineForReuse(textLine:flash.text.engine:TextLine):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Add a TextLine to the pool for reuse. TextLines for reuse should have null userData and null parent.

Parameters

textLine:flash.text.engine:TextLine

getLineForReuse

()method 
public static function getLineForReuse():flash.text.engine:TextLine

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Return a TextLine from the pool for reuse.

Returns
flash.text.engine:TextLine