flashx.textLayout.conversionIPlainTextExporter This interface should be implemented by converters that export plain text.flashx.textLayout.conversion:ITextExporter This interface should be implemented by converters that export plain text. Clients that have explicitly created an exporter using TextConverter.getExporter may control the export process by calling into these methods on the exporter. paragraphSeparator Specifies the character sequence used (in a text flow's plain-text equivalent) to separate paragraphs. Specifies the character sequence used (in a text flow's plain-text equivalent) to separate paragraphs. The paragraph separator is not added after the last paragraph.

This property applies to the PLAIN_TEXT_FORMAT exporter.

The default value is "\n".

stripDiscretionaryHyphens This property indicates whether discretionary hyphens in the text should be stripped during the export process. This property indicates whether discretionary hyphens in the text should be stripped during the export process. Discretionary hyphens, also known as "soft hyphens", indicate where to break a word in case the word must be split between two lines. The Unicode character for discretionary hyphens is \u00AD.

If this property is set to true, discretionary hyphens that are in the original text will not be in the exported text, even if they are part of the original text. If false, discretionary hyphens will be in the exported text.

TextConverter This is the gateway class for handling import and export.Object 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. It contains a registry for predefined as well as user defined input and/or output converters, plus a set of conversion methods.

The format of the converted data is not predefined; user written converters are free to accept and return any format of their choice. Common formats are strings, XML, and ByteArray instances. Converter authors should document which formats are supported.

addFormatAt Register a new format for import/export, at the specified location.index The import converter class to register or null format The export converter class to register or null importerClass The format string tagging the converter classes exporterClassnullThe string used as the clipboard format when converting to/from the clipboard. Make this null if the format doesn't support clipboard access. clipboardFormatnull Register a new format for import/export, at the specified location. Location can be significant for clients that have multiple choices for which format to use, such as when importing from the external clipboard. Lower numbers indicate higher priority; these converters will be tried first. The new format may support importing and/or exporting. If the format has already been added, then it will be present in multiple locations. The first one found will be used. addFormat Register a new format for import/export.format The import converter class to register or null importerClass The export converter class to register or null exporterClass The format string tagging the converter classes. Formats can be any name, but must be unique. clipboardFormatThe string used as the clipboard format when converting to/from the clipboard. Make this null if the format doesn't support clipboard access. Register a new format for import/export. The new format will be added at the end, as the lowest priority. Location can be significant for clients that have multiple choices for which format to use, such as when importing from the external clipboard. The new format may support importing and/or exporting. If the format has already been added, then it will be present in multiple locations. The first one found will be used. export Exports a TextFlow to a specified format.Object Exported form of the TextFlow, or null on errors sourceflashx.textLayout.elements:TextFlowSource content formatOutput format conversionTypeType of exported data Exports a TextFlow to a specified format.

Use one of the static constants supplied with this class, a MIME type, or a user defined format for user defined exporters to specify the format parameter:

  • TextConverter.TEXT_FIELD_HTML_FORMAT
  • TextConverter.PLAIN_TEXT_FORMAT
  • TextConverter.TEXT_LAYOUT_FORMAT

Specify the type of the exported data in the conversionType parameter with one of the static constants supplied by the ConversionType class, or a user defined data type for user defined exporters:

  • ConversionType.STRING_TYPE
  • ConversionType.XML_TYPE

Returns a representation of the TextFlow in the specified format, or null on errors. TEXT_FIELD_HTML_FORMATPLAIN_TEXT_FORMATTEXT_LAYOUT_FORMATflashx.textLayout.conversion.ConversionTypegetExporter Creates and returns an export converter, which you can then use to export from a TextFlow to a source string or XML object.ITextExporter Text exporter that can export in the specified format flashx.textLayout.conversion:ITextExporterformatTarget format for exported data Creates and returns an export converter, 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 static constants supplied with this class to specify the format parameter:

  • TextConverter.TEXT_FIELD_HTML_FORMAT
  • TextConverter.PLAIN_TEXT_FORMAT
  • TextConverter.TEXT_LAYOUT_FORMAT

If the format has been added multiple times, the first one found will be used.

