パッケージflash.text.engine
クラスpublic final class ElementFormat
継承ElementFormat Inheritance Object

言語バージョン: ActionScript 3.0
ランタイムバージョン: Flash Player 10, AIR 1.5

ElementFormat クラスは、ContentElement に適用できるフォーマット情報を表します。 ElementFormat クラスを使用して、ContentElement の様々なサブクラスに特定のテキストフォーマットを作成します。ElementFormat クラスのプロパティは、デバイスフォントおよび埋めこみフォントに適用されます。

ElementFormat オブジェクトを TextBlock の ContentElement に適用しても、TextBlock は無効化されません。ElementFormat が ContentElement に適用されると、その locked プロパティは true に設定されます。 ロックされた ElementFormat オブジェクトのプロパティを変更することはできません。代わりに、clone() メソッドを使用してオブジェクトのロックされていないコピーを作成し、そのコピーを変更して ContentElement に割り当てることができます。

例を表示

関連項目

flash.text.engine.ContentElement.elementFormat
Formatting text


パブリックプロパティ
 プロパティ定義元
  alignmentBaseline : String
dominantBaseline の吸着先になる、エレメントを含む行のベースラインを指定します。つまり、行内のエレメントの垂直座標を決定します。
ElementFormat
  alpha : Number
作成者が、エレメント形式に応じてすべての行アトムの alpha プロパティを、指定された Number に自動的に設定するための方法を提供します。
ElementFormat
  baselineShift : Number
エレメントのベースラインシフトを示します(ピクセル単位)。
ElementFormat
  breakOpportunity : String
このテキストに適用される改行の条件です。
ElementFormat
  color : uint
テキストの色を示します。
ElementFormat
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  digitCase : String
このテキストに使用される数字の大文字小文字区別です。
ElementFormat
  digitWidth : String
このテキストに使用される数字の幅です。
ElementFormat
  dominantBaseline : String
行のエレメントの垂直座標を決定するために alignmentBaseline に吸着させるエレメントのベースラインを指定します。
ElementFormat
  fontDescription : FontDescription
フォントを説明するのに必要なプロパティをカプセル化するオブジェクトです。
ElementFormat
  fontSize : Number
テキストのサイズ(ピクセル単位)です。
ElementFormat
  kerning : String
このテキストに使用されるカーニングです。
ElementFormat
  ligatureLevel : String
このテキストに使用される合字のレベルです。
ElementFormat
  locale : String
テキストのロケールです。
ElementFormat
  locked : Boolean
ElementFormat がロックされているかどうかを示します。
ElementFormat
 Inheritedprototype : Object
