Packageflashx.textLayout.conversion
Interfacepublic interface IHTMLImporter extends ITextImporter

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10.0, AIR 2.0

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.



Public Properties
 PropertyDefined By
 Inheritedconfiguration : IConfiguration
The configuration property contains the IConfiguration instance that the importer needs when creating new TextFlow instances.
ITextImporter
 Inheritederrors : Vector.<String>
[read-only] 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.
ITextImporter
  imageSourceResolveFunction : Function
This property allows specification of a function to modify the source property supplied to an <img> element.
IHTMLImporter
  preserveBodyElement : Boolean
This property tells the importer to create an element for the BODY tag in HTML markup.
IHTMLImporter
  preserveHTMLElement : Boolean
This property tells the importer to create an element for the HTML tag in HTML markup.
IHTMLImporter
 InheritedthrowOnError : Boolean
The throwOnError property controls how the importer handles errors.
ITextImporter
 InheriteduseClipboardAnnotations : Boolean
Controls whether or not the importer should handle the extra information necessary for the clipboard.
ITextImporter
Public Methods
 MethodDefined By
 Inherited
importToFlow(source:Object):TextFlow
Import text content from an external source and convert it into a TextFlow.
ITextImporter
Property Detail
imageSourceResolveFunctionproperty
imageSourceResolveFunction:Function

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10.0, AIR 2.0

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.


Implementation
    public function get imageSourceResolveFunction():Function
    public function set imageSourceResolveFunction(value:Function):void
preserveBodyElementproperty 
preserveBodyElement:Boolean

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10.0, AIR 2.0

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.


Implementation
    public function get preserveBodyElement():Boolean
    public function set preserveBodyElement(value:Boolean):void
preserveHTMLElementproperty 
preserveHTMLElement:Boolean

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10.0, AIR 2.0

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.


Implementation
    public function get preserveHTMLElement():Boolean
    public function set preserveHTMLElement(value:Boolean):void