TEXT_FIELD_HTML_FORMATPLAIN_TEXT_FORMATTEXT_LAYOUT_FORMATgetFormatAt Returns the format name for the index'th format.index Returns the format name for the index'th format. getFormatDescriptorAt Returns the FormatDescriptor for the index'th format.flashx.textLayout.conversion:FormatDescriptorindex Returns the FormatDescriptor for the index'th format. getImporter Creates and returns an import converter, which you can then use to import from a source string, an XML object, or any user defined data formats to a TextFlow.ITextImporter Text importer that can import the source data flashx.textLayout.conversion:ITextImporterformatFormat of source content. Use constants from flashx.textLayout.conversion.TextConverter.TEXT_LAYOUT_FORMAT, PLAIN_TEXT_FORMAT, TEXT_FIELD_HTML_FORMAT etc, a MIME type, or a user defined format. configflashx.textLayout.elements:IConfigurationnull configuration to use during this import. null means take the current default. You can also set the configuration via the ITextImporter.configuration property. Creates and returns an import converter, which you can then use to import from a source string, an XML object, or any user defined data formats to a TextFlow. Use this method 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 static constants supplied with this class to specify the format parameter, a MIME type, or a user defined data format.

  • TextConverter.TEXT_FIELD_HTML_FORMAT
  • TextConverter.PLAIN_TEXT_FORMAT
  • TextConverter.TEXT_LAYOUT_FORMAT

If the format has been added multiple times, the first one found will be used.

TEXT_FIELD_HTML_FORMATPLAIN_TEXT_FORMATTEXT_LAYOUT_FORMATimportToFlow Creates a TextFlow from source content in a specified format.TextFlow that was created from the source, or null on errors. flashx.textLayout.elements:TextFlowsourceSource content formatFormat of source content configflashx.textLayout.elements:IConfigurationnull IConfiguration to use when creating new TextFlows Creates a TextFlow from source content in a specified format.

Use one of the static constants supplied with this class, a MIME type, to specify the format parameter, or use a user defined value for user-registered importers:

  • TextConverter.TEXT_FIELD_HTML_FORMAT
  • TextConverter.PLAIN_TEXT_FORMAT
  • TextConverter.TEXT_LAYOUT_FORMAT

TEXT_FIELD_HTML_FORMATPLAIN_TEXT_FORMATTEXT_LAYOUT_FORMATremoveFormatAt Remove the format at the index location.index The format to remove Remove the format at the index location. removeFormat Remove the format.format The converter format string to remove Remove the format. If a format was added multiple times, only the first one found is removed. PLAIN_TEXT_FORMAT Plain text format.plainTextFormat 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_FIELD_HTML_FORMAT HTML format.textFieldHTMLFormat 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. 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 or relative point sizes, such as +2 or -4.
  • letterspacing: Specifies the tracking (manual kerning) in pixels to be applied to the right of each character.
  • kerning: Specifies whether kerning is enabled or disabled. A non-zero value enables kerning, while zero disables it.
Image tag The <img> tag lets you embed external image files (JPEG, GIF, PNG), SWF files, and movie clips inside text.

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.

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

 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 <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. While span tags are often used to set a style defined in a style sheet, TLFTextField instances do not support style sheets. The span tag is available for TLFTextField instances to refer to a class with style properties.
  • You can also put properties directly in the span tag: <span fontFamily="Arial">Hi there</span>. However, nested span tags are not supported.
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.
  • blockindent: Specifies the indentation applied to all lines of the paragraph.
  • 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.
  • leading: Specifies the leading (line height) measured in pixels between a line's ascent and the previous line's descent
  • tabstops: Specifies a comma-separated list of tab stop positions for the paragraph.
Underline tag The <u> tag underlines the tagged text.

When an unknown tag is imported the textFieldHTMLFormat importer will either set a single FlowElement's typeName property to that tag name or create a DivElement or a SubParagraphGroupElement with its typeName property set to the tag name.

The textFieldHTMLFormat exporter will export typeName as the XML tag when it is different from the default.

flashx.textLayout.elements.FlowElement.typeNameTEXT_LAYOUT_FORMAT TextLayout Format.textLayoutFormat 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:
  • Unexpected namespace
  • Unknown element
  • Unknown attribute
numFormats Number of formats. Number of formats. ITextLayoutImporter This interface should be implemented by converters that import TextLayout structured data.flashx.textLayout.conversion:ITextImporter This interface should be implemented by converters that import TextLayout structured data. Clients that have explicitly created an importer using TextConverter.getImporter may control the import process by calling into these methods on the importer. imageSourceResolveFunction This property allows specification of a function to modify the source property supplied to an &lt;img&gt; element. This property allows specification of a function to modify the source property supplied to an <img> element. Sample use would be to modify relative paths to some caller specified root path. The function takes the string set in the markup and returns the actual string to be used.

Note that by default relative paths are relative to the loaded SWF. One use of this function is to make relative paths relative to some other location.

The resolver function should look like this:

function resolver(src:String):String

It takes as an input parameter the value of src on the incoming img element, and returns the adjusted value.

