| Package | flashx.textLayout.factory |
| Class | public class TextFlowTextLineFactory |
| Inheritance | TextFlowTextLineFactory  TextLineFactoryBase Object |
| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
The text lines are static and created fit in a single bounding rectangle, but can have multiple paragraphs and formats as well as inline graphics. To create TextLine objects directly from a string, use StringTextLineFactory.
Note: When using inline graphics, the source property of the InlineGraphicElement object
must either be an instance of a DisplayObject or a Class object representing an embedded asset.
URLRequest objects cannot be used. The width and height of the inline graphic at the time the line
is created is used to compose the flow.
See also
| Method | Defined By | ||
|---|---|---|---|
Creates a TextFlowTextLineFactory object. | TextFlowTextLineFactory | ||
createTextLines(callback:Function, textFlow:TextFlow):void
Creates TextLine objects from the specified text flow. | TextFlowTextLineFactory | ||
 | getContentBounds():Rectangle
The smallest rectangle in which the layed-out content fits. | TextLineFactoryBase | |
| TextFlowTextLineFactory | () | Constructor |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic function TextFlowTextLineFactory()| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Creates a TextFlowTextLineFactory object.
| createTextLines | () | method |
public function createTextLines(callback:Function, textFlow:TextFlow):void| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Creates TextLine objects from the specified text flow.
The text lines are composed to fit the bounds assigned to the compositionBounds property.
As each line is created, the factory calls the function specified in the
callback parameter. This function is passed the TextLine object and
is responsible for displaying the line. If a line has a background color, the factory also calls the
callback function with a Shape object containing a rectangle of the background color.
Note that the scroll policies of the factory will control how many lines are generated.
Parameters
callback:Function — function to call with each generated TextLine object.
The callback will be called with a Shape object representing any background color (if present),
and with TextLine objects for the text.
| |
textFlow:TextFlow — The TextFlow from which the lines are created.
|