パッケージflash.text
public class TextFormat
継承TextFormat Inheritance Object
SubclassesUITextFormat

TextFormat クラスは、文字フォーマット情報を表します。TextFormat クラスを使用して、テキストフィールドの特定のテキストフォーマットを作成します。静止テキストフィールドおよびダイナミックテキストフィールドの両方にテキストフォーマットを適用できます。TextFormat クラスのプロパティは、デバイスフォントおよび埋めこみフォントに適用されます。ただし、埋め込みフォントの場合、ボールドとイタリックのテキストには、実際に特定のフォントが必要です。埋め込みフォントでボールドまたはイタリックのテキストを表示する場合は、そのフォントのボールド体およびイタリック体を埋め込む必要があります。

TextFormat オブジェクトのプロパティを設定する前に、コンストラクタ new TextFormat() を使用して TextFormat オブジェクトを作成する必要があります。TextFormat プロパティに値を設定しない場合は Flash Player 固有のフォーマットが使用されるので、TextFormat プロパティはデフォルトでは null です。Flash Player が各プロパティに対して使用するデフォルトのフォーマットは次のとおりです。

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 = "" (空のストリング)

各プロパティのデフォルトのフォーマットについては、各プロパティの説明でも説明します。

例の表示

関連項目

flash.text.TextField.setTextFormat()
flash.text.TextField.getTextFormat()


パブリックプロパティ
 プロパティ定義
  align : String
段落の整列の設定を示します。
TextFormat
  blockIndent : Object
ブロックのインデントをピクセル単位で示します。
TextFormat
  bold : Object
テキストをボールドにするかどうかを指定します。
TextFormat
  bullet : Object
テキストが箇条書きリストにあるかどうかを示します。
TextFormat
  color : Object
テキストの色を示します。
TextFormat
 Inheritedconstructor : 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
 Inheritedprototype : 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
 InheritedhasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 InheritedisPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 InheritedpropertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙可能かどうかを示します。
Object
 InheritedsetPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 InheritedtoString():String
指定されたオブジェクトのストリング表現を返します。
Object
 InheritedvalueOf():Object
指定されたオブジェクトのプリミティブ値を返します。
Object
プロパティの詳細
alignプロパティ
align:String  [read-write]

段落の整列の設定を示します。指定できる値は TextFormatAlign 定数です。

デフォルト値TextFormatAlign.LEFT.

実装
    public function get align():String
    public function set align(value:String):void

Throws
ArgumentError — 指定された align は、flash.text.TextFormatAlign のメンバーではありません。

関連項目

blockIndentプロパティ 
blockIndent:Object  [read-write]

ブロックのインデントをピクセル単位で示します。ブロックのインデントは、テキストのブロック全体、つまりテキストのすべての行に適用されます。一方、通常のインデント (TextFormat.indent) は各段落の先頭行にのみ影響します。このプロパティが null である場合、TextFormat オブジェクトはブロックのインデントを指定しません。ブロックのインデントは 0 です。

実装
    public function get blockIndent():Object
    public function set blockIndent(value:Object):void
boldプロパティ 
bold:Object  [read-write]

テキストをボールドにするかどうかを指定します。デフォルト値は null です。この場合、ボールド体は使用されません。値が true の場合は、テキストがボールド体になります。

実装
    public function get bold():Object
    public function set bold(value:Object):void
bulletプロパティ 
bullet:Object  [read-write]

テキストが箇条書きリストにあるかどうかを示します。箇条書きリストでは、テキストの各段落がインデントされます。箇条書きシンボルは、各段落の先頭行の左に表示されます。デフォルト値は null です。この場合、箇条書きリストは使用されません。

実装
    public function get bullet():Object
    public function set bullet(value:Object):void
colorプロパティ 
color:Object  [read-write]

テキストの色を示します。たとえば、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]

このテキストフォーマットでのテキストフォント名を示すストリングです。デフォルト値は null で、Flash Player ではテキストに Times New Roman フォントが使用されます。

実装
    public function get font():String
    public function set font(value:String):void
indentプロパティ 
indent:Object  [read-write]

左マージンから段落の先頭文字までのインデントを示します。デフォルト値は null で、インデントは使用されないことを示します。

実装
    public function get indent():Object
    public function set indent(value:Object):void

関連項目

italicプロパティ 
italic:Object  [read-write]

このテキストフォーマットのテキストをイタリックにするかどうかを示します。デフォルト値は null です。この場合、イタリックは使用されません。

実装
    public function get italic():Object
    public function set italic(value:Object):void
kerningプロパティ 
kerning:Object  [read-write]

カーニングが有効か (true) 無効か (false) を示すブール値です。カーニングでは、読みやすくするために、特定の文字ペア間でピクセルを調整します。大きなフォントの見出しを使用する場合など、必要な場合にのみ使用する必要があります。カーニングは、埋め込みフォントに対してのみサポートされています。