ITextImporter Interface for importing text content into a TextFlow from an external source. Interface for importing text content into a TextFlow from an external source. The TextConverter class creates importers with no constructor arguments. flashx.textLayout.elements.TextFlowimportToFlow Import text content from an external source and convert it into a TextFlow.TextFlow Created from the source. flashx.textLayout.elements:TextFlowsource The data to convert. Import text content from an external source and convert it into a TextFlow. configuration The configuration property contains the IConfiguration instance that the importer needs when creating new TextFlow instances.flashx.textLayout.elements:IConfiguration The configuration property contains the IConfiguration instance that the importer needs when creating new TextFlow instances. This property is initially set to null. flashx.textLayout.elements.TextFlowerrors This property contains a vector of error messages as strings after a call to an importer method is the throwOnError property is set to false, which is the default. This property contains a vector of error messages as strings after a call to an importer method is the throwOnError property is set to false, which is the default. If there were no errors, the property returns null. The property is reset on each method call. throwOnError The throwOnError property controls how the importer handles errors. The throwOnError property controls how the importer handles errors. If set to true, methods throw an Error instance on errors. If set to false, which is the default, errors are collected into a vector of strings and stored in the errors property, and the importer does not throw. useClipboardAnnotations Controls whether or not the importer should handle the extra information necessary for the clipboard. Controls whether or not the importer should handle the extra information necessary for the clipboard. When data comes in from the clipboard, it might contain partial paragraphs; paragraphs that are missing the terminator or newline character. If useClipboardAnnotations is true, the importer marks these partial paragraphs with a ConverterBase.MERGE_TO_NEXT_ON_PASTE attribute. This causes the paste operation to correctly handle merging of the pasted paragraph (and any list or div elements that may include the paragraph) into the text. flashx.textLayout.conversion.ConverterBase.MERGE_TO_NEXT_ON_PASTEPlainTextExporter Export converter for plain text format.flashx.textLayout.conversion:IPlainTextExporterflashx.textLayout.conversion:ConverterBase Export converter for plain text format. This class provides an alternative to the TextConverter.export() static method for exporting plain text. The PlainTextExporter class's export() method results in the same output string as the TextConverter.export() static method if the two properties of the PlainTextExporter class, the PARAGRAPH_SEPARATOR_PROPERTY and the STRIP_DISCRETIONARY_HYPHENS_PROPERTY properties, contain their default values of "\n" and true, respectively. PlainTextExporter Constructor Constructor export Object The exported content sourceflashx.textLayout.elements:TextFlowThe TextFlow to export conversionType Return a String (STRING_TYPE) or XML (XML_TYPE), or any user defined format. paragraphSeparator stripDiscretionaryHyphens IHTMLImporter This interface should be implemented by converters that import HTML or HTML-structured data.flashx.textLayout.conversion:ITextImporter This interface should be implemented by converters that import HTML or HTML-structured data. Clients that have explicitly created an importer using TextConverter.getImporter may control the import process by calling into these methods on the importer. imageSourceResolveFunction This property allows specification of a function to modify the source property supplied to an &lt;img&gt; element. This property allows specification of a function to modify the source property supplied to an <img> element. Sample use would be to modify relative paths to some caller specified root path. The function takes the string set in the markup and returns the actual string to be used.

Note that by default relative paths are relative to the loaded SWF. One use of this function is to make relative paths relative to some other location.

The resolver function should look like this:

function resolver(src:String):String

It takes as an input parameter the value of src on the incoming img element, and returns the adjusted value.

preserveBodyElement This property tells the importer to create an element for the BODY tag in HTML markup. This property tells the importer to create an element for the BODY tag in HTML markup.

The element will normally be a DivElement with typeName set to BODY.

This will also trigger parsing of class and id on the element.

preserveHTMLElement This property tells the importer to create an element for the HTML tag in HTML markup. This property tells the importer to create an element for the HTML tag in HTML markup.

The element will normally be the top-level TextFlow element with typeName set to HTML.

This will also trigger parsing of class and id on the element.

