ITextImporter  - AS3

The configuration property contains the IConfiguration instance that the importer needs when creating new TextFlow instances. This property is initially set to null.

Related API Elements

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.

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.

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.

Related API Elements

Import text content from an external source and convert it into a TextFlow.

Parameters

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

package flashx.textLayout.conversion.examples
{
    import flashx.textLayout.conversion.ITextImporter;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.elements.TextFlow;
    
    public class ITextImporterExample 
    {
        // Create a new TextFlow based on the markup string
        static public function importAndCheckErrors():TextFlow
        {
            var markup:String = "<TextFlow xmlns='http://ns.adobe.com/textLayout/2008'><p><span>Hello, World</span></p></TextFlow>";
            var importer:ITextImporter = TextConverter.getImporter(TextConverter.TEXT_LAYOUT_FORMAT);
            importer.throwOnError = false;
            var textFlow:TextFlow = importer.importToFlow(markup);
            if (!textFlow)
            {
                var errors:Vector.<String> = importer.errors;
                //deal with import errors
            }
            return textFlow;
        }
    }
}