Package | flashx.textLayout.conversion |
Class | public class TextConverter |
Inheritance | TextConverter Object |
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Method | Defined By | ||
---|---|---|---|
[static]
Exports a TextFlow to a specified format. | TextConverter | ||
[static]
Creates an export filter. | TextConverter | ||
[static]
Creates an import filter. | TextConverter | ||
Indicates whether an object has a specified property defined. | Object | ||
importToFlow(source:Object, format:String, config:IConfiguration = null):flashx.textLayout.elements:TextFlow [static]
Creates a TextFlow from source content in a specified format. | TextConverter | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
Returns the string representation of the specified object. | Object | ||
Returns the primitive value of the specified object. | Object |
Constant | Defined 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 |
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:
Parameters
source:flashx.textLayout.elements:TextFlow — Source content
| |
format:String — Output format
| |
conversionType:String — Type of exported data
|
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
|
flashx.textLayout.conversion:ITextExporter — ITextExporter Text filter that can export in the specified format
|
See also
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.
|
flashx.textLayout.conversion:ITextImporter — ITextImporter Text filter that can import the source data
|
See also
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
|
flashx.textLayout.elements:TextFlow — TextFlow that was created from the source.
|
See also
FXG_FORMAT | Constant |
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_FORMAT | Constant |
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:
|
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:
|
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
Note: Unlike the TextField class, the following attributes are not supported:
Flash displays media embedded in a text field at full size. To specify the dimensions of the media
you are embedding, use the In general, an image embedded in a text field appears on the line following the
|
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:
|
Span tag |
The <span> tag supports the following attributes:
|
Text format tag |
The The
Note: Unlike the TextField class, the following attributes are
unsupported: |
Underline tag |
The <u> tag underlines the tagged text.
|
PLAIN_TEXT_FORMAT | Constant |
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_FORMAT | Constant |
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:
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); } } }