[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
  textRotation : String
個々の文字に適用される回転を設定します。
ElementFormat
  trackingLeft : Number
各文字の左側に適用されるトラッキングまたは手動カーニング(ピクセル単位)です。
ElementFormat
  trackingRight : Number
各文字の右側に適用されるトラッキングまたは手動カーニング(ピクセル単位)です。
ElementFormat
  typographicCase : String
このテキストに使用される文字の大文字小文字区別です。
ElementFormat
パブリックメソッド
 メソッド定義元
  
ElementFormat(fontDescription:FontDescription = null, fontSize:Number = 12.0, color:uint = 0x000000, alpha:Number = 1.0, textRotation:String = "auto", dominantBaseline:String = "roman", alignmentBaseline:String = "useDominantBaseline", baselineShift:Number = 0.0, kerning:String = "on", trackingRight:Number = 0.0, trackingLeft:Number = 0.0, locale:String = "en", breakOpportunity:String = "auto", digitCase:String = "default", digitWidth:String = "default", ligatureLevel:String = "common", typographicCase:String = "default")
ElementFormat オブジェクトを作成します。
ElementFormat
  
ElementFormat のロックされていないクローンコピーを構築します。
ElementFormat
  
fontDescription および fontSize で指定されるフォントの em ボックス、取り消し線位置、取り消し線太さ、下線位置および下線太さを記述するプロパティを持つ FontMetrics オブジェクトを返します。
ElementFormat
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
プロパティの詳細
alignmentBaselineプロパティ
alignmentBaseline:String  [読み書き可能]

言語バージョン: ActionScript 3.0
ランタイムバージョン: Flash Player 10, AIR 1.5

dominantBaseline の吸着先になる、エレメントを含む行のベースラインを指定します。つまり、行内のエレメントの垂直座標を決定します。このプロパティには、flash.text.engine.TextBaseline 定数を使用します。

TextBlock.baselineFontDescription および TextBlock.baselineFontSize が設定され、このロジックより優先されない場合、ベースラインは行内の最大のエレメントで決まります。

デフォルト値は flash.text.engine.TextBaseline.USE_DOMINANT_BASELINE です。

このプロパティの値を設定するには、次のストリング値を使用します。

ストリング値説明
TextBaseline.ROMAN dominantBaseline が、行のローマン体のベースラインに整列します。
TextBaseline.ASCENT dominantBaseline が、行のアセントのベースラインに整列します。
TextBaseline.DESCENT dominantBaseline が、行のディセントのベースラインに整列します。
TextBaseline.IDEOGRAPHIC_TOP dominantBaseline が、行の文字最上部のベースラインに整列します。
TextBaseline.IDEOGRAPHIC_CENTER dominantBaseline が、行の文字の中心のベースラインに整列します。
TextBaseline.IDEOGRAPHIC_BOTTOM dominantBaseline が、行の文字最下部のベースラインに整列します。
TextBaseline.USE_DOMINANT_BASELINE dominantBaseline が、行の同一のベースラインに整列します。

サブクラスプロパティ設定の効果
GraphicElement グラフィックエレメントの dominantBaseline が整列する行の整列のベースラインを設定します。
GroupElement 効果はありません。
TextElement テキストエレメントの dominantBaseline が整列する行の整列のベースラインを設定します。



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

例外
ArgumentError flash.text.engine.TextBaseline のメンバーではないいずれかの値に設定する場合。
 
IllegalOperationError — ElementFormat オブジェクトのロック後に設定する場合(lockedtrue の場合)。

関連項目

alphaプロパティ 
alpha:Number  [読み書き可能]

言語バージョン: ActionScript 3.0
ランタイムバージョン: Flash Player 10, AIR 1.5

作成者が、エレメント形式に応じてすべての行アトムの alpha プロパティを、指定された Number に自動的に設定するための方法を提供します。

指定されたオブジェクトのアルファ透明度値を示します。有効な値は 0(完全な透明)~ 1(完全な不透明)です。デフォルト値は 1 です。alpha が 0 に設定されている表示オブジェクトは、表示されない場合でも、アクティブです。

デフォルト値は 1.0 です。

サブクラスプロパティ設定の効果
GraphicElement グラフィックエレメントに指定されたアルファを適用します。グラフィック DisplayObject 自体または TextLine に設定されたアルファと乗法的に結合します。
GroupElement 効果はありません。
TextElement テキストエレメントに指定されたアルファを適用します。TextLine に設定されたアルファと乗法的に結合します。



実装
    public function get alpha():Number
    public function set alpha(value:Number):void

例外
IllegalOperationError — ElementFormat オブジェクトのロック後に設定する場合(lockedtrue の場合)。

関連項目

baselineShiftプロパティ 
baselineShift:Number  [読み書き可能]

言語バージョン: ActionScript 3.0
ランタイムバージョン: Flash Player 10, AIR 1.5

エレメントのベースラインシフトを示します(ピクセル単位)。

エレメントは、dominantBaseline から、この量だけ離れます。エレメントのメンバーの y 位置にオフセットが追加されるため、回転されないテキストで正のベースラインシフトはエレメントを下に移動させ、負のベースラインシフトはエレメントを上に移動させます。

デフォルト値は 0.0(シフトなし)です。

サブクラスプロパティ設定の効果
GraphicElement グラフィックをベースラインから離します。
GroupElement 効果はありません。
TextElement テキストをベースラインから離します。



実装
    public function get baselineShift():Number
    public function set baselineShift(value:Number):void

例外
IllegalOperationError — ElementFormat オブジェクトのロック後に設定する場合(lockedtrue の場合)。

関連項目

breakOpportunityプロパティ 
breakOpportunity:String  [読み書き可能]

言語バージョン: ActionScript 3.0
ランタイムバージョン: Flash Player 10, AIR 1.5

このテキストに適用される改行の条件です。 折り返しテキストが複数行に分けられるときにどの文字が改行文字として使用できるかは、このプロパティにより決められます。このプロパティには、flash.text.engine.BreakOpportunity 定数を使用します。

デフォルト値は、flash.text.engine.BreakOpportunity.AUTO です。

このプロパティの値を設定するには、次のストリング値を使用します。

ストリング値説明
BreakOpportunity.AUTO 改行を行うかどうかの判断は、単語間の区切りやハイフンなど、Unicode 文字プロパティに基づいて行われます。
BreakOpportunity.ANY ContentElement オブジェクト内の文字が、改行を行うかどうかの判断に使用されます。通常、ローマン体のテキストが日中韓のテキストに埋め込まれており、単語の途中で改行されることが望ましい場合に使用されます。
BreakOpportunity.NONE 範囲内の文字は、改行を行うかどうかの判断に使用されません。
BreakOpportunity.ALL 範囲内のすべての文字が、改行を行うかどうかの判断に使用されます。パス上のテキストのような効果を作成するのに便利です。

サブクラスプロパティ設定の効果
GraphicElement 効果はありません。
GroupElement グループ内で隣接するテキストエレメント間で改行を行うかどうかを判断します。グループの elementFormat が、null の場合、隣接するエレメントの最初のエレメントのフォーマットが使用されます。
TextElement テキストエレメントの文字間で改行を行うかどうかを判断します。



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

例外
ArgumentError flash.text.engine.BreakOpportunity のメンバーではない値に設定する場合。
 
IllegalOperationError — ElementFormat オブジェクトのロック後に設定する場合(lockedtrue の場合)。

関連項目

colorプロパティ 
color:uint  [読み書き可能]

言語バージョン: ActionScript 3.0
ランタイムバージョン: Flash Player 10, AIR 1.5

テキストの色を示します。3 つの 8 ビット RGB コンポーネントを示す整数(0xFF0000 は赤、0x00FF00 は緑など)です。

デフォルト値は 0x000000 で、Flash Player では黒が使用されます。

サブクラスプロパティ設定の効果
GraphicElement 効果はありません。
GroupElement 効果はありません。
TextElement テキストの色を設定します。



実装
    public function get color():uint
    public function set color(value:uint):void

例外
IllegalOperationError — ElementFormat オブジェクトのロック後に設定する場合(lockedtrue の場合)。
digitCaseプロパティ 
digitCase:String  [読み書き可能]

言語バージョン: ActionScript 3.0
ランタイムバージョン: Flash Player 10, AIR 1.5

このテキストに使用される数字の大文字小文字区別です。数字の大文字小文字区別の違いは、数字のグループのスタイルと位置に影響します。このプロパティには、flash.text.engine.DigitCase 定数を使用します。

デフォルト値は、flash.text.engine.DigitCase.DEFAULT です。

このプロパティの値を設定するには、次のストリング値を使用します。

ストリング値説明
DigitCase.DEFAULT デフォルトの数字の大文字小文字区別をテキストに適用します。
DigitCase.LINING ライニング数字の大文字小文字区別をテキストに適用します。
DigitCase.OLD_STYLE オールドスタイル数字の大文字小文字区別をテキストに適用します。

サブクラスプロパティ設定の効果
GraphicElement 効果はありません。
GroupElement 効果はありません。
TextElement エレメントのテキストに使用する数字の大文字小文字区別を決定します。



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

例外
ArgumentError flash.text.engine.DigitCase のメンバーではないいずれかの値に設定する場合。
 
IllegalOperationError — ElementFormat オブジェクトのロック後に設定する場合(lockedtrue の場合)。

関連項目

digitWidthプロパティ 
digitWidth:String  [読み書き可能]

言語バージョン: ActionScript 3.0
ランタイムバージョン: Flash Player 10, AIR 1.5

このテキストに使用される数字の幅です。このプロパティには、flash.text.engine.DigitWidth 定数を使用します。

デフォルト値は、flash.text.engine.DigitWidth.DEFAULT です。

このプロパティの値を設定するには、次のストリング値を使用します。

ストリング値説明
DigitWidth.DEFAULT デフォルトの数字の幅をテキストに適用します。
DigitWidth.PROPORTIONAL プロポーショナル数字の幅をテキストに適用します。
DigitWidth.TABULAR 等幅数字の幅をテキストに適用します。

サブクラスプロパティ設定の効果
GraphicElement 効果はありません。
GroupElement 効果はありません。
TextElement エレメントのテキストに使用する数字の幅を決定します。



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

例外
ArgumentError flash.text.engine.DigitWidth のメンバーではないいずれかの値に設定する場合。
 
IllegalOperationError — ElementFormat オブジェクトのロック後に設定する場合(lockedtrue の場合)。

関連項目

dominantBaselineプロパティ 
dominantBaseline:String  [読み書き可能]

言語バージョン: ActionScript 3.0
ランタイムバージョン: Flash Player 10, AIR 1.5

行のエレメントの垂直座標を決定するために alignmentBaseline に吸着させるエレメントのベースラインを指定します。このプロパティには、flash.text.engine.TextBaseline 定数を使用します。

エレメントのコンテンツによりベースラインが決まります。TextElement の場合、ベースラインはフォントおよびポイントサイズで決まります。 GraphicElement の場合、ベースラインはエレメントの高さで決まります。

デフォルト値は flash.text.engine.TextBaseline.ROMAN です。

このプロパティの値を設定するには、次のストリング値を使用します。

ストリング値説明
TextBaseline.ROMAN エレメントのローマン体のベースラインが、alignmentBaseline に整列します。
TextBaseline.ASCENT エレメントのアセントのベースラインが、alignmentBaseline に整列します。
TextBaseline.DESCENT エレメントのディセントのベースラインが、alignmentBaseline に整列します。
TextBaseline.IDEOGRAPHIC_TOP エレメントの文字最上部のベースラインが、alignmentBaseline に整列します。
TextBaseline.IDEOGRAPHIC_CENTER エレメントの文字の中心のベースラインが、alignmentBaseline に整列します。
TextBaseline.IDEOGRAPHIC_BOTTOM エレメントの文字最下部のベースラインが、alignmentBaseline に整列します。

サブクラスプロパティ設定の効果
GraphicElement alignmentBaseline に整列するグラフィックエレメントのベースラインを決定します。
GroupElement 効果はありません。
TextElement alignmentBaseline に整列するテキストエレメントのベースラインを決定します。



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

例外
ArgumentError flash.text.engine.TextBaseline のメンバーではないいずれかの値に設定する場合。
 
IllegalOperationError — ElementFormat オブジェクトのロック後に設定する場合(lockedtrue の場合)。

関連項目

fontDescriptionプロパティ 
fontDescription:FontDescription  [読み書き可能]

言語バージョン: ActionScript 3.0
ランタイムバージョン: Flash Player 10, AIR 1.5

フォントを説明するのに必要なプロパティをカプセル化するオブジェクトです。

デフォルト値は、デフォルトで作成される FontDescription オブジェクトです。

fontDescription プロパティが設定されているときは、提供された FontDescription オブジェクトがロックされます。 その locked プロパティは true に設定されます。 ロックされた FontDescription を変更することはできません。

サブクラスプロパティ設定の効果
GraphicElement 効果はありません。
GroupElement 効果はありません。
TextElement エレメントのテキストに使用するフォントを決定します。



実装
    public function get fontDescription():FontDescription
    public function set fontDescription(value:FontDescription):void

例外
IllegalOperationError — ElementFormat オブジェクトのロック後に設定する場合(lockedtrue の場合)。

関連項目

fontSizeプロパティ 
fontSize:Number  [読み書き可能]

言語バージョン: ActionScript 3.0
ランタイムバージョン: Flash Player 10, AIR 1.5

テキストのサイズ(ピクセル単位)です。

デフォルト値は 12.0 です。

サブクラスプロパティ設定の効果
GraphicElement 効果はありません。
GroupElement 効果はありません。
TextElement エレメントのテキストのサイズをピクセル単位で指定します。



実装
    public function get fontSize():Number
    public function set fontSize(value:Number):void

例外
ArgumentError — 0 未満の値に設定する場合。
 
IllegalOperationError — ElementFormat オブジェクトのロック後に設定する場合(lockedtrue の場合)。
kerningプロパティ 
kerning:String  [読み書き可能]

言語バージョン: ActionScript 3.0
ランタイムバージョン: Flash Player 10, AIR 1.5

このテキストに使用されるカーニングです。このプロパティには、flash.text.engine.Kerning 定数を使用します。カーニングでは、読みやすくするために、特定の文字ペア間でピクセルを調整します。カーニングは、カーニングテーブルを持つすべてのフォントに対してサポートされています。

デフォルト値は、flash.text.engine.Kerning.ON です。

このプロパティの値を設定するには、次のストリング値を使用します。

ストリング値説明
Kerning.ON カーニングが有効にされています。
Kerning.OFF カーニングが無効にされています。
Kerning.AUTO 文字体裁で適切な文字に対してのみ、カーニングが有効にされます。カーニングは、漢字、ひらがなまたはカタカナのいずれでもない 2 文字の間に適用されます。

サブクラスプロパティ設定の効果
GraphicElement 効果はありません。
GroupElement グループ内で隣接するテキストエレメント間でカーニングが適用されるかどうかを決定します。グループの elementFormat が、null の場合、隣接するエレメントの最初のエレメントのフォーマットが使用されます。
TextElement テキストエレメントの文字間でカーニングが適用されるかどうかを決定します。



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

例外
IllegalOperationError — ElementFormat オブジェクトのロック後に設定する場合(lockedtrue の場合)。

関連項目

ligatureLevelプロパティ 
ligatureLevel:String  [読み書き可能]

言語バージョン: ActionScript 3.0
ランタイムバージョン: Flash Player 10, AIR 1.5

このテキストに使用される合字のレベルです。2 つ以上の letter-form が 1 つの文字に結合された場合には、合字が起こります。合字は通常、「fi」、「fl」、「ae」などの文字の組の用に共通のコンポーネントを共有する連続した文字を置き換えます。合字は、ラテン語およびラテン語以外の文字セットの両方で使用されます。このプロパティには、flash.text.engine.LigatureLevel 定数を使用します。

デフォルト値は flash.text.engine.LigatureLevel.COMMON です。

このプロパティの値を設定するには、次のストリング値を使用します。

ストリング値説明
LigatureLevel.NONE 合字は作成されません。
LigatureLevel.MINIMUM 最低限の合字が作成されます。
LigatureLevel.COMMON 共通の合字が作成されます。
LigatureLevel.UNCOMMON 珍しい合字が作成されます。
LigatureLevel.EXOTIC エキゾチックな合字が作成されます。

サブクラスプロパティ設定の効果
GraphicElement 効果はありません。
GroupElement グループ内で隣接するテキストエレメント間で合字のレベルを判断します。グループの elementFormat が、null の場合、隣接するエレメントの最初のエレメントのフォーマットが使用されます。
TextElement テキストエレメントの文字間で合字のレベルを判断します。



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

例外
ArgumentError flash.text.engine.LigatureLevel のメンバーではないいずれかの値に設定する場合。
 
IllegalOperationError — ElementFormat オブジェクトのロック後に設定する場合(lockedtrue の場合)。

関連項目

localeプロパティ 
locale:String  [読み書き可能]

言語バージョン: ActionScript 3.0
ランタイムバージョン: Flash Player 10, AIR 1.5

テキストのロケールです。大文字小文字変換およびシェイピングを制御します。標準のロケール識別子が使用されます。例えば、「en」、「en_US」および「en-US」はすべて英語で、「ja」は日本語です。

デフォルト値は「en」です。

サブクラスプロパティ設定の効果
GraphicElement 効果はありません。
GroupElement 効果はありません。
TextElement エレメントのテキストの大文字小文字変換およびシェイピングを決定します。



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

例外
IllegalOperationError — ElementFormat オブジェクトのロック後に設定する場合(lockedtrue の場合)。
lockedプロパティ 
locked:Boolean  [読み書き可能]

言語バージョン: ActionScript 3.0
ランタイムバージョン: Flash Player 10, AIR 1.5.

ElementFormat がロックされているかどうかを示します。true の場合、ElementFormat を変更することはできません。ElementFormat.clone() を呼び出して ElementFormat オブジェクトのロックされていないコピーを取得します。



実装
    public function get locked():Boolean
    public function set locked(value:Boolean):void

例外
IllegalOperationError — ElementFormat オブジェクトのロック後に設定する場合(lockedtrue の場合)。

関連項目

textRotationプロパティ 
textRotation:String  [読み書き可能]

言語バージョン: ActionScript 3.0
ランタイムバージョン: Flash Player 10, AIR 1.5

個々の文字に適用される回転を設定します。このプロパティには、flash.text.engine.TextRotation 定数を使用します。

デフォルト値は、flash.text.engine.TextRotation.AUTO です。

任意の文字の最終的な回転は、ElementFormat.textRotationContentElement.textRotation、および TextBlock.lineRotation の合計になります。

ElementFormat.textRotation は、縦書きレイアウトで正しく表示されるように文字を回転させる必要のある日中韓のテキストでよく使用されます。この場合、flash.text.engine.TextRotation.AUTOTextBlock.lineRotation = flash.text.engine.ROTATE_90 と組み合わせて使用します。

縦書きのレイアウト情報を含まないフォントに対してこのプロパティを設定すると、好ましくない結果になることがあります。 日本語フォントの「MS 明朝」などの vmtx テーブルや VORG テーブルを含むフォントは、正しくレイアウトするためにレイアウトエンジンで必要になるデータがこれらのテーブルによって提供されるので、正しく機能します。必要な情報を持っていない Verdana のようなフォントは正しく機能しません。

このプロパティの値を設定するには、次のストリング値を使用します。

ストリング値説明
TextRotation.ROTATE_0 文字は回転しません。
TextRotation.ROTATE_90 文字は時計回りに 90 度回転します。
TextRotation.ROTATE_180 文字は 180 度回転します。
TextRotation.ROTATE_270 文字は時計回りに 270 度回転します。
TextRotation.AUTO 文字の Unicode プロパティに従って、全角文字に対してのみ、反時計回りの 90 度回転を指定します。この値は通常、日中韓のテキストで回転が必要な文字に対してのみ使用されます。この回転は、縦書きテキストにのみ適用され、他の文字に影響を与えずに全角文字を垂直方向に変えます。

サブクラスプロパティ設定の効果
GraphicElement 効果はありません。
GroupElement 効果はありません。
TextElement テキストエレメントの文字の回転を決定します。



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

例外
ArgumentError flash.text.engine.TextRotation のメンバーではないいずれかの値に設定する場合。
 
IllegalOperationError — ElementFormat オブジェクトのロック後に設定する場合(lockedtrue の場合)。

関連項目

trackingLeftプロパティ 
trackingLeft:Number  [読み書き可能]

言語バージョン: ActionScript 3.0
ランタイムバージョン: Flash Player 10, AIR 1.5.

各文字の左側に適用されるトラッキングまたは手動カーニング(ピクセル単位)です。kerning が有効にされている場合、フォントのカーニングテーブルの値に trackingLeft 値が追加されます。kerning が無効にされている場合、trackingLeft 値が手動カーニングの値として使用されます。正の値と負の値の両方がサポートされます。

一般に、必要なトラッキング値は trackingRighttrackingLeft の間で分割されます。 そうでない場合、つまり複数の方向性が混在しているテキストでは、双方向境界ではトラッキングは 2 倍、それ以外では none となります。

デフォルト値は 0.0 です。

サブクラスプロパティ設定の効果
GraphicElement グラフィックの左側に適用されるトラッキングを決めます。
GroupElement 効果はありません。
TextElement テキストエレメント中の文字の左側に適用されるトラッキングを決めます。

例:

//positive tracking added to kerning
       var ef1:ElementFormat = new ElementFormat();
       ef1.kerning = flash.text.engine.Kerning.ON;
       ef1.trackingLeft = 0.5;
         //negative manual kerning
       var ef2:ElementFormat = new ElementFormat();
       ef2.kerning = flash.text.engine.Kerning.OFF;
       ef2.trackingLeft = -1.0;



実装
    public function get trackingLeft():Number
    public function set trackingLeft(value:Number):void

例外
IllegalOperationError — ElementFormat オブジェクトのロック後に設定する場合(lockedtrue の場合)。

関連項目

trackingRightプロパティ 
trackingRight:Number  [読み書き可能]

言語バージョン: ActionScript 3.0
ランタイムバージョン: Flash Player 10, AIR 1.5.

各文字の右側に適用されるトラッキングまたは手動カーニング(ピクセル単位)です。kerning が有効にされている場合、フォントのカーニングテーブルの値に trackingRight 値が追加されます。kerning が無効にされている場合、trackingRight 値が手動カーニングの値として使用されます。正の値と負の値の両方がサポートされます。

一般に、必要なトラッキング値は trackingRighttrackingLeft の間で分割されます。 そうでない場合、つまり複数の方向性が混在しているテキストでは、双方向境界ではトラッキングは 2 倍、それ以外では none となります。

デフォルト値は 0.0 です。

サブクラスプロパティ設定の効果
GraphicElement グラフィックの右側に適用されるトラッキングを決めます。
GroupElement 効果はありません。
TextElement テキストエレメント中の文字の右側に適用されるトラッキングを決めます。

例:

//positive tracking added to kerning
       var ef1:ElementFormat = new ElementFormat();
       ef1.kerning = flash.text.engine.Kerning.ON;
       ef1.trackingRight = 0.5;
         //negative manual kerning
       var ef2:ElementFormat = new ElementFormat();
       ef2.kerning = flash.text.engine.Kerning.OFF;
       ef2.trackingRight = -1.0;



実装
    public function get trackingRight():Number
    public function set trackingRight(value:Number):void

例外
IllegalOperationError — ElementFormat オブジェクトのロック後に設定する場合(lockedtrue の場合)。

関連項目

typographicCaseプロパティ 
typographicCase:String  [読み書き可能]

言語バージョン: ActionScript 3.0
ランタイムバージョン: Flash Player 10, AIR 1.5

このテキストに使用される文字の大文字小文字区別です。このプロパティには、flash.text.engine.TypographicCase 定数を使用します。

デフォルト値は flash.text.engine.TypographicCase.DEFAULT です。

このプロパティの値を設定するには、次のストリング値を使用します。

ストリング値説明
TypographicCase.DEFAULT デフォルトの文字の大文字小文字区別をテキストに適用します。
TypographicCase.TITLE 出力時にタイトル文字に大文字を使用するよう指定します。
TypographicCase.CAPS 出力時に大文字の間隔が調整されるよう指定します。
TypographicCase.SMALL_CAPS 出力時に大文字でスモールキャップ文字を使用するよう指定します。
TypographicCase.UPPERCASE 出力時にすべての文字で大文字を使用するよう指定します。
TypographicCase.LOWERCASE 出力時にすべての文字で小文字を使用するよう指定します。
TypographicCase.CAPS_AND_SMALL_CAPS 出力時にすべての小文字でスモールキャップス文字を使用するよう指定します。

サブクラスプロパティ設定の効果
GraphicElement 効果はありません。
GroupElement 効果はありません。
TextElement エレメントのテキストに使用する文字の大文字小文字区別を決定します。



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

例外
ArgumentError flash.text.engine.TypographicCase のメンバーではない値に設定する場合。
 
IllegalOperationError — ElementFormat オブジェクトのロック後に設定する場合(lockedtrue の場合)。

関連項目

コンストラクタの詳細
ElementFormat()コンストラクタ
public function ElementFormat(fontDescription:FontDescription = null, fontSize:Number = 12.0, color:uint = 0x000000, alpha:Number = 1.0, textRotation:String = "auto", dominantBaseline:String = "roman", alignmentBaseline:String = "useDominantBaseline", baselineShift:Number = 0.0, kerning:String = "on", trackingRight:Number = 0.0, trackingLeft:Number = 0.0, locale:String = "en", breakOpportunity:String = "auto", digitCase:String = "default", digitWidth:String = "default", ligatureLevel:String = "common", typographicCase:String = "default")

言語バージョン: ActionScript 3.0
ランタイムバージョン: Flash Player 10, AIR 1.5

ElementFormat オブジェクトを作成します。

パラメータ
fontDescription:FontDescription (default = null) — このエレメント形式で使用されるフォントを識別する FontDescription オブジェクトです。 デフォルト値は null です。 フォントの説明を指定しない場合は、デフォルトのフォントの説明が作成されます。
 
fontSize:Number (default = 12.0) — テキストのサイズ(ピクセル単位)です。
 
color:uint (default = 0x000000) — テキストカラーです。例えば、0xFF0000 は赤、0x00FF00 は緑など、3 つの 8 ビットの RGB コンポーネントを示す数値です。
 
alpha:Number (default = 1.0) — エレメント形式に応じてすべての行アトムに適用される alpha プロパティです。
 
textRotation:String (default = "auto") — 個々の文字に適用される回転です。このプロパティには、flash.text.engine.TextRotation 定数を使用します。
 
dominantBaseline:String (default = "roman") — テキスト内の文字の吸着先であるベースラインです。このプロパティには、flash.text.engine.TextBaseline 定数を使用します。
 
alignmentBaseline:String (default = "useDominantBaseline") — dominantBaseline の吸着先であるコンテンツ行に対するベースラインです。このプロパティには、flash.text.engine.TextBaseline 定数を使用します。
 
baselineShift:Number (default = 0.0) — テキストのベースラインシフト(ピクセル/em 単位)です。
 
kerning:String (default = "on") — このテキストに使用されるカーニングです。flash.text.engine.Kerning を使用します。
 
trackingRight:Number (default = 0.0) — 各文字の右側に適用されるトラッキングまたは手動カーニング(ピクセル単位)です。
 
trackingLeft:Number (default = 0.0) — 各文字の左側に適用されるトラッキングまたは手動カーニング(ピクセル単位)です。
 
locale:String (default = "en") — テキストのロケールです。
 
breakOpportunity:String (default = "auto") — このテキストに適用される改行の条件です。このプロパティには、flash.text.engine.BreakOpportunity 定数を使用します。
 
digitCase:String (default = "default") — このテキストに使用される数字の大文字小文字区別です。このプロパティには、flash.text.engine.DigitCase 定数を使用します。
 
digitWidth:String (default = "default") — このテキストに使用される数字の幅です。このプロパティには、flash.text.engine.DigitWidth 定数を使用します。
 
ligatureLevel:String (default = "common") — このテキストに使用される合字のレベルです。このプロパティには、flash.text.engine.LigatureLevel 定数を使用します。
 
typographicCase:String (default = "default") — このテキストに使用される文字の大文字小文字区別です。このプロパティには、flash.text.engine.TypographicCase 定数を使用します。

例外
ArgumentError — 指定された fontSize は、0 未満です。
 
ArgumentError — 指定された textRotation は、flash.text.engine.TextRotation のメンバーではありません。
 
ArgumentError — 指定された dominantBaseline は、flash.text.engine.TextBaseline のメンバーではありません。
 
ArgumentError — 指定された alignmentBaseline は、flash.text.engine.TextBaseline のメンバーではありません。
 
ArgumentError — 指定された kerning は、flash.text.engine.Kerning のメンバーではありません。
 
ArgumentError — 指定された breakOpportunity は、flash.text.engine.BreakOpportunity のメンバーではありません。
 
ArgumentError — 指定された digitCase は、flash.text.engine.DigitCase のメンバーではありません。
 
ArgumentError — 指定された digitWidth は、flash.text.engine.DigitWidth のメンバーではありません。
 
ArgumentError — 指定された ligatureLevel は、flash.text.engine.LigatureLevel のメンバーではありません。
 
ArgumentError — 指定された typographicCase は、flash.text.engine.TypographicCase のメンバーではありません。
メソッドの詳細
clone()メソッド
public function clone():ElementFormat

言語バージョン: ActionScript 3.0
ランタイムバージョン: Flash Player 10, AIR 1.5

ElementFormat のロックされていないクローンコピーを構築します。

戻り値
ElementFormatElementFormat オブジェクトのロックされていないコピーです。

関連項目




この例では、ElementFormat オブジェクトを作成し、FontSize を設定します。 新しい TextElementElementFormat を使用して作成されます(つまり、ロックされます)。この TextElementTextBlock のコンテンツとして使用されます。 テキストの行が、TextBlock から作成されます。

ElementFormat オブジェクトを変更するには、その locked プロパティを最初にチェックします。 true である場合は、clone() メソッドを使用して ElementFormat のロックされていないコピーを作成します。次に、そのプロパティを変更し、新しく作成した ElementFormat オブジェクトを TextBlock に再リンクします。 行が再改行されると、新しい行には新しいフォント設定が使用されます。

package {

    import flash.display.Sprite;
    import flash.text.engine.*;

    
    public class ElementFormat_cloneExample extends Sprite {
        private var ef1:ElementFormat;
        private var ef2:ElementFormat;
        
        public function ElementFormat_cloneExample():void {
            var fd:FontDescription = new FontDescription();
            fd.fontLookup = flash.text.engine.FontLookup.DEVICE;
            fd.fontName = "Palatino";

            var ef1:ElementFormat = new ElementFormat(fd);
            ef1.fontSize=20;
            
            var str:String = "This is flash text 0123456789";
            var tb:TextBlock = new TextBlock();
            var te1:TextElement = new TextElement(str, ef1);
            tb.content = te1;
            var line1:TextLine = tb.createTextLine(null, 600);
            addChild(line1);
            
            ef2 = (ef1.locked) ? ef1.clone() : ef1;    
            ef2.fontSize = 32;

            tb.content.elementFormat=ef2;
            var line2:TextLine = tb.createTextLine(null, 600);
            addChild(line2);
            
        }
    }    
}
getFontMetrics()メソッド 
public function getFontMetrics():FontMetrics

言語バージョン: ActionScript 3.0
ランタイムバージョン: Flash Player 10, AIR 1.5

FontMetrics オブジェクトを返します。fontDescription および fontSize で指定されるフォントの em ボックス、取り消し線位置、取り消し線太さ、下線位置および下線太さを記述するプロパティを持ちます。

戻り値
FontMetricsFontMetrics オブジェクト。fontDescription で指定されるフォントのプロパティを記述します。

関連項目




この例では、割り当てられた FontDescription を持つ ElementFormat オブジェクトを作成し、getFontMetrics メソッドを使用して、選択したフォントに対するメトリックを表示します。
package {

    import flash.display.Sprite;
    import flash.text.engine.*;

    
    public class FontMetricsExample extends Sprite {
        
        public function FontMetricsExample():void {
            var fd:FontDescription = new FontDescription();
            fd.fontName = "Garamond";
            fd.fontWeight = flash.text.engine.FontWeight.BOLD;

            var ef1:ElementFormat = new ElementFormat(fd);
            var fm1:FontMetrics = ef1.getFontMetrics();
            trace(fm1.emBox);
            trace(fm1.strikethroughOffset);
            trace(fm1.strikethroughThickness);
            trace(fm1.subscriptScale);
            trace(fm1.subscriptOffset);
            trace(fm1.superscriptScale);
            trace(fm1.superscriptOffset);
            trace(fm1.underlineOffset);
            trace(fm1.underlineThickness);
            
            
        }
    }    
}
例の使用法
ElementFormatExample.as

この例では、2 つの ElementFormat オブジェクトを作成し、複数のプロパティを設定します。次に、新しい ElementFormats を TextElement オブジェクトに割り当てます。これは、TextBlock のコンテンツとして割り当てられています。 TextElementElementFormat を変更しても、親 TextBlock によって作成済みの TextLines には影響しません。

package {

    import flash.display.Sprite;
    import flash.text.engine.*;

    
    public class ElementFormatExample extends Sprite {
        
        public function ElementFormatExample():void {
            var fd:FontDescription = new FontDescription();
            fd.fontName = "Garamond";
            fd.fontWeight = flash.text.engine.FontWeight.BOLD;

            var ef1:ElementFormat = new ElementFormat(fd);
            ef1.fontSize = 30;
            ef1.color = 0xFF0000;
            ef1.alpha = 100;
            ef1.kerning = flash.text.engine.Kerning.ON;
            ef1.trackingRight = 2;
            ef1.typographicCase = flash.text.engine.TypographicCase.UPPERCASE;
            ef1.alignmentBaseline = flash.text.engine.TextBaseline.DESCENT;
            ef1.ligatureLevel = flash.text.engine.LigatureLevel.EXOTIC;
            
            var ef2:ElementFormat = new ElementFormat(fd);
            ef2.fontSize = 30;
            ef2.color = 0xFF0000;
            ef2.alpha = 0.3;
            ef2.kerning = flash.text.engine.Kerning.OFF;
            ef2.typographicCase = flash.text.engine.TypographicCase.LOWERCASE;
            ef2.digitCase = flash.text.engine.DigitCase.OLD_STYLE;
            ef2.textRotation = flash.text.engine.TextRotation.ROTATE_180;
            
            var str:String = "This is flash text 0123456789";
            var tb:TextBlock = new TextBlock();
            var te1:TextElement = new TextElement(str, ef1);
            tb.content = te1;
            var line1:TextLine = tb.createTextLine(null, 600);
            addChild(line1);
            line1.x = 15;
            line1.y = 30;

            tb.content.elementFormat = ef2;
            var line2:TextLine = tb.createTextLine(null, 600);
            addChild(line2);
            line2.x = 15;
            line2.y = 60;
            
        }
    }    
}