ConversionType Values for the format of exported text.Object Values for the format of exported text. The values STRING_TYPE and XML_TYPE can be used for the conversionType parameter for the export() method in the ITextExporter interface and the TextConverter class. flashx.textLayout.conversion.ITextExporter.export()flashx.textLayout.conversion.TextConverter.export()STRING_TYPE Export as type String.stringType Export as type String. XML_TYPE Export as type XML.xmlType Export as type XML. ITextExporter Interface for exporting text content from a TextFlow instance to a given format, which may for example be String or XML format, or a user-defined format. Interface for exporting text content from a TextFlow instance to a given format, which may for example be String or XML format, or a user-defined format. Exporters support the getting and setting of properties to control the export of data. These properties are implemented as public properties, but the direct access of these properties should be avoided, since a user might replace the converter class in the TextConverter registry, causing a downcast to fail. export Export text content from a TextFlow instance in String, or XML, or a user defined format.Object The exported content sourceflashx.textLayout.elements:TextFlowThe TextFlow to export conversionType Return a String (STRING_TYPE) or XML (XML_TYPE), or any user defined format. Export text content from a TextFlow instance in String, or XML, or a user defined format.

Set the conversionType parameter to either of the following values, or a user defined format in user-defined exporters.

  • flashx.textLayout.conversion.ConversionType.STRING_TYPE;
  • flashx.textLayout.conversion.ConversionType.XML_TYPE.

flashx.textLayout.conversion.ConversionTypeerrors This property contains a vector of error messages as strings after a call to an exporter method is the throwOnError property is set to false, which is the default. This property contains a vector of error messages as strings after a call to an exporter method is the throwOnError property is set to false, which is the default. If there were no errors, the property returns null. The property is reset on each method call. throwOnError The throwOnError property controls how the exporter handles errors. The throwOnError property controls how the exporter handles errors. If set to true, methods throw an Error instance on errors. If set to false, which is the default, errors are collected into a vector of strings and stored in the errors property, and the exporter does not throw. useClipboardAnnotations The useClipboardAnnotations property controls whether or not the importer should handle the extra information necessary for the clipboard. The useClipboardAnnotations property controls whether or not the importer should handle the extra information necessary for the clipboard. When data is in a TextFlow, paragraphs are always complete, and include a terminator character. When a range of text is pasted to the clipboard, it will form paragraphs, but the range may not include in the final terminator. In this case, the paragraph needs to be marked as a partial paragraph if it is intended for the clipboard, so that if it is later pasted it will merge into the new text correctly. If the content is intended for the clipboard, useClipboardAnnotations will be true. FormatDescriptor Contains information about a format.Object Contains information about a format. FormatDescriptor Constructor formatimporterClassexporterClassclipboardFormat Constructor clipboardFormat Descriptor used when matching this format to the formats posted on the external clipboard. Descriptor used when matching this format to the formats posted on the external clipboard. If the format supports importing, (it's importerClass is not null), it will be called when pasting from the clipboard, if the clipboard contents include data in this format. If the format supports exporting, it will be called when copying to the clipboard, and the output it creates will be posted to the clipboard with this clipboardFormat. flash.desktop.Clipboardflash.desktop.ClipboardFormatsexporterClass Returns the class used for converting to the format. Returns the class used for converting to the format. format Returns the data format used by the converter Returns the data format used by the converter importerClass Returns the class used for converting data from the format. Returns the class used for converting data from the format. ConverterBase This is a base class for importers as well as exporters.Object This is a base class for importers as well as exporters. It implements the error handling plus property getters and setters that generate an error when invoked. MERGE_TO_NEXT_ON_PASTE A converter that converts clipboard data into a TextFlow should use the MERGE_TO_NEXT_ON_PASTE property to control how the elements are treated when they are merged into an existing TextFlow on paste.mergeToNextOnPaste A converter that converts clipboard data into a TextFlow should use the MERGE_TO_NEXT_ON_PASTE property to control how the elements are treated when they are merged into an existing TextFlow on paste. This is useful if you want special handling for the case where only part of the element is copied. For instance, wheh a list is copied, if only part of the list is copied, and you paste it into another list, it merges into the list as additional items. If the entire list is copied, it appears as a nested list. When TLF creates a TextFlow for use on the clipboard, it decorates any partial elements with user properties that control whether the end of the element should be merged with the one after it. This user property is never pasted into the final TextFlow, but it may go on the elements in the TextScrap.textFlow. When copying text, the converter has the option to look for these properties to propagate them into the format that is posted on the clipboard. For instance, the plain text exporter checks the "mergeToNextOnPaste" property on paragraphs and supresses the paragraph terminator if it is found set to true. Likewise on import if the incoming String has no terminator, and useClipboardAnnotations is true, then it calls setStyle(MERGE_TO_NEXT_ON_PASTE, "true") on the corresponding paragraph so that when it is pasted it will blend into the paragraph where its pasted. This property should only be set on elements in a TextScrap, and only on the last element in the scrap. errors Errors encountered while parsing. Errors encountered while parsing. Value is a vector of Strings. throwOnError useClipboardAnnotations