TextConverter  - AS3

形式の名前。

読み込み / 書き出し用の新しい形式を登録します。新しい形式は、末尾に最低優先度の形式として追加されます。 位置は、外部クリップボードからの読み込み時などに、どの形式を使用するかについて複数の選択肢があるクライアントにとって重要です。 新しい形式では、読み込みや書き出しをサポートできます。 形式が既に追加されている場合、その形式は複数の位置に存在します。 最初に見つかった形式が使用されます。

パラメーター

指定された位置における読み込み / 書き出し用の新しい形式を登録します。位置は、外部クリップボードからの読み込み時などに、どの形式を使用するかについて複数の選択肢があるクライアントにとって重要です。 数値が低いほど、優先度が高くなります。優先度の高いコンバーターが最初に試されます。新しい形式では、読み込みや書き出しをサポートできます。 形式が既に追加されている場合、その形式は複数の位置に存在します。 最初に見つかった形式が使用されます。

パラメーター

TextFlow を指定された形式にエクスポートします。

このクラスによって提供されている静的定数の 1 つ、MIME タイプ、またはユーザー定義のエクスポーター用のユーザー定義の形式を使用して、format パラメーターを指定します。

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

ConversionType クラスによって提供されている静的定数の 1 つ、またはユーザー定義のエクスポーター用のユーザー定義のデータタイプを使用して、書き出し後のデータのタイプを conversionType パラメーターで指定します。

• ConversionType.STRING_TYPE
• ConversionType.XML_TYPE

パラメーター

関連する API エレメント

書き出しコンバーターを作成して返します。その後、TextFlow からソースストリングまたは XML オブジェクトへの書き出しにこのコンバーターを使用できます。多数の個別エクスポートを実行する必要がある場合は、この関数を使用します。これは、flashx.textLayout.conversion.TextConverter.export() を呼び出すことと同じです。

このクラスによって提供されている静的定数の 1 つを使用して、format パラメーターを指定します。

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

形式が複数回追加されている場合は、最初に見つかった形式が使用されます。

パラメーター

関連する API エレメント

package flashx.textLayout.conversion.examples
{
    import flashx.textLayout.conversion.ConversionType;
    import flashx.textLayout.conversion.ITextExporter;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.elements.TextFlow;
    
    public class getExporter_example 
    {
        // Serialize the TextFlow into a String
        public function export(textFlow:TextFlow):String
        {
            var exporter:ITextExporter = TextConverter.getExporter(TextConverter.TEXT_LAYOUT_FORMAT);
            return exporter.export(textFlow, ConversionType.STRING_TYPE) as String;
        }
    }
}

インデックス番目の形式の形式名を返します。

パラメーター

インデックス番目の形式の FormatDescriptor を返します。

パラメーター

読み込みコンバーターを作成して返します。その後、ソースストリング、XML オブジェクト、またはユーザー定義のデータ形式から TextFlow への読み込みにこのコンバーターを使用できます。多数の個別読み込みを実行する必要がある場合、または読み込み中にエラーを処理する場合、このメソッドを使用します。 これは、flashx.textLayout.conversion.TextConverter.importToFlow() を呼び出すことと同じです。

このクラスによって提供されている静的定数の 1 つを使用して format パラメーターを指定するか、MIME タイプまたはユーザー定義のデータ形式を使用します。

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

形式が複数回追加されている場合は、最初に見つかった形式が使用されます。

パラメーター

関連する API エレメント

package flashx.textLayout.conversion.examples
{
    import flashx.textLayout.conversion.ITextImporter;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.elements.TextFlow;
    
    public class getImporter_example 
    {
        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;
        }
    }
}

指定された形式で、ソースコンテンツから TextFlow を作成します。

このクラスによって提供されている静的定数の 1 つ、または MIME タイプを使用して format パラメーターを指定するか、ユーザーが登録したインポーター用のユーザー定義の値を使用します。

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

パラメーター

関連する API エレメント

形式を削除します。形式が複数回追加されている場合は、最初に見つかった形式のみが削除されます。

パラメーター

インデックス位置の形式を削除します。

パラメーター

プレーンテキスト形式です。これは、簡易なフォーマットされていないストリングからの TextFlow の作成、または TextFlow からの簡易なフォーマットされていないストリングの作成に使用します。

HTML 形式です。これは、HTML 形式を使用する TextFlow との間でのインポートおよびエクスポートに使用します。Text Layout Framework HTML では、flash.text パッケージの TextField クラスでサポートされるタグと属性のサブセットがサポートされます。

次の表に、インポートおよびエクスポート処理でサポートされている HTML タグと属性を示します（TextField でサポートされ Text Layout Framework でサポートされないタグと属性については、その旨記載しています）。

不明なタグが読み込まれると、textFieldHTMLFormat インポーターは、単一の FlowElement の typeName プロパティをそのタグ名に設定するか、DivElement または SubParagraphGroupElement を作成してその typeName プロパティをタグ名に設定します。

textFieldHTMLFormat エクスポーターは、typeName を XML タグとして書き出します（デフォルト値と異なる場合）。

関連する API エレメント

TextLayout 形式です。これは、TextLayout マークアップ形式を使用する TextFlow との間でのインポートおよびエクスポートに使用します。Text Layout 形式は次のエラーを検出します。

• 予期しない名前空間
• 不明なエレメント
• 不明な属性

次の例は、TextConverter 変換クラスの使用方法を示しています。標準マークアップ形式のテキストは TextFlow オブジェクトにインポートされてから表示されます。その後、テキストは XML 形式にエクスポートされます。

package flashx.textLayout.conversion.examples 
{
    import flash.display.Sprite;
    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 textFlow:TextFlow = TextConverter.importToFlow(markup, TextConverter.TEXT_LAYOUT_FORMAT);
            textFlow.flowComposer.addController(new ContainerController(this, 200, 50));
            textFlow.flowComposer.updateAllControllers();
            //export to XML
            var xmlOut:XML = TextConverter.export(textFlow,TextConverter.TEXT_LAYOUT_FORMAT, ConversionType.XML_TYPE) as XML;
        }
    }
}