Packageflashx.textLayout.conversion
Classpublic class TextConverter
InheritanceTextConverter Inheritance Object

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

This is the gateway class for handling import and export. It serves as a unified access point to the conversion functionality in the Text Layout Framework.

View the examples



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
Public Methods
 MethodDefined By
  
[static] Exports a TextFlow to a specified format.
TextConverter
  
[static] Creates an export filter.
TextConverter
  
[static] Creates an import filter.
TextConverter
 Inherited
Indicates whether an object has a specified property defined.
Object
  
[static] Creates a TextFlow from source content in a specified format.
TextConverter
 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
Public Constants
 ConstantDefined By
  FXG_FORMAT : String = "fxgFormat"
[static] FXG Format.
TextConverter
  HTML_FORMAT : String = "htmlFormat"
[static] HTML format.
TextConverter
  PLAIN_TEXT_FORMAT : String = "plainTextFormat"
[static] Plain text format.
TextConverter
  TEXT_LAYOUT_FORMAT : String = "textLayoutFormat"
[static] TextLayout Format.
TextConverter
Method Detail
export()method
public static function export(source:flashx.textLayout.elements:TextFlow, format:String, conversionType:String):Object

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

Exports a TextFlow to a specified format. Supported formats include FXG, HTML, plain text, and TextLayout Markup.

Use one of the four static constants supplied with this class to specify the format parameter:

Specify the type of the exported data in the conversionType parameter with one of the two static constants supplied by the ConversionType class:

Returns a representation of the TextFlow in the specified format.

Parameters

source:flashx.textLayout.elements:TextFlow — Source content
 
format:String — Output format
 
conversionType:String — Type of exported data

Returns
Object — Object Exported form of the TextFlow

See also

getExporter()method 
public static function getExporter(format:String):flashx.textLayout.conversion:ITextExporter

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

Creates an export filter. Returns an export filter, which you can then use to export from a TextFlow to a source string or XML object. Use this function if you have many separate exports to perform. It is equivalent to calling flashx.textLayout.conversion.TextConverter.export().

Use one of the four static constants supplied with this class to specify the format parameter:

Parameters

format:String — Target format for exported data

Returns
flashx.textLayout.conversion:ITextExporter — ITextExporter Text filter that can export in the specified format

See also


Example  ( How to use this example )

This code snippet shows a use of the getExporter method to perform repeated exports of formatted text.


var markup:String = "<TextFlow xmlns='http://ns.adobe.com/textLayout/2008'><p><span>Hello, World</span></p></TextFlow>";
var tFilter:TextConverter = new TextConverter();
var textFlow:TextFlow = tFilter.importToFlow(markup, TextConverter.TEXT_LAYOUT_FORMAT);
var exporter:ITextImporter = tFilter.getExporter(TextConverter.TEXT_LAYOUT_FORMAT));
var export1:String = exporter.export();
var export2:String = exporter.export();
getImporter()method 
public static function getImporter(format:String, config:IConfiguration = null):flashx.textLayout.conversion:ITextImporter

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

Creates an import filter. Returns an import filter, which you can then use to import from a source string or XML object to a TextFlow. Use this function if you have many separate imports to perform, or if you want to handle errors during import. It is equivalent to calling flashx.textLayout.conversion.TextConverter.importToFlow().

Use one of the four static constants supplied with this class to specify the format parameter:

Parameters

format:String — Format of source content. Use constants from flashx.textLayout.conversion.TextConverter.TEXT_LAYOUT_FORMAT, PLAIN_TEXT_FORMAT, HTML_FORMAT etc.
 
config:IConfiguration (default = null) — configuration to use during this import. null means take the current default.

Returns
flashx.textLayout.conversion:ITextImporter — ITextImporter Text filter that can import the source data

See also


Example  ( How to use this example )

This code snippet shows a use of the getImporter method to perform repeated imports of formatted text. Note that errors are cleared at the beginning of each call to importToFlow.


var markup1:String = "<TextFlow xmlns='http://ns.adobe.com/textLayout/2008'><p><span>Hello, World</span></p></TextFlow>";
var markup2:String = "<TextFlow xmlns='http://ns.adobe.com/textLayout/2008'><p><span>Hello, Again</span></p></TextFlow>";
var tFilter:TextConverter = new TextConverter();
var importer:ITextImporter = tFilter.getImporter(TextConverter.TEXT_LAYOUT_FORMAT);
importer.throwOnError = false;
var textFlow1:TextFlow = importer.importToFlow(markup1);
if(importer.errors) {
    //deal with importing errors
}
var textFlow2:TextFlow = importer.importToFlow(markup2);
if(importer.errors) {
    //deal with importing errors
}
importToFlow()method 
public static function importToFlow(source:Object, format:String, config:IConfiguration = null):flashx.textLayout.elements:TextFlow

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

Creates a TextFlow from source content in a specified format. Supported formats include FXG, HTML, plain text, and TextLayout Markup.

Use one of the four static constants supplied with this class to specify the format parameter:

Parameters

source:Object — Source content
 
format:String — Format of source content
 
config:IConfiguration (default = null) — IConfiguration to use when creating new TextFlows

Returns
flashx.textLayout.elements:TextFlow — TextFlow that was created from the source.

See also

Constant Detail
FXG_FORMATConstant
public static const FXG_FORMAT:String = "fxgFormat"

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

FXG Format. Use the filter for importing from, or exporting to, a TextFlow using FXG (an XML-based graphics interchange format). FXG will detect the following errors:

HTML_FORMATConstant 
public static const HTML_FORMAT:String = "htmlFormat"

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

HTML format. Use this for importing from, or exporting to, a TextFlow using the HTML fomat. The Text Layout Framework HTML supports a subset of the tags and attributes supported by the TextField class in the flash.text package.

