| パッケージ | flashx.textLayout.conversion |
| インターフェイス | public interface ITextImporter |
| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
関連する API エレメント
| プロパティ | 定義元 | ||
|---|---|---|---|
| configuration : IConfiguration
configuration プロパティには、新しい TextFlow インスタンスの作成時にインポーターで必要になる IConfiguration インスタンスが含まれます。 | ITextImporter | ||
| errors : Vector.<String> [読み取り専用]
throwOnError プロパティが false(デフォルト値)に設定されている場合、このプロパティには、インポーターメソッドへの呼び出し後に、エラーメッセージのベクトルがストリングとして含まれます。 | ITextImporter | ||
| throwOnError : Boolean
throwOnError プロパティは、インポーターでのエラーの処理方法を制御します。 | ITextImporter | ||
| useClipboardAnnotations : Boolean
インポーターがクリップボードに必要な特別な情報を処理するかどうかを制御します。 | ITextImporter | ||
| メソッド | 定義元 | ||
|---|---|---|---|
テキストコンテンツを外部ソースからインポートし、TextFlow に変換します。 | ITextImporter | ||
configuration | プロパティ |
configuration:IConfiguration| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10.2, AIR 2.0 |
configuration プロパティには、新しい TextFlow インスタンスの作成時にインポーターで必要になる IConfiguration インスタンスが含まれます。このプロパティの初期設定値は null です。
実装
public function get configuration():IConfiguration public function set configuration(value:IConfiguration):void関連する API エレメント
errors | プロパティ |
errors:Vector.<String> [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
throwOnError プロパティが false(デフォルト値)に設定されている場合、このプロパティには、インポーターメソッドへの呼び出し後に、エラーメッセージのベクトルがストリングとして含まれます。 エラーが存在しない場合、プロパティは null を返します。 プロパティはメソッド呼び出しごとにリセットされます。
実装
public function get errors():Vector.<String>throwOnError | プロパティ |
throwOnError:Boolean| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
throwOnError プロパティは、インポーターでのエラーの処理方法を制御します。 true に設定されている場合、メソッドはエラー時に Error インスタンスをスローします。 false(デフォルト値)に設定されている場合、エラーはストリングのベクトルとしてまとめられ、errors プロパティに格納されます。インポーターがエラーをスローすることはありません。
実装
public function get throwOnError():Boolean public function set throwOnError(value:Boolean):voiduseClipboardAnnotations | プロパティ |
useClipboardAnnotations:Boolean| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
インポーターがクリップボードに必要な特別な情報を処理するかどうかを制御します。クリップボードからのデータには、部分的な段落(終了文字や改行文字のない段落)が含まれている場合があります。useClipboardAnnotations が true の場合、インポーターはこのような部分的な段落を ConverterBase.MERGE_TO_NEXT_ON_PASTE という属性でマークします。このようにすることで、ペースト操作によって、ペーストされた段落(および段落を含む可能性のある list エレメントや div エレメント)をテキストに正しくマージできるようになります。
実装
public function get useClipboardAnnotations():Boolean public function set useClipboardAnnotations(value:Boolean):void関連する API エレメント
importToFlow | () | メソッド |
public function importToFlow(source:Object):flashx.textLayout.elements:TextFlow| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
テキストコンテンツを外部ソースからインポートし、TextFlow に変換します。
パラメーター
source:Object — 変換するデータです。
|
flashx.textLayout.elements:TextFlow — ソースから作成された TextFlow です。
|
次のコードスニペットは、ITextImporter メソッドを使用して、フォーマットされたテキストの繰り返しインポートを実行する方法を示しています。エラーは各 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;
}
}
}
Tue Jun 12 2018, 10:34 AM Z