Verdana や、Courier New などの等幅フォントなど、特定のフォントではカーニングはサポートされていません。

デフォルト値 null はカーニングを無効にします。 実装
    public function get kerning():Object
    public function set kerning(value:Object):void
leadingプロパティ 
leading:Object  [read-write]

行間の垂直の行送りを示す整数です。デフォルト値は null で、使用される行送りは 0 であることを示します。

実装
    public function get leading():Object
    public function set leading(value:Object):void
leftMarginプロパティ 
leftMargin:Object  [read-write]

段落の左マージンをピクセル単位で示します。デフォルト値は null です。この場合、左マージンは 0 ピクセルです。

実装
    public function get leftMargin():Object
    public function set leftMargin(value:Object):void
letterSpacingプロパティ 
letterSpacing:Object  [read-write]

すべての文字間に均等に配分されるスペースの量を示す整数です。この値は、各文字の後の送りに追加されるピクセル数を示します。デフォルト値は null です。この場合、0 ピクセルの文字間隔が使用されます。

実装
    public function get letterSpacing():Object
    public function set letterSpacing(value:Object):void
rightMarginプロパティ 
rightMargin:Object  [read-write]

段落の右マージンをピクセル単位で示します。デフォルト値は null です。この場合、右マージンは 0 ピクセルです。

実装
    public function get rightMargin():Object
    public function set rightMargin(value:Object):void
sizeプロパティ 
size:Object  [read-write]

このテキストフォーマットでのテキストのポイントサイズです。デフォルト値は null です。この場合、ポイントサイズ 12 が使用されます。

実装
    public function get size():Object
    public function set size(value:Object):void
tabStopsプロパティ 
tabStops:Array  [read-write]

カスタムタブストップを負以外の整数の配列として指定します。各タブストップはピクセル単位で指定します。カスタムタブストップを指定しないと (null)、タブストップはデフォルトの 4 (平均文字幅) になります。

実装
    public function get tabStops():Array
    public function set tabStops(value:Array):void
targetプロパティ 
target:String  [read-write]

ハイパーリンクを表示するターゲットウィンドウを示します。ターゲットウィンドウが空のストリングである場合、テキストはデフォルトのターゲットウィンドウ _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]

このテキストフォーマットを使用するテキストにアンダーラインを表示するか (true)、または表示しないか (false) を示します。これは、<U> タグによって設定されるアンダーラインと似ていますが、このタグの場合はデセンダが正しくスキップされないので、本物のアンダーラインではありません。デフォルト値は null です。この場合、アンダーラインは使用されません。

実装
    public function get underline():Object
    public function set underline(value:Object):void
urlプロパティ 
url:String  [read-write]

このテキストフォーマットのテキストの対象 URL を示します。url プロパティが空のストリングである場合、テキストにはハイパーリンクがありません。デフォルト値は null です。この場合、テキストにはハイパーリンクがありません。

メモ: ハイパーリンクを機能させるには、テキストフォーマットが割り当てられたテキストを htmlText プロパティで設定する必要があります。

実装
    public function get url():String
    public function set url(value:String):void

関連項目

コンストラクタの詳細
TextFormat()コンストラクタ
public 関数 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 オブジェクトのプロパティを変更して、テキストフィールドのフォーマットを変更できます。

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) — 行間の垂直の行送りを示す数値です。

次の例は、TextFieldExample クラスを作成して、テキストメッセージを デフォルトの場所 (x = 0、y = 0) に表示します。ここでは以下の手順を実行します。
  1. タイプ TextField のプロパティ label が作成されます。
  2. クラスコンストラクタは、関数 configureLabel()
  3. を呼び出します。
  4. configureLabel() 関数は、最初に新しい TextField オブジェクトを作成し、それを label に割り当て、そのパラメータを以下のように設定します。
    • テキストフィールドを左揃えにします。
    • 背景の塗りを有効にします。
    • 境界線を有効にします。
  5. 次に、configureLable() はローカル変数 format を作成し、それを 新しい TextFormat インスタンスに割り当てます。パラメータを以下のように設定します。
    • Font type = Verdana
    • Font Color = solid red
    • Font size = 10
    • Font underline = true
  6. ラベルの defaultTextFormat プロパティは format に設定され、 label インスタンスが表示リストに追加されます。最初は、表示リストには、 テキストがないテキストフィールドが、白い背景の小さなボックスとしてステージ上に表示されています。
  7. 最後に、コンストラクタに戻り、ラベルのテキストが、"Hello World and welcome to the show" と座標 x = 0、y = 0 に表示するように設定されます。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/flex/2_jp/langref/flash/text/TextFormat.html