The following table lists the HTML tags and attributes supported for the import and export process (tags and attributes supported by TextField, but not supported by the Text Layout Framework are specifically described as not supported):

Tag Description
Anchor tag The <a> tag creates a hypertext link and supports the following attributes:
  • target: Specifies the name of the target window where you load the page. Options include _self, _blank, _parent, and _top. The _self option specifies the current frame in the current window, _blank specifies a new window, _parent specifies the parent of the current frame, and _top specifies the top-level frame in the current window.
  • href: Specifies a URL. The URL can be either absolute or relative to the location of the SWF file that is loading the page. An example of an absolute reference to a URL is http://www.adobe.com; an example of a relative reference is /index.html. Absolute URLs must be prefixed with http://; otherwise, Flash treats them as relative URLs. Note: Unlike the TextField class, ActionScript link events are not supported. Neither are a:link, a:hover, and a:active styles.
Bold tag The <b> tag renders text as bold. A bold typeface must be available for the font used.
Break tag The <br> tag creates a line break in the text field. Set the text field to be a multiline text field to use this tag.
Font tag The <font> tag specifies a font or list of fonts to display the text.The font tag supports the following attributes:
  • color: Only hexadecimal color (#FFFFFF) values are supported.
  • face: Specifies the name of the font to use. As shown in the following example, you can specify a list of comma-delimited font names, in which case Flash Player selects the first available font. If the specified font is not installed on the local computer system or isn't embedded in the SWF file, Flash Player selects a substitute font.
  • size: Specifies the size of the font. You can use absolute pixel sizes, such as 16 or 18. Note: Unlike the TextField class, you cannot use relative point sizes, such as +2 or -4.
Image tag The <img> tag lets you embed external image files (JPEG, GIF, PNG), SWF files, and movie clips inside text fields. Text automatically flows around images you embed in text fields. You must set the text field to be multiline to wrap text around an image.

The <img> tag supports the following attributes:

  • src: Specifies the URL to an image or SWF file, or the linkage identifier for a movie clip symbol in the library. This attribute is required; all other attributes are optional. External files (JPEG, GIF, PNG, and SWF files) do not show until they are downloaded completely.
  • width: The width of the image, SWF file, or movie clip being inserted, in pixels.
  • height: The height of the image, SWF file, or movie clip being inserted, in pixels.
  • align: Specifies the horizontal alignment of the embedded image within the text field. Valid values are left and right. The default value is left.

Note: Unlike the TextField class, the following attributes are not supported: hspace, vspace, id, and checkPolicyFile.

Flash displays media embedded in a text field at full size. To specify the dimensions of the media you are embedding, use the <img> tag height and width attributes.

In general, an image embedded in a text field appears on the line following the <img> tag. However, when the <img> tag is the first character in the text field, the image appears on the first line of the text field.

Italic tag The <i> tag displays the tagged text in italics. An italic typeface must be available for the font used.
List item tag Note: Unlike the TextField class, the List item tag is not supported.
Paragraph tag The <p> tag creates a new paragraph. The text field must be set to be a multiline text field to use this tag. The <p> tag supports the following attributes:
  • align: Specifies alignment of text within the paragraph; valid values are left, right, justify, and center.
  • class: Specifies a class name that can be used for styling
Span tag The <span> tag supports the following attributes:
  • class: Specifies a class name that can be used for styling
Text format tag

The <textformat> tag lets you use a subset of paragraph formatting properties of the TextFormat class within text fields, including line leading, indentation, margins, and tab stops. You can combine <textformat> tags with the built-in HTML tags.

The <textformat> tag has the following attributes:

  • indent: Specifies the indentation from the left margin to the first character in the paragraph; corresponds to TextFormat.indent. Both positive and negative numbers are acceptable.
  • leftmargin: Specifies the left margin of the paragraph, in points; corresponds to TextFormat.leftMargin.
  • rightmargin: Specifies the right margin of the paragraph, in points; corresponds to TextFormat.rightMargin.

Note: Unlike the TextField class, the following attributes are unsupported: blockindent, leading, and tabstops.

Underline tag The <u> tag underlines the tagged text.

PLAIN_TEXT_FORMATConstant 
public static const PLAIN_TEXT_FORMAT:String = "plainTextFormat"

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

Plain text format. Use this for creating a TextFlow from a simple, unformatted String, or for creating a simple, unformatted String from a TextFlow.

TEXT_LAYOUT_FORMATConstant 
public static const TEXT_LAYOUT_FORMAT:String = "textLayoutFormat"

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

TextLayout Format. Use this for importing from, or exporting to, a TextFlow using the TextLayout markup format. Text Layout format will detect the following errors:

Examples (  How to use this example  )
TextConverter_example.as

This example shows a use of the TextConverter conversion class. Text in a standard markup format is imported into a TextFlow object and then displayed. The text is then exported in XML format.

package {
    import flash.display.Sprite;
    import flashx.textLayout.compose.StandardFlowComposer;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.conversion.ConversionType;

    public class TextConverter_example extends Sprite
    {
        public function TextConverter_example()
        {
            var markup:String = "<TextFlow xmlns='http://ns.adobe.com/textLayout/2008'><p><span>Hello, World</span></p></TextFlow>";
            var tConverter:TextConverter = new TextConverter();
            var textFlow:TextFlow = tConverter.importToFlow(markup, TextConverter.TEXT_LAYOUT_FORMAT);
            textFlow.flowComposer.addController(new ContainerController(this, 200, 50));
            textFlow.flowComposer.updateAllContainers();
            //export to XML
            var xmlOut:XML = tConverter.export(textFlow.ConversionType.XML_TYPE);
        }
    }
}