TextFormat クラス

TextFormat クラス

　TextField クラスでは入力できる文字のセット、境界線、テキストのタイプを指定する事ができました。今回ここで紹介するTextFormat クラスは文字書式(Fromat）の情報を表す事ができます。TextField クラスとTextFormat クラスこの二つのクラスの違いと関係を考えながら理解していくとよいと思います。

TextFormatオブジェクトの作成方法

　TextFormatオブジェクトを生成する為にはコンストラクタを使用する必要があります。new TextFormat()がコンストラクタです。_fmtはTextFromatオブジェクトの接尾辞です。

var my_fmt:TextFormat = new TextFormat();

さて実際に例を見てみましょう。

this.createTextField("my_txt", 1, 0, 0, 100, 20);
my_txt.border = true;
my_txt.text = "Bold";
var my_fmt:TextFormat = new TextFormat();
my_fmt.bold = true;
my_txt.setTextFormat(my_fmt);

　上記のスクリプトを順に説明すると下記の通りになります。

my_txtフィールドの位置、サイズを指定して作成
my_txtフィールドの境界線をありに設定
my_txtフィールドにBoldという文字列を表示
テキストフォーマットオブジェクトを作成
プロパティboldをtrueにしてフィールド全体をbold（太文字）にします。
my_txtにフォーマットをセットします

　簡単に流れを説明しますと、最初にテキストフィールドを作成して、TextFormatで書式を決めて、それにすでに作成してあるmy_txtにセットするとなります。

次に下記の例を見てみましょう。テキストフィールド全体のテキストの文字色をTextField クラスのプロパティcolorを使用して赤に設定しました。

this.createTextField("my_txt", 1, 0, 0, 100, 20);
my_txt.border = true;
my_txt.text = "赤い文字";
var my_fmt:TextFormat = new TextFormat();
my_fmt.color = 0xFF0000;
my_txt.setTextFormat(my_fmt);

　 TextField クラスの説明を読んだ方はわかると思いますが、TextField クラスのプロパティ TextField.textColorと同じ働きをします。ですから下記のスクリプトとでも同じ効果を得る事ができます。TextFormatクラスのプロパティは最後に紹介しています。

this.createTextField("my_txt", 1, 0, 0, 100, 20);
my_txt.border = true;
my_txt.textColor = 0xFF0000;
my_txt.text = "赤い文字";

　最後にTextFormatクラスのプロパティ bullet を使用してみます。このプロパティは改行文字で終了しているテキストの範囲の最初の行は小さな黒丸で開始されインデントされます。HTMLタグの<ul>と同じです。

this.createTextField("my_txt", 1, 0, 0, 0, 0);
my_txt.autoSize = true;
my_txt.border = true;
my_txt.text = "１列目\n２列目\n３列目";
var my_fmt:TextFormat = new TextFormat();
my_fmt.size = 13;
my_fmt.bullet = true;
my_txt.setTextFormat(my_fmt);

　もしもよければ上記スクリプトの２行目のTextField クラスのautoSizeプロパティの意味も考えてみてください。１行目でmy_txtを作成していますが、テキストフィールドのサイズが幅、高さを0に設定しています。

TextFromatのプロパティ値の初期値

　TextFormatのプロパティ値のデフォルトの状態は下記の通りとなります。

プロパティ	初期値
`bullet`	`false`
`tabStops`	`空のオブジェクト`
`blockIndent`	`0`
`leading`	`0`
`indent`	`0`
`rightMargin`	`0`
`leftMargin`	`0`
`align`	`"left"`
`underline`	`false`
`italic`	`false`
`bold`	`false`
`target`	`""空の文字列`
`url`	`""空の文字列`
`color`	`0`
`size`	`12`
`font`	`"Times New Roman"`

TextFormat クラスのメソッド一覧

メソッド	説明
`TextFormat.getTextExtent()`	テキストストリングのテキスト寸法情報を返します。

TextFormat クラスのプロパティ一覧

プロパティ	説明
`TextFormat.align`	パラグラフの整列の設定を示します。
`TextFormat.blockIndent`	ブロックのインデントをポイント単位で示します。
`TextFormat.bold`	テキストがボールド体であるかどうかを示します。
`TextFormat.bullet`	テキストが箇条書きかどうかを示します。
`TextFormat.color`	テキストの色を示します。
`TextFormat.font`	テキストフォーマット付きのテキストのフォント名を示します。
`TextFormat.indent`	左マージンから段落の先頭文字までのインデントを示します。
`TextFormat.italic`	テキストがイタリック体であるかどうかを示します。
`TextFormat.leading`	行間を示します。
`TextFormat.leftMargin`	段落の左マージンをポイント単位で示します。
`TextFormat.rightMargin`	段落の右マージンをポイント単位で示します。
`TextFormat.size`	テキストのポイントサイズを示します。
`TextFormat.tabStops`	カスタムタブストップを指定します。
`TextFormat.target`	ハイパーリンクが表示されているブラウザのウィンドウを示します。
`TextFormat.underline`	テキストが下線付きであるかどうかを示します。
`TextFormat.url`	テキストのリンク先の URL を示します。

Top | Back | Next