flashx.textLayout.factoryTruncationOptions The TruncationOptions class specifies options for limiting the number of lines of text created by a text line factory and for indicating when lines have been left out.Object The TruncationOptions class specifies options for limiting the number of lines of text created by a text line factory and for indicating when lines have been left out. TruncationOptions Creates a TruncationOptions object.truncationIndicatorunknownthe string used to indicate that text has been truncated. It appears at the end of the composed text. The default value is the horizontal ellipsis (U+2026). lineCountLimitunknownspecifies a truncation criterion in the form of the maximum number of lines allowed. The default value of NO_LINE_COUNT_LIMIT indicates that there is no line count limit. truncationIndicatorFormatflashx.textLayout.formats:ITextLayoutFormatnullspecifies the format for the truncation indicator. A null format (the default value) specifies that the truncation indicator assume the format of content just before the truncation point. The TextLineFactory methods that take a simple string as input also ignore this parameter and implement the default behavior. Creates a TruncationOptions object. HORIZONTAL_ELLIPSIS Defines the truncationIndicator property value, \u2026, that represents a horizontal ellipsis.… Defines the truncationIndicator property value, \u2026, that represents a horizontal ellipsis. truncationIndicatorNO_LINE_COUNT_LIMIT Defines the lineCountLimit property value, -1, that represents no limit.-1 Defines the lineCountLimit property value, -1, that represents no limit. lineCountLimitlineCountLimit The maximum number of lines to create. The maximum number of lines to create. truncationIndicatorFormat The style applied to the truncation indicator string.flashx.textLayout.formats:ITextLayoutFormat The style applied to the truncation indicator string. truncationIndicator A string used to indicate that content could not be fully displayed because of limits on the number of lines. A string used to indicate that content could not be fully displayed because of limits on the number of lines. StringTextLineFactory The StringTextLineFactory class provides a simple way to create TextLines from a string.flashx.textLayout.factory:TextLineFactoryBase The StringTextLineFactory class provides a simple way to create TextLines from a string.

The text lines are static and are created using a single format and a single paragraph. The lines are created to fit in the specified bounding rectangle.

The StringTextLineFactory provides an efficient way to create TextLines, since it reuses single TextFlow, ParagraphElement, SpanElement, and ContainerController objects across many repeated invocations. You can create a single factory, and use it again and again. You can also reuse all the parts that are the same each time you call it; for instance, you can reuse the various formats and the bounds.

Note: To create static lines that use multiple formats or paragraphs, or that include inline graphics, use a TextFlowTextLineFactory and a TextFlow object.

TextFlowTextLineFactoryStringTextLineFactory Creates a StringTextLineFactory object.configurationflashx.textLayout.elements:IConfigurationnullThe configuration object used to set the properties of the internal TextFlow object used to compose lines produced by this factory. Creates a StringTextLineFactory object. createTextLines Creates TextLine objects using the text currently assigned to this factory object.callbackThe callback function called for each TextLine object created. Creates TextLine objects using the text currently assigned to this factory object.

The text lines are created using the currently assigned text and formats and 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.

To create a different set of lines, change any properties desired and call createTextLines() again.

Note that the scroll policies of the factory will control how many lines are generated.

configuration The configuration used by the internal TextFlow object.flashx.textLayout.elements:IConfiguration The configuration used by the internal TextFlow object. defaultConfiguration The default configuration used by this factory if none is specified.flashx.textLayout.elements:IConfiguration The default configuration used by this factory if none is specified. paragraphFormat The paragraph format.flashx.textLayout.formats:ITextLayoutFormat The paragraph format. spanFormat The character format.flashx.textLayout.formats:ITextLayoutFormat The character format. textFlowFormat The text flow format.flashx.textLayout.formats:ITextLayoutFormat The text flow format. text The text to convert into TextLine objects. The text to convert into TextLine objects.

To produce TextLines, call createTextLines() after setting this text property and the desired formats.

TextLineFactoryBase The TextLineFactoryBase class serves as the base class for the Text Layout Framework text line factories.Object 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.

flashx.textLayout.elements.TextFlowTextLineFactoryBase Base-class constructor for text line factories. 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.

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

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

compositionBounds The rectangle within which text lines are created. The rectangle within which text lines are created. horizontalScrollPolicy Specifies how lines are created when the composition bounds are not large enough. 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).

flashx.textLayout.compose.StandardFlowComposerflashx.textLayout.container.ScrollPolicytruncationOptionsisTruncated Indicates whether text was truncated when lines were last created. Indicates whether text was truncated when lines were last created. swfContext The ISWFContext instance used to make FTE calls as needed.flashx.textLayout.compose:ISWFContext The ISWFContext instance used to make FTE calls as needed.

By default, the ISWFContext implementation is this FlowComposerBase object. Applications can provide a custom implementation to use fonts embedded in a different SWF file or to cache and reuse text lines.

flashx.textLayout.compose.ISWFContexttruncationOptions Specifies the options for truncating the text if it doesn't fit in the composition bounds.flashx.textLayout.factory:TruncationOptions Specifies the options for truncating the text if it doesn't fit in the composition bounds. verticalScrollPolicy Specifies how lines are created when the composition bounds are not large enough. 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).

flashx.textLayout.compose.StandardFlowComposerflashx.textLayout.container.ScrollPolicytruncationOptionsTextFlowTextLineFactory The TextFlowTextLineFactory class provides a simple way to create TextLines for displaying text from a text flow.flashx.textLayout.factory:TextLineFactoryBase The TextFlowTextLineFactory class provides a simple way to create TextLines for displaying text from a text flow.

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.

TextFlowStringTextLineFactoryTextFlowTextLineFactory Creates a TextFlowTextLineFactory object. Creates a TextFlowTextLineFactory object. createTextLines Creates TextLine objects from the specified text flow.callbackfunction 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. textFlowflashx.textLayout.elements:TextFlowThe TextFlow from which the lines are created. 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.