| パッケージ | flash.text |
| クラス | public class TextFormat |
| 継承 | TextFormat Object |
| 言語バージョン : | ActionScript 3.0 |
| Player のバージョン : | Flash Player 9 |
TextFormat オブジェクトのプロパティを設定する前に、コンストラクタ new TextFormat() を使用して TextFormat オブジェクトを作成する必要があります。TextFormat プロパティに値を設定しない場合は Flash Player 固有のデフォルトフォーマットが使用されるので、TextFormat プロパティはデフォルトでは null です。Flash Player が各プロパティに対して使用するデフォルトのフォーマットは (プロパティの値が null の場合)、次のとおりです。
| align = "left" |
| blockIndent = 0 |
| bold = false |
| bullet = false |
| color = 0x000000 |
| font = "Times New Roman" (Mac OS X でのデフォルトフォントは Times です) |
| indent = 0 |
| italic = false |
| kerning = false |
| leading = 0 |
| leftMargin = 0 |
| letterSpacing = 0 |
| rightMargin = 0 |
| size = 12 |
| tabStops = [] (空の配列) |
| target = "" (空のストリング) |
| underline = false |
| url = "" (空のストリング) |
各プロパティのデフォルトのフォーマットについては、各プロパティの説明でも説明します。
関連項目
| プロパティ | 定義元 | ||
|---|---|---|---|
| align : String
段落の整列の設定を示します。
| TextFormat | ||
| blockIndent : Object
ブロックのインデントをピクセル単位で示します。
| TextFormat | ||
| bold : Object
テキストをボールドにするかどうかを指定します。
| TextFormat | ||
| bullet : Object
テキストが箇条書きリストの一部かどうかを示します。
| TextFormat | ||
| color : Object
テキストの色を示します。
| TextFormat | ||
![]() | constructor : Object
特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
| Object | |
| font : String
このテキストフォーマットでのテキストフォント名を示すストリング。
| TextFormat | ||
| indent : Object
左マージンから段落の先頭文字までのインデントを示します。
| TextFormat | ||
| italic : Object
このテキストフォーマットのテキストをイタリックにするかどうかを示します。
| TextFormat | ||
| kerning : Object
カーニングが有効 (true) か無効 (false) かを示すブール値です。
| TextFormat | ||
| leading : Object
行間の垂直の行送りを示す整数です。
| TextFormat | ||
| leftMargin : Object
段落の左マージンをピクセル単位で示します。
| TextFormat | ||
| letterSpacing : Object
すべての文字の間に均等に配分されるスペースの量を表す数値です。
| TextFormat | ||
![]() | prototype : Object
[static]
クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
| Object | |
| rightMargin : Object
段落の右マージンをピクセル単位で示します。
| TextFormat | ||
| size : Object
このテキストフォーマットでのテキストのポイントサイズ。
| TextFormat | ||
| tabStops : Array
カスタムタブストップを負以外の整数の配列として指定します。
| TextFormat | ||
| target : String
ハイパーリンクを表示するターゲットウィンドウを示します。
| TextFormat | ||
| underline : Object
このテキストフォーマットを使用するテキストにアンダーラインを表示する (true) か、表示しない (false) かを示します。
| TextFormat | ||
| url : String
このテキストフォーマットのテキストの対象 URL を示します。
| TextFormat | ||
| メソッド | 定義元 | ||
|---|---|---|---|
|
TextFormat(font:String = null, size:Object = null, color:Object = null, bold:Object = null, italic:Object = null, underline:Object = null, url:String = null, target:String = null, align:String = null, leftMargin:Object = null, rightMargin:Object = null, indent:Object = null, leading:Object = null)
指定されたプロパティを使用して TextFormat オブジェクトを作成します。
| TextFormat | ||
![]() |
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
| Object | |
![]() |
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
| Object | |
![]() |
指定されたプロパティが存在し列挙できるかどうかを示します。
| Object | |
![]() |
ループ処理に対するダイナミックプロパティの可用性を設定します。
| Object | |
![]() |
指定されたオブジェクトのストリング表現を返します。
| Object | |
![]() |
指定されたオブジェクトのプリミティブな値を返します。
| Object | |
| align | プロパティ |
align:String [read-write]
| 言語バージョン : | ActionScript 3.0 |
| Player のバージョン : | Flash Player 9. |
段落の整列の設定を示します。指定できる値は TextFormatAlign 定数です。
デフォルト値 : TextFormatAlign.LEFT.
public function get align():String
public function set align(value:String):void
ArgumentError — 指定された align は、flash.text.TextFormatAlign のメンバーではありません。
|
関連項目
| blockIndent | プロパティ |
blockIndent:Object [read-write]
| 言語バージョン : | ActionScript 3.0 |
| Player のバージョン : | Flash Player 9. |
ブロックのインデントをピクセル単位で示します。ブロックのインデントは、テキストのブロック全体、つまりテキストのすべての行に適用されます。一方、通常のインデント (TextFormat.indent) は各段落の先頭行にのみ影響します。このプロパティが null である場合、TextFormat オブジェクトはブロックのインデントを指定しません。ブロックのインデントは 0 です。
public function get blockIndent():Object
public function set blockIndent(value:Object):void
| bold | プロパティ |
bold:Object [read-write]
| 言語バージョン : | ActionScript 3.0 |
| Player のバージョン : | Flash Player 9. |
テキストをボールドにするかどうかを指定します。デフォルト値は null です。この場合、ボールド体は使用されません。値が true の場合は、テキストがボールド体になります。
public function get bold():Object
public function set bold(value:Object):void
| bullet | プロパティ |
bullet:Object [read-write]
| 言語バージョン : | ActionScript 3.0 |
| Player のバージョン : | Flash Player 9. |
テキストが箇条書きリストの一部かどうかを示します。箇条書きリストでは、テキストの各段落がインデントされます。各段落の先頭行の左に箇条書きシンボルが表示されます。デフォルト値は null です。この場合、箇条書きリストは使用されません。
public function get bullet():Object
public function set bullet(value:Object):void
| color | プロパティ |
color:Object [read-write]
| 言語バージョン : | ActionScript 3.0 |
| Player のバージョン : | Flash Player 9. |
テキストの色を示します。たとえば、0xFF0000 は赤、0x00FF00 は緑など、3 つの 8 ビット RGB コンポーネントを示す数値です。デフォルト値は null で、Flash Player では黒 (0x000000) が使用されます。
public function get color():Object
public function set color(value:Object):void
| font | プロパティ |
font:String [read-write]
| 言語バージョン : | ActionScript 3.0 |
| Player のバージョン : | Flash Player 9. |
このテキストフォーマットでのテキストフォント名を示すストリング。デフォルト値は null で、Flash Player ではテキストに Times New Roman フォントが使用されます。
public function get font():String
public function set font(value:String):void
| indent | プロパティ |
indent:Object [read-write]
| 言語バージョン : | ActionScript 3.0 |
| Player のバージョン : | Flash Player 9. |
左マージンから段落の先頭文字までのインデントを示します。デフォルト値は null で、インデントは使用されないことを示します。
public function get indent():Object
public function set indent(value:Object):void
関連項目
| italic | プロパティ |
italic:Object [read-write]
| 言語バージョン : | ActionScript 3.0 |
| Player のバージョン : | Flash Player 9. |
このテキストフォーマットのテキストをイタリックにするかどうかを示します。デフォルト値は null です。この場合、イタリックは使用されません。
public function get italic():Object
public function set italic(value:Object):void
| kerning | プロパティ |
kerning:Object [read-write]
| 言語バージョン : | ActionScript 3.0 |
| Player のバージョン : | Flash Player 9. |
カーニングが有効 (true) か無効 (false) かを示すブール値です。カーニングでは、読みやすくするために、特定の文字ペア間でピクセルを調整します。大きなフォントの見出しを使用する場合など、必要な場合にのみ使用する必要があります。カーニングは、埋め込みフォントに対してのみサポートされています。
Verdana や、Courier New などの等幅フォントのように、カーニングがサポートされていないフォントもあります。
デフォルト値 null はカーニングを無効にします。
public function get kerning():Object
public function set kerning(value:Object):void
| leading | プロパティ |
leading:Object [read-write]
| 言語バージョン : | ActionScript 3.0 |
| Player のバージョン : | Flash Player 9. |
行間の垂直の行送りを示す整数です。デフォルト値は null で、使用される行送りは 0 であることを示します。
public function get leading():Object
public function set leading(value:Object):void
| leftMargin | プロパティ |
leftMargin:Object [read-write]
| 言語バージョン : | ActionScript 3.0 |
| Player のバージョン : | Flash Player 9. |
段落の左マージンをピクセル単位で示します。デフォルト値は null です。この場合、左マージンは 0 ピクセルです。
public function get leftMargin():Object
public function set leftMargin(value:Object):void
| letterSpacing | プロパティ |
letterSpacing:Object [read-write]
| 言語バージョン : | ActionScript 3.0 |
| Player のバージョン : | Flash Player 9. |
すべての文字の間に均等に配分されるスペースの量を表す数値です。この値は、各文字の後の送りに追加されるピクセル数を示します。デフォルト値は null です。この場合、0 ピクセルの文字間隔が使用されます。1.75 などの小数点を含む数値を使用することができます。
public function get letterSpacing():Object
public function set letterSpacing(value:Object):void
| rightMargin | プロパティ |
rightMargin:Object [read-write]
| 言語バージョン : | ActionScript 3.0 |
| Player のバージョン : | Flash Player 9. |
段落の右マージンをピクセル単位で示します。デフォルト値は null です。この場合、右マージンは 0 ピクセルです。
public function get rightMargin():Object
public function set rightMargin(value:Object):void
| size | プロパティ |
size:Object [read-write]
| 言語バージョン : | ActionScript 3.0 |
| Player のバージョン : | Flash Player 9. |
このテキストフォーマットでのテキストのポイントサイズ。デフォルト値は null です。この場合、ポイントサイズ 12 が使用されます。
public function get size():Object
public function set size(value:Object):void
| tabStops | プロパティ |
tabStops:Array [read-write]
| 言語バージョン : | ActionScript 3.0 |
| Player のバージョン : | Flash Player 9. |
カスタムタブストップを負以外の整数の配列として指定します。各タブストップはピクセル単位で指定します。カスタムタブストップを指定しないと (null)、タブストップはデフォルトの 4 (平均文字幅) になります。
public function get tabStops():Array
public function set tabStops(value:Array):void
| target | プロパティ |
target:String [read-write]
| 言語バージョン : | ActionScript 3.0 |
| Player のバージョン : | Flash Player 9. |
ハイパーリンクを表示するターゲットウィンドウを示します。ターゲットウィンドウが空のストリングである場合、テキストはデフォルトのターゲットウィンドウ _self に表示されます。カスタム名を選択することも、次の 4 つの名前のいずれかを選択することもできます。_self は現在のウィンドウ内の現在のフレームを指定します。_blank は新しいウィンドウを指定します。_parent は現在のフレームの親を指定します。_top は現在のウィンドウ内のトップレベルのフレームを指定します。TextFormat.url プロパティが空のストリングまたは null の場合は、このプロパティを取得および設定することはできますが、プロパティは何の影響も及ぼしません。
public function get target():String
public function set target(value:String):void
関連項目
| underline | プロパティ |
underline:Object [read-write]
| 言語バージョン : | ActionScript 3.0 |
| Player のバージョン : | Flash Player 9. |
このテキストフォーマットを使用するテキストにアンダーラインを表示する (true) か、表示しない (false) かを示します。これは、<U> タグによって設定されるアンダーラインと似ていますが、このタグの場合はデセンダが正しくスキップされないので、本物のアンダーラインではありません。デフォルト値は null です。この場合、アンダーラインは使用されません。
public function get underline():Object
public function set underline(value:Object):void
| url | プロパティ |
url:String [read-write]
| 言語バージョン : | ActionScript 3.0 |
| Player のバージョン : | Flash Player 9. |
このテキストフォーマットのテキストの対象 URL を示します。url プロパティが空のストリングである場合、テキストにはハイパーリンクがありません。デフォルト値は null です。この場合、テキストにはハイパーリンクがありません。
メモ : ハイパーリンクを機能させるには、テキストフォーマットが割り当てられたテキストを htmlText プロパティで設定する必要があります。
public function get url():String
public function set url(value:String):void
関連項目
| TextFormat | () | コンストラクタ |
public function TextFormat(font:String = null, size:Object = null, color:Object = null, bold:Object = null, italic:Object = null, underline:Object = null, url:String = null, target:String = null, align:String = null, leftMargin:Object = null, rightMargin:Object = null, indent:Object = null, leading:Object = null)
| 言語バージョン : | ActionScript 3.0 |
| Player のバージョン : | Flash Player 9. |
指定されたプロパティを使用して TextFormat オブジェクトを作成します。この TextFormat オブジェクトのプロパティを変更して、テキストフィールドのフォーマットを変更できます。
null 値を設定したパラメータは未設定になります。すべてのパラメータはオプションです。省略したパラメータは null として扱われます。
font:String (default = null) — テキストのフォント名を示すストリングです。
|
|
size:Object (default = null) — ポイントサイズを示す整数です。
|
|
color:Object (default = null) — このテキストフォーマットを使用するテキストの色です。たとえば、0xFF0000 は赤、0x00FF00 は緑など、3 つの 8 ビット RGB コンポーネントを示す数値です。
|
|
bold:Object (default = null) — テキストがボールド体であるかどうかを示すブール値です。
|
|
italic:Object (default = null) — テキストがイタリック体であるかどうかを示すブール値です。
|
|
underline:Object (default = null) — テキストがアンダーライン付きであるかどうかを示すブール値です。
|
|
url:String (default = null) — このテキストフォーマットのテキストのハイパーリンク先である URL です。url が空のストリングである場合、テキストにはハイパーリンクがありません。
|
|
target:String (default = null) — ハイパーリンクを表示するターゲットウィンドウです。ターゲットウィンドウが空のストリングである場合、テキストはデフォルトのターゲットウィンドウ _self に表示されます。url パラメータに空のストリングまたは null 値を指定した場合は、このプロパティを取得または設定することはできますが、プロパティには何の影響もありません。
|
|
align:String (default = null) — 段落の整列の設定を示す TextFormatAlign 値です。
|
|
leftMargin:Object (default = null) — 段落の左マージンをピクセル単位で示します。
|
|
rightMargin:Object (default = null) — 段落の右マージンをピクセル単位で示します。
|
|
indent:Object (default = null) — 左マージンから段落の先頭文字までのインデントを示す整数。
|
|
leading:Object (default = null) — 行間の垂直の行送りを示す数値です。
|
formatTextField テキストフィールドには、すべての TextField クラスのプロパティ (kerning を除く) が別々の行に表示されます。ユーザーが formatTextField テキストフィールドの行の一部をクリックすると、formatTextFieldClickHandler() メソッドがトリガされます。
formatTextFieldClickHandler() メソッドが TextField.getLineIndexAtPoint() メソッドを呼び出して、クリックされた行のインデックスを取得し、TextField.getLineText() メソッドを呼び出して、行のコンテンツを取得します。次に、switch ステートメントが行のコンテンツをチェックし、それに応じて newformat TextFormat オブジェクトのプロパティを設定します。その後、setTextFormat() メソッドが contentTextField テキストフィールドのテキストフォーマットを新しいフォーマットに設定します。さまざまな formatTextField 行をクリックすることで、ユーザーは、多くの異なるフォーマットを contentTextField テキストフィールドに適用することができます。タブ設定は、行のタブごとに別個のタブストップを定義する配列です。url または target 行を選択した場合、ユーザーは contentTextField テキストフィールドをクリックしてリンクをアクティブにし、ターゲット URL (Flex のホームページ) のコンテンツを表示する必要があります。target プロパティのデフォルト値は "_self" です。この場合、ユーザーが url 行を選択すると、コンテンツが現在のウィンドウに表示されます。target プロパティを有効にするには、あらかじめ URL を url プロパティに設定しておく必要があります。
ユーザーが contentTextField テキストフィールドをクリックすると、contentTextFieldClickHandler() メソッドがトリガされ、フィールドのフォーマットと newFormat TextFormat オブジェクトがテキストフィールドのデフォルト (元の) フォーマットに設定されます。これにより、ユーザーが行ったすべてのフォーマットの変更がクリアされます。
package {
import flash.display.Sprite;
import flash.text.TextField;
import flash.text.TextFormat;
import flash.text.TextFieldAutoSize;
import flash.events.MouseEvent;
import flash.text.TextFormatAlign;
public class TextFormat_constructorExample extends Sprite {
private var contentTextField:TextField = new TextField();
private var formatTextField:TextField = new TextField();
private var newFormat:TextFormat = new TextFormat();
public function TextFormat_constructorExample() {
contentTextField.x = 10;
contentTextField.y = 10;
contentTextField.background = true;
contentTextField.border = true;
contentTextField.multiline = true;
contentTextField.wordWrap = true;
contentTextField.selectable = false;
contentTextField.width = 250;
contentTextField.height = 120;
contentTextField.htmlText = "<p>The TextFormat class represents character formatting "
+ "information. Use the TextFormat class to create specific text formatting "
+ "for text fields." +
" </p><br>" + "\tTab One" + "\tTab Two<br>";
formatTextField.x = 10;
formatTextField.y = 140;
formatTextField.background = true;
formatTextField.border = true;
formatTextField.autoSize = TextFieldAutoSize.LEFT;
formatTextField.text = "align: right\n" + "blockIndent: 10 pixels\n" + "bold:\n" + "bullet:\n" + "color: red\n"
+ "font: Arial\n" + "indent: 20 pixels\n" + "italic:\n" + "leading: 5 spaces\n"
+ "leftMargin: 20 pixels\n" + "letterSpacing: 4 pixels\n" + "rightMargin: 20 pixels\n"
+ "size: 16 point\n" + "target: new window\n" + "tabStops: 50 and 150 pixel\n"
+ "underline:\n" + "url: Adobe Flex page\n";
formatTextField.addEventListener(MouseEvent.CLICK, formatTextFieldClickHandler);
contentTextField.addEventListener(MouseEvent.CLICK, contentTextFieldClickHandler);
this.addChild(contentTextField);
this.addChild(formatTextField);
}
private function formatTextFieldClickHandler(e:MouseEvent):void {
var value:String= "";
var i:uint = 0;
var index:int = formatTextField.getLineIndexAtPoint(e.localX, e.localY);
var line:String = formatTextField.getLineText(index);;
line = line.substr(0, (line.indexOf(":")));
switch(line) {
case "align":
newFormat.align = TextFormatAlign.RIGHT;
break;
case "blockIndent":
newFormat.blockIndent = 10;
break;
case "bold":
newFormat.bold = true;
break;
case "bullet":
newFormat.bullet = true;
break;
case "color":
newFormat.color = 0xFF0000;
break;
case "font":
newFormat.font = "Arial";
break;
case "indent":
newFormat.indent = 20;
break;
case "italic":
newFormat.italic = true;
break;
case "leading":
newFormat.leading = 5;
break;
case "leftMargin":
newFormat.leftMargin = 20;
break;
case "letterSpacing":
newFormat.letterSpacing = 4;
break;
case "rightMargin":
newFormat.rightMargin = 20;
break;
case "size":
newFormat.size = 16;
break;
case "tabStops":
newFormat.tabStops = [50, 150];
break;
case "target":
newFormat.url = "http://www.adobe.com/products/flex/";
newFormat.target = "_blank";
break;
case "underline":
newFormat.underline = true;
break;
case "url":
newFormat.url = "http://www.adobe.com/products/flex/";
break;
}
contentTextField.setTextFormat(newFormat);
}
private function contentTextFieldClickHandler(e:MouseEvent):void {
contentTextField.setTextFormat(contentTextField.defaultTextFormat);
newFormat = contentTextField.defaultTextFormat;
}
}
}
label が作成されます。configureLabel() を呼び出します。configureLabel() 関数はまず、新しい TextField オブジェクトを作成し、これを label に割り当てます。次に、そのパラメータを次のように設定します。
configureLable() は、ローカル変数 format を作成し、これを新しい TextFormat インスタンスに割り当て、そのパラメータを次のように設定します。
defaultTextFormat プロパティが format に設定され、label インスタンスが表示リストに追加されます。最初は、ステージに表示されるテキストフィールドにテキストが表示されません。白い背景の小さなボックスが表示されるだけです。setLabel() を呼び出すことによって実行されます。
package {
import flash.display.Sprite;
import flash.text.TextField;
import flash.text.TextFieldAutoSize;
import flash.text.TextFormat;
public class TextFormatExample extends Sprite {
private var label:TextField;
public function TextFormatExample() {
configureLabel();
setLabel("Hello World and welcome to the show");
}
public function setLabel(str:String):void {
label.text = str;
}
private function configureLabel():void {
label = new TextField();
label.autoSize = TextFieldAutoSize.LEFT;
label.background = true;
label.border = true;
var format:TextFormat = new TextFormat();
format.font = "Verdana";
format.color = 0xFF0000;
format.size = 10;
format.underline = true;
label.defaultTextFormat = format;
addChild(label);
}
}
}
このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート
現在のページ: http://livedocs.adobe.com/flash/9.0_jp/ActionScriptLangRefV3/flash/text/TextFormat.html