Packageflashx.textLayout.factory
Classpublic class TextLineFactoryBase
InheritanceTextLineFactoryBase Inheritance Object
Subclasses StringTextLineFactory, TextFlowTextLineFactory

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

The TextLineFactoryBase class serves as the base class for the Text Layout Framework text line factories.

Note: Application code does not typically need to create or use a TextLineFactoryBase object directly. Use one of the derived text factory classes instead.

See also

flashx.textLayout.elements.TextFlow


Public Properties
 PropertyDefined By
  compositionBounds : Rectangle
The rectangle within which text lines are created.
TextLineFactoryBase
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  horizontalScrollPolicy : String
Specifies how lines are created when the composition bounds are not large enough.
TextLineFactoryBase
  isTruncated : Boolean
[read-only] Indicates whether text was truncated when lines were last created.
TextLineFactoryBase
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  textLineCreator : flashx.textLayout.compose:ITextLineCreator
The ITextLineCreator instance used to create lines of text.
TextLineFactoryBase
  truncationOptions : flashx.textLayout.factory:TruncationOptions
Specifies the options for truncating the text if it doesn't fit in the composition bounds.
TextLineFactoryBase
  verticalScrollPolicy : String
Specifies how lines are created when the composition bounds are not large enough.
TextLineFactoryBase
Public Methods
 MethodDefined By
  
Base-class constructor for text line factories.
TextLineFactoryBase
  
The smallest rectangle in which the layed-out content fits.
TextLineFactoryBase
 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
compositionBoundsproperty
compositionBounds:Rectangle

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

The rectangle within which text lines are created.



Implementation
    public function get compositionBounds():Rectangle
    public function set compositionBounds(value:Rectangle):void
horizontalScrollPolicyproperty 
horizontalScrollPolicy:String

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

Specifies how lines are created when the composition bounds are not large enough.

If set to ScrollPolicy.ON or ScrollPolicy.AUTO, all lines are created. It is the your responsibility to scroll lines in the viewable area (and to mask lines outside this area, if necessary). If set to ScrollPolicy.OFF, then only lines that fit within the composition bounds are created.

If the truncationOptions property is set, the scroll policy is ignored (and treated as ScrollPolicy.OFF).



Implementation
    public function get horizontalScrollPolicy():String
    public function set horizontalScrollPolicy(value:String):void

See also

isTruncatedproperty 
isTruncated:Boolean  [read-only]

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

Indicates whether text was truncated when lines were last created.



Implementation
    public function get isTruncated():Boolean
textLineCreatorproperty 
textLineCreator:flashx.textLayout.compose:ITextLineCreator

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

The ITextLineCreator instance used to create lines of text.

Applications can provide a custom implementation of ITextLineCreator to use fonts embedded in a different SWF file or to cache and reuse text lines.



Implementation
    public function get textLineCreator():flashx.textLayout.compose:ITextLineCreator
    public function set textLineCreator(value:flashx.textLayout.compose:ITextLineCreator):void

See also

truncationOptionsproperty 
truncationOptions:flashx.textLayout.factory:TruncationOptions

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

Specifies the options for truncating the text if it doesn't fit in the composition bounds.



Implementation
    public function get truncationOptions():flashx.textLayout.factory:TruncationOptions
    public function set truncationOptions(value:flashx.textLayout.factory:TruncationOptions):void
verticalScrollPolicyproperty 
verticalScrollPolicy:String

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

Specifies how lines are created when the composition bounds are not large enough.

If set to ScrollPolicy.ON or ScrollPolicy.AUTO, all lines are created. It is the your responsibility to scroll lines in the viewable area (and to mask lines outside this area, if necessary). If set to ScrollPolicy.OFF, then only lines that fit within the composition bounds are created.

If the truncationOptions property is set, the scroll policy is ignored (and treated as ScrollPolicy.OFF).



Implementation
    public function get verticalScrollPolicy():String
    public function set verticalScrollPolicy(value:String):void

See also

Constructor Detail
TextLineFactoryBase()Constructor
public function TextLineFactoryBase()

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

Base-class constructor for text line factories.

Note: Application code does not typically need to create or use a TextLineFactoryBase object directly. Use one of the derived text factory classes instead.

Method Detail
getContentBounds()method
public function getContentBounds():Rectangle

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

The smallest rectangle in which the layed-out content fits.

Note: Truncated lines are not included in the size calculation.

Returns
Rectangle