The Text Layout Framework API Reference is a reference manual for the application programming interfaces (APIs) for the Text Layout Framework. The Text Layout Framework requires Flash® Player 10 or later.
This reference includes the API reference for Flash Player and Adobe AIR®.
Where possible, new AIR-specific items have been indicated by this small icon next to their names:
.
For introductory white papers on the Text Layout Framework, see the following documents:
The Text Layout Framework API comprises three components with APIs spread across ten packages.
All of the packages are subpackages of the flashx.textLayout package. The components
are related to the packages in the following way:
flashx.textLayout.elements package.
Text composition and container APIs are in the flashx.textLayout.compose and
flashx.textLayout.container packages. Text formatting APIs are in the
flashx.textLayout.formats
package. For display of small static runs of text that do not require containers, this component also
contains a TextLine factory API in the flashx.textLayout.factory package.flashx.textLayout.conversion package.flashx.textLayout.edit and flashx.textLayout.operations packages.The remaining two packages house APIs that cut across multiple components. The flashx.textLayout.events package
contains event handling APIs, whereas the flashx.textLayout.utils package contains utility classes.
The APIs for the Flash CS4 TextLayout Component, which is based on the Text Layout Framework, can be
found in the TextLayout class. The TextLayout class is in the fl.controls package.
This API reference contains only the classes in the fl package that are necessary for
the TextLayout component.
The commenting system is active only on the flashx.textLayout packages and the fl.controls.TextLayout class.