Adobe® Flash® Platform 用 ActionScript® 3.0 リファレンスガイド
ホーム  |  パッケージおよびクラスリストの非表示 |  パッケージ  |  クラス  |  新機能  |  索引  |  付録  |  英語で表示される理由
フィルター: サーバーからデータを取得しています...
サーバーからデータを取得しています...
flashx.textLayout.formats 

TextLayoutFormat  - AS3

パッケージflashx.textLayout.formats
クラスpublic class TextLayoutFormat
継承TextLayoutFormat Inheritance Object
実装 ITextLayoutFormat
サブクラス ListMarkerFormat

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

TextLayoutFormat クラスは、すべてのテキストレイアウトプロパティを保持します。これらのプロパティは、コンテナレベル、段落レベルおよびテキストレベルでテキストフローのフォーマットおよびスタイルに影響を与えます。ContainerController クラスと FlowElement 基本クラスには format プロパティがあり、これによってクラスに TextLayoutFormat インスタンスを割り当てることができます。TextLayoutFormat オブジェクトをコンテナに割り当てると、コンテナのすべてのコンテンツのフォーマットに影響を与えます。TextLayoutFormat オブジェクトを FlowElement の下位要素に割り当てると、その特定のエレメント(TextFlow、ParagraphElement、DivElement、SpanElement、InlineGraphicElement、LinkElement および TCYElement)のフォーマットが指定されます。format プロパティのほかに、これらのクラスでも個々の TextLayoutFormat プロパティが定義されます。これにより、必要に応じて、そのエレメントの特定のスタイルプロパティの設定を上書きできます。

複数レベルで任意のスタイルを設定できるため、競合が発生する可能性があります。例えば、TextFlow レベルでテキストの色が黒に設定され、SpanElement オブジェクトでは青に設定されることがあります。一般的なルールでは、テキストフローツリーの最下位レベルでの設定が優先されます。このため、合字レベルが TextFlow インスタンスに設定され、DivElement にも設定された場合、DivElement の設定が優先されます。

カスケードスタイルは、下位レベルでスタイル値が未定義の場合、テキストフローの上位レベルからスタイルを採用するプロセスを指します。レンダリングされる時点においてエレメントでスタイルが未定義の場合、デフォルト値が使用されるか、親エレメント値から値がカスケードまたは派生されます。例えば、テキストの透明度(textAlpha プロパティ)が SpanElement オブジェクトでは未定義だが、TextFlow では設定されている場合、TextFlow.textAlpha プロパティの値が SpanElement オブジェクトにカスケードされ、その範囲のテキストに適用されます。カスケード結果(エレメントに適用されたスタイルの合計)は、エレメントの computedFormat プロパティに格納されます。

同様に、ContainerController および FlowElement クラスの userStyles プロパティを使用して、ユーザースタイルを適用できます。このプロパティでは、ユーザースタイルのディクショナリの読み取りまたは書き込みを行い、その設定をコンテナまたはテキストフローエレメントに適用できます。ユーザースタイルディクショナリは、stylename-value のペアで構成されるオブジェクトです。userStyles プロパティで指定されたスタイルは、他のすべてに優先されます。

未定義のスタイルのほとんどは、カスケード時に直接の親から値を継承します。一部のスタイルは、親から値を継承せず、自身のデフォルト値を採用します。

未定義のときに自身のデフォルト値を採用するスタイルプロパティには、 backgroundAlphabackgroundColorcolumnCountcolumnGapcolumnWidthlineBreakpaddingBottompaddingLeftpaddingRightpaddingTopverticalAlign などがあります

例を表示

さらに例を参照

関連する API エレメント



パブリックプロパティ
 プロパティ定義元
  alignmentBaseline : *
行の基準を揃えるベースラインを指定します。
TextLayoutFormat
  backgroundAlpha : *
背景のアルファ(透明)値です(カスケード時に定義されていない場合、デフォルトの値が採用されます)。
TextLayoutFormat
  backgroundColor : *
テキストの背景色です(カスケード時に定義されていない場合、デフォルトの値が採用されます)。
TextLayoutFormat
  baselineShift : *
ベースラインを dominantBaseline 値から移動させる量です。
TextLayoutFormat
  blockProgression : *
垂直方向または並行方向の行配置を指定します。
TextLayoutFormat
  breakOpportunity : *
折り返しのあるテキストを複数行に分割する際の、改行可能位置を制御します。
TextLayoutFormat
  cffHinting : *
このテキストに使用される CFF ヒンティングのタイプです。
TextLayoutFormat
  clearFloats : *
フロートを回り込むようにテキストを配置する方法を制御します。
TextLayoutFormat
  color : *
テキストの色です。
TextLayoutFormat
  columnCount : *
テキスト列の数です(カスケード時に定義されていない場合、デフォルトの値が採用されます)。
TextLayoutFormat
  columnGap : *
列間のふち取り領域をピクセル単位で指定します(カスケード時に定義されていない場合、デフォルトの値が採用されます)。
TextLayoutFormat
  columnWidth : *
列幅(ピクセル単位)です(カスケード時に定義されていない場合、デフォルトの値が採用されます)。
TextLayoutFormat
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。
Object
  coreStyles : Object
[読み取り専用] この TextLayoutFormat の coreStyles を返します。
TextLayoutFormat
  defaultFormat : flashx.textLayout.formats:ITextLayoutFormat
[静的] [読み取り専用] デフォルト設定の TextLayoutFormat オブジェクトを返します。
TextLayoutFormat
  digitCase : *
このテキストに使用される数字の大文字小文字区別のタイプです。
TextLayoutFormat
  digitWidth : *
このテキストに使用される数字の幅のタイプです。
TextLayoutFormat
  direction : *
テキストブロック内のテキストのデフォルトの双方向埋め込みレベルを指定します。
TextLayoutFormat
  dominantBaseline : *
行のエレメントの垂直座標を決定するために alignmentBaseline に吸着させるエレメントのベースラインを指定します。
TextLayoutFormat
  firstBaselineOffset : *
コンテナ内の最初の行のベースライン位置を指定します。
TextLayoutFormat
  fontFamily : *
使用するフォント名またはフォント名のカンマ区切りリストです。
TextLayoutFormat
  fontLookup : *
使用するフォント参照です。
TextLayoutFormat
  fontSize : *
テキストのサイズ(ピクセル単位)です。
TextLayoutFormat
  fontStyle : *
テキストのスタイルです。
TextLayoutFormat
  fontWeight : *
テキストの太さです。
TextLayoutFormat
  justificationRule : *
段落のテキストの均等配置に使用するルールです。
TextLayoutFormat
  justificationStyle : *
段落の均等配置に使用するスタイルです。
TextLayoutFormat
  kerning : *
カーニングでは、読みやすくするために、特定の文字ペア間でピクセルを調整します。
TextLayoutFormat
  leadingModel : *
行送りの基準と行送り方向の組み合わせである、行送りモデルを指定します。
TextLayoutFormat
  ligatureLevel : *
フォントで定義された合字のうち、どの合字がテキストで使用されるかを制御します。
TextLayoutFormat
  lineBreak : *
コンテナ内のテキスト折り返しを制御します(カスケード時に定義されていない場合、デフォルトの値が採用されます)。
TextLayoutFormat
  lineHeight : *
テキストの行送りを制御します。
TextLayoutFormat
  lineThrough : *
true の場合、打ち消し線が適用されます。打ち消し線はテキストの中央に描画される線です。
TextLayoutFormat
  linkActiveFormat : *
通常の状態のリンクに使用されるフォーマット属性を定義します。
TextLayoutFormat
  linkHoverFormat : *
マウスをリンク上で動かしているときに、アクティブ状態のリンクに使用されるフォーマット属性を定義します。
TextLayoutFormat
  linkNormalFormat : *
通常の状態のリンクに使用されるフォーマット属性を定義します。
TextLayoutFormat
  listAutoPadding : *
リストの始端におけるパディング値が auto である場合に、始端に対して自動インデントを指定します。
TextLayoutFormat
  listMarkerFormat : *
フォーマット属性のリストマーカーを定義します。
TextLayoutFormat
  listStylePosition : *
有効な値は、ListStylePosition.INSIDE、ListStylePosition.OUTSIDE、FormatValue.INHERIT です。デフォルト値は定義されていません。つまり、未設定です。カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。
TextLayoutFormat
  listStyleType : *
有効な値は、ListStyleType.UPPER_ALPHA、ListStyleType.LOWER_ALPHA、ListStyleType.UPPER_ROMAN、ListStyleType.LOWER_ROMAN、ListStyleType.NONE、ListStyleType.DISC、ListStyleType.CIRCLE、ListStyleType.SQUARE、ListStyleType.BOX、ListStyleType.CHECK、ListStyleType.DIAMOND、ListStyleType.HYPHEN、ListStyleType.ARABIC_INDIC、ListStyleType.BENGALI、ListStyleType.DECIMAL、ListStyleType.DECIMAL_LEADING_ZERO、ListStyleType.DEVANAGARI、ListStyleType.GUJARATI、ListStyleType.GURMUKHI、ListStyleType.KANNADA、ListStyleType.PERSIAN、ListStyleType.THAI、ListStyleType.URDU、ListStyleType.CJK_EARTHLY_BRANCH、ListStyleType.CJK_HEAVENLY_STEM、ListStyleType.HANGUL、ListStyleType.HANGUL_CONSTANT、ListStyleType.HIRAGANA、ListStyleType.HIRAGANA_IROHA、ListStyleType.KATAKANA、ListStyleType.KATAKANA_IROHA、ListStyleType.LOWER_ALPHA、ListStyleType.LOWER_GREEK、ListStyleType.LOWER_LATIN、ListStyleType.UPPER_ALPHA、ListStyleType.UPPER_GREEK、ListStyleType.UPPER_LATIN、FormatValue.INHERIT です。デフォルト値は定義されていません。つまり、未設定です。カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。
TextLayoutFormat
  locale : *
テキストのロケールです。
TextLayoutFormat
  paddingBottom : *
下部のインセット(ピクセル単位)です。
TextLayoutFormat
  paddingLeft : *
左側のインセットです(ピクセル単位)。
TextLayoutFormat
  paddingRight : *
右側のインセットです(ピクセル単位)。
TextLayoutFormat
  paddingTop : *
上部のインセットです(ピクセル単位)。
TextLayoutFormat
  paragraphEndIndent : *
段落の終端をどれだけインデントするかを指定する数値(ピクセル単位)です。
TextLayoutFormat
  paragraphSpaceAfter : *
段落の後に空けるスペースを指定する数値(ピクセル単位)です。
TextLayoutFormat
  paragraphSpaceBefore : *
段落の前に空けるスペースを指定する数値(ピクセル単位)です。
TextLayoutFormat
  paragraphStartIndent : *
段落の始端をどれだけインデントするかを指定する数値(ピクセル単位)です。
TextLayoutFormat
  renderingMode : *
このテキストに使用されるレンダリングモードです。
TextLayoutFormat
  styleName : *
エレメントに識別クラスを割り当て、styleName を参照することで、エレメントへのスタイルの設定を可能にします。
TextLayoutFormat
  styles : Object
[読み取り専用] この TextLayoutFormat のスタイルを返します。
TextLayoutFormat
  tabStops : *
段落に関連付けるタブストップを指定します。
TextLayoutFormat
  textAlign : *
コンテナを基準とした段落内の行揃えです。
TextLayoutFormat
  textAlignLast : *
均等配置テキストの、コンテナを基準とした段落内の最後(単一)の行の行揃えです。
TextLayoutFormat
  textAlpha : *
テキストのアルファ(透明)値です。
TextLayoutFormat
  textDecoration : *
テキストの装飾です。
TextLayoutFormat
  textIndent : *
段落の一行目をどれだけインデントするかを指定する数値(ピクセル単位)です。
TextLayoutFormat
  textJustify : *
テキストの均等配置オプションを指定します。
TextLayoutFormat
  textRotation : *
テキストの回転角度を決定します。
TextLayoutFormat
  trackingLeft : *
各文字の左側にトラッキング(または手動カーニング)をどれだけ適用するかの数値(ピクセル単位または fontSize のパーセント(120%など))です。
TextLayoutFormat
  trackingRight : *
各文字の右側にトラッキング(または手動カーニング)をどれだけ適用するかの数値(ピクセル単位または fontSize のパーセント(120%など))です。
TextLayoutFormat
  typographicCase : *
このテキストに使用される文字の大文字小文字区別のタイプです。
TextLayoutFormat
  userStyles : Object
[読み取り専用] この TextLayoutFormat の userStyles を返します。
TextLayoutFormat
  verticalAlign : *
垂直方向の行揃えまたは均等配置です(カスケード時に定義されていない場合、デフォルトの値が採用されます)。
TextLayoutFormat
  whiteSpaceCollapse : *
テキストを TextFlow にインポートする際、空白を圧縮または保持します。
TextLayoutFormat
  wordSpacing : *
均等配置に使用する単語間の最適間隔、最小間隔、および最大間隔(通常の間隔幅の倍数)を指定します。
TextLayoutFormat
パブリックメソッド
 メソッド定義元
  
新しい TextLayoutFormat オブジェクトを作成します。
TextLayoutFormat
  
この TextLayoutFormat オブジェクトのプロパティ値を、ITextLayoutFormat インスタンスである incoming で設定されているプロパティ値に置き換えます。
TextLayoutFormat
  
ITextLayoutFormat インスタンスである incoming のプロパティ値を、この TextLayoutFormat オブジェクトの値に連結します。
TextLayoutFormat
  
ITextLayoutFormat インスタンスである incoming のプロパティ値を、この TextLayoutFormat オブジェクトの値に連結します。
TextLayoutFormat
  
TextLayoutFormat 設定を ITextLayoutFormat インスタンスである values からこの TextLayoutFormat オブジェクトにコピーします。
TextLayoutFormat
  
[静的] 新しい TextLayoutFormat オブジェクトを作成します。
TextLayoutFormat
  
getStyle(styleProp:String):*
スタイル名を指定する styleProp パラメーターで指定されたスタイルの値を返します。
TextLayoutFormat
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
  
[静的] ITextLayoutFormat インスタンス p1 のプロパティと ITextLayoutFormat インスタンス p2 のプロパティを比較し、すべてのプロパティが一致する場合は true を返します。
TextLayoutFormat
 Inherited
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
  
この TextLayoutFormat オブジェクトのプロパティが ITextLayoutFormat インスタンスである incoming のプロパティと一致しない場合は、undefined に設定します。
TextLayoutFormat
  
この TextLayoutFormat オブジェクトのプロパティが ITextLayoutFormat インスタンスである incoming のプロパティと一致する場合は、undefined に設定します。
TextLayoutFormat
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
  
setStyle(styleProp:String, newValue:*):void
styleProp パラメーターにより指定されたスタイルの値を、newValue パラメーターで指定する値に設定します。
TextLayoutFormat
 Inherited
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
プロパティの詳細

alignmentBaseline

プロパティ
alignmentBaseline:*

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

行の基準を揃えるベースラインを指定します。例えば、dominantBaseline を ASCENT に設定し、alignmentBaseline を DESCENT に設定すると、テキスト上部が DESCENT ベースライン上またはラインの下に揃えられます。一般に、ベースラインは行内の最大エレメントにより決定されます。

baselines

有効な値は、TextBaseline.ROMAN、TextBaseline.ASCENT、TextBaseline.DESCENT、TextBaseline.IDEOGRAPHIC_TOP、TextBaseline.IDEOGRAPHIC_CENTER、TextBaseline.IDEOGRAPHIC_BOTTOM、TextBaseline.USE_DOMINANT_BASELINE、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は TextBaseline.USE_DOMINANT_BASELINE になります。



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

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント


例  ( この例の使用方法 )
この例は、dominantBaseline が ASCENT に設定されている段落内の 3 つの範囲に対して、3 つの異なる値(USE_DOMINANT_BASELINE、DESCENT および IDEOGRAPHIC_CENTER)で alignmentBaseline を設定します。
package flashx.textLayout.formats.examples {
    import flash.display.Sprite;
    import flash.text.engine.TextBaseline;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.formats.TextAlign;

    public class TextLayoutFormat_alignmentBaselineExample extends Sprite
    {
        public function TextLayoutFormat_alignmentBaselineExample()
        {
            // create text flow with dominantBaseline of ASCENT and 3 spans
            var textFlow:TextFlow = new TextFlow();
            var paragraph:ParagraphElement = new ParagraphElement();
            paragraph.fontFamily = "Helvetica";
            paragraph.fontSize = 20;
            paragraph.dominantBaseline = TextBaseline.ASCENT    
            var spanOne:SpanElement = new SpanElement();
            var spanTwo:SpanElement = new SpanElement();
            var spanThree:SpanElement = new SpanElement();
            spanOne.text = "Hello, World  ";
            spanTwo.text = "Hello, World  ";
            spanThree.text = "Hello, World";
            
            // add spans to paragraph and specify alignment baseline for each
            paragraph.addChild(spanOne);
            spanOne.alignmentBaseline = TextBaseline.USE_DOMINANT_BASELINE;    
            paragraph.addChild(spanTwo);
            spanTwo.alignmentBaseline = TextBaseline.DESCENT;
            paragraph.addChild(spanThree);
            spanThree.alignmentBaseline = TextBaseline.IDEOGRAPHIC_CENTER;
            
            // add paragraph to TextFlow and set container position
            textFlow.addChild(paragraph);
            this.x = 50;
            this.y = 100;
            
            // update controller to display on stage
            textFlow.flowComposer.addController(new ContainerController(this,400,300));
            textFlow.flowComposer.updateAllControllers();    
        }
    }
}

backgroundAlpha

プロパティ 
backgroundAlpha:*

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

背景のアルファ(透明)値です(カスケード時に定義されていない場合、デフォルトの値が採用されます)。値 0 は完全に透明、値 1 は完全に不透明です。alpha が 0 に設定されている表示オブジェクトは、表示されない場合でも、アクティブです。

有効な値は、0 ~ 1 の数値および FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティの値は 1 になります。



実装
    public function get backgroundAlpha():*
    public function set backgroundAlpha(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

backgroundColor

プロパティ 
backgroundColor:*

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

テキストの背景色です(カスケード時に定義されていない場合、デフォルトの値が採用されます)。BackgroundColor.TRANSPARENT の定数値、または 3 つの 8 bit の RGB(赤、緑、青)値を指定する 16 進値のいずれかを指定できます。例えば、0xFF0000 は赤、0x00FF00 は緑です。

有効な値は、BackgroundColor.TRANSPARENT、FormatValue.INHERIT の文字列、および 0x0 から 0xffffffff の uint です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティの値は BackgroundColor.TRANSPARENT になります。



実装
    public function get backgroundColor():*
    public function set backgroundColor(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

baselineShift

プロパティ 
baselineShift:*

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

ベースラインを dominantBaseline 値から移動させる量です。単位は、ピクセルまたは fontSize のパーセント値(この場合は 140%のように文字列値を入力)です。正の値を指定すると、行は横書きの場合は上に(縦書きの場合は右に)移動し、負の値を指定すると、行は横書きの場合は下に(縦書きの場合は左に)移動します。

有効な値は、BaselineShift.SUPERSCRIPT、BaselineShift.SUBSCRIPT、FormatValue.INHERIT です。

有効な数値は、-1000 ~ 1000 です。

有効なパーセント値は、-1000 ~ 1000 の数値です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は 0.0 になります。



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

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

blockProgression

プロパティ 
blockProgression:*

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

垂直方向または並行方向の行配置を指定します。行は、上から下(横書用の BlockProgression.TB)または右から左(縦書用の BlockProgression.RL)に配置されます。

有効な値は、BlockProgression.RL、BlockProgression.TB、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は BlockProgression.TB になります。



実装
    public function get blockProgression():*
    public function set blockProgression(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

breakOpportunity

プロパティ 
breakOpportunity:*

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

折り返しのあるテキストを複数行に分割する際の、改行可能位置を制御します。テキストを標準的に改行する場合は、BreakOpportunity.AUTO に設定します。テキストがサイズを超過し、改行する場所が他にない場合以外は改行しない場合は、BreakOpportunity.NONE に設定します。単語間のみでなく、どの位置でも改行を許可する場合は、BreakOpportunity.ANY に設定します。タイポグラフィッククラスタごとに改行する場合は、BreakOpportunity.ALL に設定します(パス上のテキストに有効)。

有効な値は、BreakOpportunity.ALL、BreakOpportunity.ANY、BreakOpportunity.AUTO、BreakOpportunity.NONE、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は BreakOpportunity.AUTO になります。



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

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

cffHinting

プロパティ 
cffHinting:*

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

このテキストに使用される CFF ヒンティングのタイプです。CFF ヒンティングによって、Flash ランタイムで太い水平線がサブピクセルグリッドに合わされるか合わされないかが決定されます。このプロパティは、renderingMode プロパティが RenderingMode.CFF に設定されていて、フォントが埋め込まれている(fontLookup プロパティが FontLookup.EMBEDDED_CFF に設定されている)場合にのみ適用されます。スクリーンサイズが小さい場合は、ヒンティングによって、鮮明で読みやすいテキストの表示が可能になります。

有効な値は、CFFHinting.NONE、CFFHinting.HORIZONTAL_STEM、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は CFFHinting.HORIZONTAL_STEM になります。



実装
    public function get cffHinting():*
    public function set cffHinting(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

clearFloats

プロパティ 
clearFloats:*

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

フロートを回り込むようにテキストを配置する方法を制御します。値「none」を使用すると、テキストはフロートのすぐ近くに回り込んで配置されます。値「left」を使用すると、テキストは左フロートを設定されているコンテナ全体を飛び越えて配置されます。値「right」を使用すると、テキストは右フロートを設定されているコンテナ全体を飛び越えて配置されます。値「both」を使用すると、テキストはすべてのフロートを飛び越えて配置されます。

有効な値は、ClearFloats.STARTClearFloats.ENDClearFloats.LEFTClearFloats.RIGHTClearFloats.BOTHClearFloats.NONE および FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティの値は ClearFloats.NONE になります。



実装
    public function get clearFloats():*
    public function set clearFloats(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

color

プロパティ 
color:*

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

テキストの色です。3 つの 8 bit の RGB(赤、緑、青)値を指定する 16 進値を指定できます。例えば、0xFF0000 は赤、0x00FF00 は緑です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は 0 になります。



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

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

columnCount

プロパティ 
columnCount:*

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

テキスト列の数です(カスケード時に定義されていない場合、デフォルトの値が採用されます)。列数は、列の他の設定をオーバーライドします。値は整数か、指定されない場合は FormatValue.AUTO になります。columnCount が指定されない場合は、columnWidth により、コンテナに収まる最大数の列が作成されます。

有効な値は、FormatValue.AUTO、FormatValue.INHERIT の文字列および 1 ~ 50 の int です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティの値は FormatValue.AUTO になります。



実装
    public function get columnCount():*
    public function set columnCount(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

columnGap

プロパティ 
columnGap:*

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

列間のふち取り領域をピクセル単位で指定します(カスケード時に定義されていない場合、デフォルトの値が採用されます)。値は数値で指定します。

有効な値は、0 ~ 1000 の数値および FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティの値は 20 になります。



実装
    public function get columnGap():*
    public function set columnGap(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

columnWidth

プロパティ 
columnWidth:*

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

列幅(ピクセル単位)です(カスケード時に定義されていない場合、デフォルトの値が採用されます)。列の幅を指定して列の数を指定しない場合、TextLayout により、コンテナ幅と columnGap の設定に基づき、その幅の列が可能な限り最大数作成されます。余りのスペースがある場合は、最後の列の後に置かれます。値は数値で指定します。

有効な値は、FormatValue.AUTO、FormatValue.INHERIT の文字列および 0 ~ 8000 の数値です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティの値は FormatValue.AUTO になります。



実装
    public function get columnWidth():*
    public function set columnWidth(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

coreStyles

プロパティ 
coreStyles:Object  [読み取り専用]

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

この TextLayoutFormat の coreStyles を返します。 coreStyles オブジェクトには、TextLayoutFormat で定義され、TextLayoutFormat.description 内にあるフォーマットが含まれます。 返される coreStyles オブジェクトは、stylename-value ペアの配列により構成されています。



実装
    public function get coreStyles():Object

関連する API エレメント

defaultFormat

プロパティ 
defaultFormat:flashx.textLayout.formats:ITextLayoutFormat  [読み取り専用]

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

デフォルト設定の TextLayoutFormat オブジェクトを返します。このメソッドは、常に同じオブジェクトを返します。



実装
    public static function get defaultFormat():flashx.textLayout.formats:ITextLayoutFormat

digitCase

プロパティ 
digitCase:*

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

このテキストに使用される数字の大文字小文字区別のタイプです。値を DigitCase.OLD_STYLE に設定すると、様々なアセンダとディセンダを持つ小文字の書体に近づきます。その文字幅は形状によって設定されます。このスタイルは、選択した書体(最も一般的には Supplemental フォントまたは Expert フォント)でのみ有効です。DigitCase.LINING に設定すると、大文字全体の高さとなり、一般にグラフで整列させる場合に文字幅が等幅になります。

digitCase

有効な値は、DigitCase.DEFAULT、DigitCase.LINING、DigitCase.OLD_STYLE、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は DigitCase.DEFAULT になります。



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

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

digitWidth

プロパティ 
digitWidth:*

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

このテキストに使用される数字の幅のタイプです。値は、個々の数字を表示する場合に最適な DigitWidth.PROPORTIONAL と、表、グラフおよび縦の列に数字を表示する場合に最適な DigitWidth.TABULAR があります。

digitWidth

有効な値は、DigitWidth.DEFAULT、DigitWidth.PROPORTIONAL、DigitWidth.TABULAR、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は DigitWidth.DEFAULT になります。



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

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

direction

プロパティ 
direction:*

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

テキストブロック内のテキストのデフォルトの双方向埋め込みレベルを指定します。ラテン文字などでは左から右の読み順、アラビア文字やヘブライ文字などでは右から左の読み順となります。このプロパティは、コンテナレベルで適用された場合、列の方向にも影響します。列もテキストと同様、左から右、または右から左のいずれかに設定できます。以下に例を示します。

direction

有効な値は、Direction.LTR、Direction.RTL、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は Direction.LTR になります。



実装
    public function get direction():*
    public function set direction(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

dominantBaseline

プロパティ 
dominantBaseline:*

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

行のエレメントの垂直座標を決定するために alignmentBaseline に吸着させるエレメントのベースラインを指定します。TextBaseline.AUTO を指定した場合、親段落の locale プロパティに基づいて、行の基準が選択されます。日本語と中国語の場合、選択されるベースラインの値は TextBaseline.IDEOGRAPHIC_CENTER で、他のすべての言語では TextBaseline.ROMAN となります。ベースラインに関するこれらの選択は、フォントおよびフォントサイズの選択によって決定されます。

baselines

有効な値は、FormatValue.AUTO、TextBaseline.ROMAN、TextBaseline.ASCENT、TextBaseline.DESCENT、TextBaseline.IDEOGRAPHIC_TOP、TextBaseline.IDEOGRAPHIC_CENTER、TextBaseline.IDEOGRAPHIC_BOTTOM、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は FormatValue.AUTO になります。



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

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

firstBaselineOffset

プロパティ 
firstBaselineOffset:*

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

コンテナ内の最初の行のベースライン位置を指定します。このプロパティがどのベースラインを参照するかは、コンテナレベルのロケールにより異なります。これは、日本語と中国語で TextBaseline.IDEOGRAPHIC_BOTTOM、他のすべての言語で TextBaseline.ROMAN となります。コンテナの上部のインセット(blockProgression が RL の場合は右側のインセット)から 1 行目のベースラインへのオフセットの値には、BaselineOffset.ASCENT(行のアセント)、BaselineOffset.LINE_HEIGHT(1 行目の高さ)、または絶対距離を指定する任意の固定数値を指定できます。BaselineOffset.AUTO に指定すると、行のアセントとコンテナの上部のインセットが揃えられます。

firstBaselineOffset1firstBaselineOffset2firstBaselineOffset3firstBaselineOffset4

有効な値は、BaselineOffset.AUTO、BaselineOffset.ASCENT、BaselineOffset.LINE_HEIGHT、FormatValue.INHERIT の文字列および 0 ~ 1000 の数値です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は BaselineOffset.AUTO になります。



実装
    public function get firstBaselineOffset():*
    public function set firstBaselineOffset(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

fontFamily

プロパティ 
fontFamily:*

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

使用するフォント名またはフォント名のカンマ区切りリストです。 リスト内の使用できる先頭のフォントを使用してエレメントをレンダリングします。例えば、「Arial」、「Helvetica」、「_sans」の場合は、「Arial」が検索され、Arial が見つからないときは「Helvetica」が、それらがいずれも見つからないときは「_sans」が検索されます。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は Arial になります。



実装
    public function get fontFamily():*
    public function set fontFamily(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

fontLookup

プロパティ 
fontLookup:*

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

使用するフォント参照です。FontLookup.DEVICE に指定すると、SWF ファイルが実行されるシステムにインストールされているフォントが使用されます。デバイスフォントを使用するとムービーサイズが小さくなりますが、異なるシステムおよびプラットフォームで、テキストが必ずしも同じようにレンダリングされる訳ではありません。FontLookup.EMBEDDED_CFF に指定すると、パブリッシュされた SWF ファイルに埋め込まれたフォントのアウトラインが使用されます。埋め込みフォントを使用すると、SWF ファイルのサイズが(ときには大幅に)大きくなりますが、テキストは常に選択されたフォントで表示されます。

有効な値は、FontLookup.DEVICE、FontLookup.EMBEDDED_CFF、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は FontLookup.DEVICE になります。



実装
    public function get fontLookup():*
    public function set fontLookup(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

fontSize

プロパティ 
fontSize:*

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

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

有効な値は、1 ~ 720 の数値および FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は 12 になります。



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

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

fontStyle

プロパティ 
fontStyle:*

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

テキストのスタイルです。プレーンテキストには FontPosture.NORMAL、イタリックには FontPosture.ITALIC を使用します。このプロパティは、デバイスフォント(fontLookup プロパティが flash.text.engine.FontLookup.DEVICE に設定されている場合)にのみ適用されます。

有効な値は、FontPosture.NORMAL、FontPosture.ITALIC、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は FontPosture.NORMAL になります。



実装
    public function get fontStyle():*
    public function set fontStyle(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

fontWeight

プロパティ 
fontWeight:*

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

テキストの太さです。プレーンテキスト用の FontWeight.NORMAL、または FontWeight.BOLD を使用します。デバイスフォント(fontLookup プロパティが flash.text.engine.FontLookup.DEVICE に設定されている場合)にのみ適用されます。

有効な値は、FontWeight.NORMAL、FontWeight.BOLD、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は FontWeight.NORMAL になります。



実装
    public function get fontWeight():*
    public function set fontWeight(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

justificationRule

プロパティ 
justificationRule:*

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

段落のテキストの均等配置に使用するルールです。デフォルト値は FormatValue.AUTO で、段落の locale プロパティに基づいてテキストの均等配置が行われます。日本語と中国語以外のすべての言語では、FormatValue.AUTOJustificationRule.SPACE になり、空白文字に追加のスペースが追加されます。日本語と中国語の場合、FormatValue.AUTOJustficationRule.EAST_ASIAN になります。均等配置によって、句読点のスペース設定の一部が変更されます。ローマンテキストの場合、カンマと日本語の句点には 1 文字分の幅を使用しますが、日中韓のテキストでは半文字分しか使用しません。また、従来の日中韓の活字規則に従って、連続する句読点間のスペースは狭くなります。次の例の、段落の 2 行目に適用された行送りにも注目してください。日中韓では、最後の 2 行が左に寄せられます。ローマンでは、2 行目以降が左に寄せられます。

justificationRule

有効な値は、JustificationRule.EAST_ASIAN、JustificationRule.SPACE、FormatValue.AUTO、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は FormatValue.AUTO になります。



実装
    public function get justificationRule():*
    public function set justificationRule(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

justificationStyle

プロパティ 
justificationStyle:*

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

段落の均等配置に使用するスタイルです。JustificationRule.EAST_ASIANjustificationRule 設定との連携でのみ使用します。デフォルト値の FormatValue.AUTO は、すべてのロケールで JustificationStyle.PUSH_IN_KINSOKU に解決されます。JustificationStyle クラスで定義される定数値は、禁則文字の取扱いオプションを指定します。禁則文字とは日本語の文字で、行の最初や最後にすることのできない文字です。テキストの文字間隔を狭くしたくない場合は、JustificationStyle.PUSH-OUT-ONLY を指定します。JustificationRule.SPACEjustificationRule のような効果を得たい場合は、JustificationStyle.PRIORITIZE-LEAST-ADJUSTMENT を使用します。

有効な値は、JustificationStyle.PRIORITIZE_LEAST_ADJUSTMENT、JustificationStyle.PUSH_IN_KINSOKU、JustificationStyle.PUSH_OUT_ONLY、FormatValue.AUTO、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は FormatValue.AUTO になります。



実装
    public function get justificationStyle():*
    public function set justificationStyle(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

kerning

プロパティ 
kerning:*

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

カーニングでは、読みやすくするために、特定の文字ペア間でピクセルを調整します。カーニングは、カーニングテーブルを持つすべてのフォントに対してサポートされています。

有効な値は、Kerning.ON、Kerning.OFF、Kerning.AUTO、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は Kerning.AUTO になります。



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

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

leadingModel

プロパティ 
leadingModel:*

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

行送りの基準と行送り方向の組み合わせである、行送りモデルを指定します。行送り基準は、lineHeight プロパティが参照するベースラインです。行送り方向は、lineHeight プロパティが参照する特定の行までの距離が、その行の前の行のベースラインを基点とするのか、それともその行の後の行のベースラインを基点とするのかを決定します。デフォルト値の FormatValue.AUTO は、段落の locale プロパティに基づいて解決されます。これは、日本語と中国語で LeadingModel.IDEOGRAPHIC_TOP_DOWN、他のすべての言語で LeadingModel.ROMAN_UP_UP となります。

行送りの基準:

leadingBasis1 leadingBasis2 leadingBasis3

行送り方向:

leadingDirection1 leadingDirection2 leadingDirection3

有効な値は、LeadingModel.ROMAN_UP、LeadingModel.IDEOGRAPHIC_TOP_UP、LeadingModel.IDEOGRAPHIC_CENTER_UP、LeadingModel.IDEOGRAPHIC_TOP_DOWN、LeadingModel.IDEOGRAPHIC_CENTER_DOWN、LeadingModel.APPROXIMATE_TEXT_FIELD、LeadingModel.ASCENT_DESCENT_UP、LeadingModel.BOX、LeadingModel.AUTO、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は LeadingModel.AUTO になります。



実装
    public function get leadingModel():*
    public function set leadingModel(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

ligatureLevel

プロパティ 
ligatureLevel:*

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

フォントで定義された合字のうち、どの合字がテキストで使用されるかを制御します。これらの各設定に出現する合字は、フォントによって異なります。2 つ以上の letter-form が 1 つの文字に結合された場合には、合字が起こります。合字は通常、「fi」、「fl」、「ae」などの文字の組の用に共通のコンポーネントを共有する連続した文字を置き換えます。合字は、ラテン語およびラテン語以外の文字セットの両方で使用されます。LigatureLevel クラス(MINIMUMCOMMONUNCOMMONEXOTIC)の値で有効化された合字は、追加的なものです。各値によって新しい合字が有効になりますが、以前からの型も含まれます。

注意:アラビア語またはシリア語フォントを使用する場合は、ligatureLevel を MINIMUM 以上に設定する必要があります。

ligatureLevel

有効な値は、LigatureLevel.MINIMUM、LigatureLevel.COMMON、LigatureLevel.UNCOMMON、LigatureLevel.EXOTIC、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は LigatureLevel.COMMON になります。



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

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

lineBreak

プロパティ 
lineBreak:*

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

コンテナ内のテキスト折り返しを制御します(カスケード時に定義されていない場合、デフォルトの値が採用されます)。コンテナ内のテキストを、コンテナの幅に収まるよう設定(LineBreak.TO_FIT)するか、明示的な復帰またはラインフィード文字の箇所でのみ改行するよう設定(LineBreak.EXPLICIT)できます。

有効な値は、LineBreak.EXPLICIT、LineBreak.TO_FIT、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティの値は LineBreak.TO_FIT になります。



実装
    public function get lineBreak():*
    public function set lineBreak(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

lineHeight

プロパティ 
lineHeight:*

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

テキストの行送りを制御します。LeadingModel に基づいた、前または次の行のベースラインから現在の行のベースラインまでの距離は、行内の任意の文字に適用される最大行送り値と等しくなります。これは、数値またはパーセントのいずれかで指定します。パーセントで指定する場合、140%などのように文字列値を入力します。

lineHeight1lineHeight2

有効な数値は、-720 ~ 720 です。

有効なパーセント値は、-1000 ~ 1000%の数値です。

有効な値には、FormatValue.INHERIT があります。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は 120%になります。



実装
    public function get lineHeight():*
    public function set lineHeight(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

lineThrough

プロパティ 
lineThrough:*

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

true の場合、打ち消し線が適用されます。打ち消し線はテキストの中央に描画される線です。

有効な値は、true、false、および FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は false になります。



実装
    public function get lineThrough():*
    public function set lineThrough(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

linkActiveFormat

プロパティ 
linkActiveFormat:*

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

通常の状態のリンクに使用されるフォーマット属性を定義します。この値は、下位の階層に伝達され、下位要素のリンクがある場合はそれらのリンクにも適用されます。 inheritITextLayoutFormat を受け入れるか、またはキーと値をメンバーとして持つオブジェクトの配列を TextLayoutFormat に変換します。

有効な値には、FormatValue.INHERIT があります。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は null になります。



実装
    public function get linkActiveFormat():*
    public function set linkActiveFormat(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

linkHoverFormat

プロパティ 
linkHoverFormat:*

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

マウスをリンク上で動かしているときに、アクティブ状態のリンクに使用されるフォーマット属性を定義します。この値は、下位の階層に伝達され、下位要素のリンクがある場合はそれらのリンクにも適用されます。 inheritITextLayoutFormat を受け入れるか、またはキーと値をメンバーとして持つオブジェクトの配列を TextLayoutFormat に変換します。

有効な値には、FormatValue.INHERIT があります。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は null になります。



実装
    public function get linkHoverFormat():*
    public function set linkHoverFormat(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

linkNormalFormat

プロパティ 
linkNormalFormat:*

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

通常の状態のリンクに使用されるフォーマット属性を定義します。この値は、下位の階層に伝達され、下位要素のリンクがある場合はそれらのリンクにも適用されます。 inheritITextLayoutFormat を受け入れるか、またはキーと値をメンバーとして持つオブジェクトの配列を TextLayoutFormat に変換します。

有効な値には、FormatValue.INHERIT があります。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は null になります。



実装
    public function get linkNormalFormat():*
    public function set linkNormalFormat(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

listAutoPadding

プロパティ 
listAutoPadding:*

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

リストの始端におけるパディング値が auto である場合に、始端に対して自動インデントを指定します。

有効な値は、-1000 ~ 1000 の数値および FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は 40 になります。



実装
    public function get listAutoPadding():*
    public function set listAutoPadding(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

listMarkerFormat

プロパティ 
listMarkerFormat:*

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

フォーマット属性のリストマーカーを定義します。この値は、下位の階層に伝達され、下位要素のリンクがある場合はそれらのリンクにも適用されます。 inheritIListMarkerFormat を受け入れるか、またはキーと値をメンバーとして持つオブジェクトの配列を ListMarkerFormat に変換します。

有効な値には、FormatValue.INHERIT があります。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は null になります。



実装
    public function get listMarkerFormat():*
    public function set listMarkerFormat(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

listStylePosition

プロパティ 
listStylePosition:*

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

有効な値は、ListStylePosition.INSIDE、ListStylePosition.OUTSIDE、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は ListStylePosition.OUTSIDE になります。



実装
    public function get listStylePosition():*
    public function set listStylePosition(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

listStyleType

プロパティ 
listStyleType:*

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

有効な値は、ListStyleType.UPPER_ALPHA、ListStyleType.LOWER_ALPHA、ListStyleType.UPPER_ROMAN、ListStyleType.LOWER_ROMAN、ListStyleType.NONE、ListStyleType.DISC、ListStyleType.CIRCLE、ListStyleType.SQUARE、ListStyleType.BOX、ListStyleType.CHECK、ListStyleType.DIAMOND、ListStyleType.HYPHEN、ListStyleType.ARABIC_INDIC、ListStyleType.BENGALI、ListStyleType.DECIMAL、ListStyleType.DECIMAL_LEADING_ZERO、ListStyleType.DEVANAGARI、ListStyleType.GUJARATI、ListStyleType.GURMUKHI、ListStyleType.KANNADA、ListStyleType.PERSIAN、ListStyleType.THAI、ListStyleType.URDU、ListStyleType.CJK_EARTHLY_BRANCH、ListStyleType.CJK_HEAVENLY_STEM、ListStyleType.HANGUL、ListStyleType.HANGUL_CONSTANT、ListStyleType.HIRAGANA、ListStyleType.HIRAGANA_IROHA、ListStyleType.KATAKANA、ListStyleType.KATAKANA_IROHA、ListStyleType.LOWER_ALPHA、ListStyleType.LOWER_GREEK、ListStyleType.LOWER_LATIN、ListStyleType.UPPER_ALPHA、ListStyleType.UPPER_GREEK、ListStyleType.UPPER_LATIN、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は ListStyleType.DISC になります。



実装
    public function get listStyleType():*
    public function set listStyleType(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

locale

プロパティ 
locale:*

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

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

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は en になります。



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

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

paddingBottom

プロパティ 
paddingBottom:*

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

下部のインセット(ピクセル単位)です。auto のデフォルト値は、始端のパディングが 45 であるリストを除いて 0 です。 (カスケード時に定義されていない場合、デフォルトの値が採用されます)。 コンテナの下端とテキストの間のスペースです。 値は数値または auto です。

複数列を含むスクロール可能なコンテナ内の横書きの場合、1 列目とそれに続く列にはコンテナの最下部に空白スペースとしてパディングが表示されますが、最後の列にテキストがすべて収まらない場合、パディングを表示するにはスクロールする必要があります。

有効な値は、FormatValue.AUTO、FormatValue.INHERIT の文字列および -8000 ~ 8000 の数値です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティの値は FormatValue.AUTO になります。



実装
    public function get paddingBottom():*
    public function set paddingBottom(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

paddingLeft

プロパティ 
paddingLeft:*

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

左側のインセットです(ピクセル単位)。auto のデフォルト値は、始端のパディングが 45 であるリストを除いて 0 です。 (カスケード時に定義されていない場合、デフォルトの値が採用されます)。 コンテナの左端とテキストの間のスペースです。 値は数値または auto です。

複数列を含むスクロール可能なコンテナ内の縦書きの場合、1 列目とそれに続く列にはコンテナの末尾に空白スペースとしてパディングが表示されますが、最後の列にテキストがすべて収まらない場合、パディングを表示するにはスクロールする必要があります。

有効な値は、FormatValue.AUTO、FormatValue.INHERIT の文字列および -8000 ~ 8000 の数値です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティの値は FormatValue.AUTO になります。



実装
    public function get paddingLeft():*
    public function set paddingLeft(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

paddingRight

プロパティ 
paddingRight:*

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

右側のインセットです(ピクセル単位)。auto のデフォルト値は、始端のパディングが 45 であるリストを除いて 0 です。 (カスケード時に定義されていない場合、デフォルトの値が採用されます)。 コンテナの右端とテキストの間のスペースです。値は数値または auto です。

有効な値は、FormatValue.AUTO、FormatValue.INHERIT の文字列および -8000 ~ 8000 の数値です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティの値は FormatValue.AUTO になります。



実装
    public function get paddingRight():*
    public function set paddingRight(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

paddingTop

プロパティ 
paddingTop:*

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

上部のインセットです(ピクセル単位)。auto のデフォルト値は、始端のパディングが 45 であるリストを除いて 0 です。 (カスケード時に定義されていない場合、デフォルトの値が採用されます)。 コンテナの上端とテキストの間のスペースです。値は数値または auto です。

有効な値は、FormatValue.AUTO、FormatValue.INHERIT の文字列および -8000 ~ 8000 の数値です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティの値は FormatValue.AUTO になります。



実装
    public function get paddingTop():*
    public function set paddingTop(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

paragraphEndIndent

プロパティ 
paragraphEndIndent:*

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

段落の終端をどれだけインデントするかを指定する数値(ピクセル単位)です。左から右のテキストでは右端、右から左のテキストでは左端です。

有効な値は、0 ~ 8000 の数値および FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は 0 になります。



実装
    public function get paragraphEndIndent():*
    public function set paragraphEndIndent(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

paragraphSpaceAfter

プロパティ 
paragraphSpaceAfter:*

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

段落の後に空けるスペースを指定する数値(ピクセル単位)です。paragraphSpaceBefore と連動して折りたたみを行います。

有効な値は、0 ~ 8000 の数値および FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は 0 になります。



実装
    public function get paragraphSpaceAfter():*
    public function set paragraphSpaceAfter(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

paragraphSpaceBefore

プロパティ 
paragraphSpaceBefore:*

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

段落の前に空けるスペースを指定する数値(ピクセル単位)です。paragraphSpaceAfter と連動して折りたたみを行います。

有効な値は、0 ~ 8000 の数値および FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は 0 になります。



実装
    public function get paragraphSpaceBefore():*
    public function set paragraphSpaceBefore(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

paragraphStartIndent

プロパティ 
paragraphStartIndent:*

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

段落の始端をどれだけインデントするかを指定する数値(ピクセル単位)です。左から右のテキストでは左端、右から左のテキストでは右端です。

有効な値は、0 ~ 8000 の数値および FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は 0 になります。



実装
    public function get paragraphStartIndent():*
    public function set paragraphStartIndent(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

renderingMode

プロパティ 
renderingMode:*

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

このテキストに使用されるレンダリングモードです。埋め込みフォント(fontLookup プロパティが FontLookup.EMBEDDED_CFF に設定されている場合)にのみ適用されます。

有効な値は、RenderingMode.NORMAL、RenderingMode.CFF、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は RenderingMode.CFF になります。



実装
    public function get renderingMode():*
    public function set renderingMode(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

styleName

プロパティ 
styleName:*

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

エレメントに識別クラスを割り当て、styleName を参照することで、エレメントへのスタイルの設定を可能にします。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティの値は null になります。



実装
    public function get styleName():*
    public function set styleName(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

styles

プロパティ 
styles:Object  [読み取り専用]

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

この TextLayoutFormat のスタイルを返します。getter によりスタイルのディクショナリが作成されることに注意してください。 coreStyles オブジェクトは、フォーマットプロパティで設定されたすべてのスタイル(コアスタイルとユーザースタイルを含む)をカプセル化します。 返されるオブジェクトは、stylename-value ペアの配列により構成されています。



実装
    public function get styles():Object

関連する API エレメント

tabStops

プロパティ 
tabStops:*

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

段落に関連付けるタブストップを指定します。Setter は、TabStopFormat の配列、圧縮されたストリング表現、undefined、または FormatValue.INHERIT を受け入れることができます。圧縮されたストリング表現は、常に TabStopFormat の配列に変換されます。

文字列ベースのフォーマットはタブストップのリストです。リスト内で各タブストップは 1 つ以上のスペースにより区切られます。

タブストップの形式は、<整列タイプ><整列位置>|<整列トークン> です。

整列タイプは単一文字で、S、E、C または D(またはそれぞれの小文字)を指定できます。S または s で先頭、E または e で最後尾、C または c で中心、D または d で 10 進法に対応します。整列タイプはオプションで、指定しない場合は S にデフォルト設定されます。

整列位置は数値で、数値用の FXG スペック(10 進数表記または科学的表記)に従って指定します。整列位置は必須です。

垂直バーは、整列位置と整列トークンを区切るために使用され、整列トークンが存在する場合にのみ表示されます。

整列トークンは、整列タイプが D の場合はオプションで、整列タイプが D 以外の場合は指定できません。整列トークンは、タブストップを終了させるスペースで終了する任意の一連の文字で指定できます(最後のタブストップでは、終了のためのスペースはオプションとなります。つまり整列トークンの終了が示唆されます)。スペースがバックスラッシュ(¥)によりエスケープされている場合、スペースは整列トークンの一部である可能性があります。バックスラッシュが他のバックスラッシュ(¥¥)によりエスケープされる場合、バックスラッシュは整列トークンの一部である可能性があります。整列タイプが D で、整列トークンが指定されない場合、null のデフォルト値が適用されます。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は null になります。



実装
    public function get tabStops():*
    public function set tabStops(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

textAlign

プロパティ 
textAlign:*

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

コンテナを基準とした段落内の行揃えです。TextAlign.LEFT に設定すると、コンテナの左端に沿って行揃えされます。TextAlign.RIGHT に設定すると、右端に行揃えされます。TextAlign.CENTER に設定すると、右端と左端から等距離になるよう行が配置されます。TextAlign.JUSTIFY に設定すると、行はスペースを埋めるよう拡がります。TextAlign.START は、左から右のテキストでの LEFT の指定、または右から左のテキストでの RIGHT の指定と同様です。TextAlign.END は、左から右のテキストでの RIGHT の指定、または右から左のテキストでの LEFT の指定と同様です。

有効な値は、TextAlign.LEFT、TextAlign.RIGHT、TextAlign.CENTER、TextAlign.JUSTIFY、TextAlign.START、TextAlign.END、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は TextAlign.START になります。



実装
    public function get textAlign():*
    public function set textAlign(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

textAlignLast

プロパティ 
textAlignLast:*

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

均等配置テキストの、コンテナを基準とした段落内の最後(単一)の行の行揃えです。textAlignTextAlign.JUSTIFY に設定されている場合、textAlignLast は、最後の行(または単一行ブロックの場合は単一行)をどのように行揃えするかを指定します。値は、textAlign と同じです。

有効な値は、TextAlign.LEFT、TextAlign.RIGHT、TextAlign.CENTER、TextAlign.JUSTIFY、TextAlign.START、TextAlign.END、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は TextAlign.START になります。



実装
    public function get textAlignLast():*
    public function set textAlignLast(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

textAlpha

プロパティ 
textAlpha:*

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

テキストのアルファ(透明)値です。値 0 は完全に透明、値 1 は完全に不透明です。textAlpha が 0 に設定されている表示オブジェクトは、表示されない場合でも、アクティブです。

有効な値は、0 ~ 1 の数値および FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は 1 になります。



実装
    public function get textAlpha():*
    public function set textAlpha(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

textDecoration

プロパティ 
textDecoration:*

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

テキストの装飾です。アンダーラインを適用する場合に使用します。デフォルトは、なしです。

有効な値は、TextDecoration.NONE、TextDecoration.UNDERLINE、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は TextDecoration.NONE になります。



実装
    public function get textDecoration():*
    public function set textDecoration(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

textIndent

プロパティ 
textIndent:*

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

段落の一行目をどれだけインデントするかを指定する数値(ピクセル単位)です。一行目インデントをマイナスに指定すると、行はインデント内に寄せられ、コンテナより外に押し出される場合もあります。

有効な値は、-8000 ~ 8000 の数値および FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は 0 になります。



実装
    public function get textIndent():*
    public function set textIndent(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

textJustify

プロパティ 
textJustify:*

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

テキストの均等配置オプションを指定します。デフォルト値は TextJustify.INTER_WORD で、空白文字に追加のスペースが追加されます。TextJustify.DISTRIBUTE は、空白文字や個々の文字間に追加のスペースを追加します。JustificationRule.SPACEjustificationRule 値との連携でのみ使用します。

有効な値は、TextJustify.INTER_WORD、TextJustify.DISTRIBUTE、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は TextJustify.INTER_WORD になります。



実装
    public function get textJustify():*
    public function set textJustify(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

textRotation

プロパティ 
textRotation:*

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

テキストの回転角度を決定します。

有効な値は、TextRotation.ROTATE_0、TextRotation.ROTATE_180、TextRotation.ROTATE_270、TextRotation.ROTATE_90、TextRotation.AUTO、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は TextRotation.AUTO になります。



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

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

trackingLeft

プロパティ 
trackingLeft:*

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

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

有効な数値は、-1000 ~ 1000 です。

有効なパーセント値は、-1000 ~ 1000%の数値です。

有効な値には、FormatValue.INHERIT があります。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は 0 になります。



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

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

trackingRight

プロパティ 
trackingRight:*

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

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

有効な数値は、-1000 ~ 1000 です。

有効なパーセント値は、-1000 ~ 1000%の数値です。

有効な値には、FormatValue.INHERIT があります。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は 0 になります。



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

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

typographicCase

プロパティ 
typographicCase:*

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

このテキストに使用される文字の大文字小文字区別のタイプです。次に例を示します。

typographicCase

有効な値は、TLFTypographicCase.DEFAULT、TLFTypographicCase.CAPS_TO_SMALL_CAPS、TLFTypographicCase.UPPERCASE、TLFTypographicCase.LOWERCASE、TLFTypographicCase.LOWERCASE_TO_SMALL_CAPS、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は TLFTypographicCase.DEFAULT になります。



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

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

userStyles

プロパティ 
userStyles:Object  [読み取り専用]

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

この TextLayoutFormat の userStyles を返します。 userStyles オブジェクトには、TextLayoutFormat で定義され、TextLayoutFormat.description 内にないフォーマットが含まれます。 返される userStyles オブジェクトは、stylename-value ペアの配列により構成されています。



実装
    public function get userStyles():Object

関連する API エレメント

verticalAlign

プロパティ 
verticalAlign:*

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

垂直方向の行揃えまたは均等配置です(カスケード時に定義されていない場合、デフォルトの値が採用されます)。コンテナ内で TextFlow エレメントを整列させる方法を決定します。

有効な値は、VerticalAlign.TOP、VerticalAlign.MIDDLE、VerticalAlign.BOTTOM、VerticalAlign.JUSTIFY、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティの値は VerticalAlign.TOP になります。



実装
    public function get verticalAlign():*
    public function set verticalAlign(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

whiteSpaceCollapse

プロパティ 
whiteSpaceCollapse:*

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

テキストを TextFlow にインポートする際、空白を圧縮または保持します。WhiteSpaceCollapse.PRESERVE では、すべての空白文字が保持されます。WhiteSpaceCollapse.COLLAPSE では、インポートしたテキストブロック内で、改行、タブ、行送りまたは行末の空白が削除されます。改行タグ () および Unicode の行区切り文字は保持されます。

有効な値は、WhiteSpaceCollapse.PRESERVE、WhiteSpaceCollapse.COLLAPSE、FormatValue.INHERIT です。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は WhiteSpaceCollapse.COLLAPSE になります。



実装
    public function get whiteSpaceCollapse():*
    public function set whiteSpaceCollapse(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。

関連する API エレメント

wordSpacing

プロパティ 
wordSpacing:*

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

均等配置に使用する単語間の最適間隔、最小間隔、および最大間隔(通常の間隔幅の倍数)を指定します。最適間隔は、必要なサイズの間隔をフォントで定義されている値に対する割合として指定するために使用します。 最小値および最大値は、textJustify が distribute である場合に使用されます。これらの値では、文字間隔を使用して行の均等配置を行う前に、単語間の間隔をどれくらい広げたり狭めたりできるかを指定します。

有効なパーセント値は、-1000 ~ 1000%の数値です。

有効な値には、FormatValue.INHERIT があります。

デフォルト値は定義されていません。つまり、未設定です。

カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は 100%、50%、150%になります。



実装
    public function get wordSpacing():*
    public function set wordSpacing(value:any):void

例外
RangeError — 設定値がこのプロパティの範囲にない場合。
コンストラクターの詳細

TextLayoutFormat

()コンストラクター
public function TextLayoutFormat(initialValues:flashx.textLayout.formats:ITextLayoutFormat = null)

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

新しい TextLayoutFormat オブジェクトを作成します。すべての設定は空か、またはオプションで、用意されている initialValues オブジェクトから初期化されます。

パラメーター
initialValues:flashx.textLayout.formats:ITextLayoutFormat (default = null) — 初期値のコピー元のオプションインスタンス。

関連する API エレメント

メソッドの詳細

apply

()メソッド
public function apply(incoming:flashx.textLayout.formats:ITextLayoutFormat):void

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

この TextLayoutFormat オブジェクトのプロパティ値を、ITextLayoutFormat インスタンスである incoming で設定されているプロパティ値に置き換えます。ITextLayoutFormat インスタンスである incomingundefined のプロパティは、このオブジェクトで変更されません。

パラメーター

incoming:flashx.textLayout.formats:ITextLayoutFormat — プロパティ値をこの TextLayoutFormat オブジェクトに適用するインスタンス。


例  ( この例の使用方法 )

この例では、ある TextLayoutFormat オブジェクトの設定を 2 番目のオブジェクト(textFormatLayout)に適用し、受信側オブジェクトを使用してテキストをフォーマットします。
package flashx.textLayout.formats.examples {
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.formats.TextLayoutFormat;
    
    public class TextLayoutFormat_applyExample extends Sprite
    {
        public function TextLayoutFormat_applyExample()
        {
            // create a container and add it to the stage
            var container:Sprite = new Sprite();
            this.stage.addChild(container);
            // create TextFlow, ParagraphElement, and SpanElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span:SpanElement = new SpanElement();
            // create two TextLayoutFormat objects
            var textLayoutFormat:TextLayoutFormat = new TextLayoutFormat();
            var textLayoutFormat2:TextLayoutFormat = new TextLayoutFormat();
            // set format attributes in the first one
            textLayoutFormat.textIndent = 8;
            textLayoutFormat.color = 0x336633;
            textLayoutFormat.fontFamily = "Arial, Helvetica, _sans";
            textLayoutFormat.fontSize = 24;
            // set some of the same attributes on the second one
            textLayoutFormat2.color = 0x0000CC;
            textLayoutFormat2.fontSize = 12;
            textLayoutFormat2.textIndent = 24;
            // add text to the span, the span to the paragraph, and the paragraph to the text flow.
            span.text = "Notice that fontFamily is unchanged because it was undefined in textLayoutFormat2.";
            p.addChild( span);
            textFlow.addChild(p);
            // use apply() to apply textLayoutFormat2 format settings; assign format to the text flow
            textLayoutFormat.apply(textLayoutFormat2);  
            textFlow.hostFormat = textLayoutFormat;  
            // add paragraph to textFlow and update controller to display it
            textFlow.addChild(p);
            var controller:ContainerController = new ContainerController(container, 200, 200 );
            textFlow.flowComposer.addController(controller);
            textFlow.flowComposer.updateAllControllers();  
        }
    }
}

concat

()メソッド 
public function concat(incoming:flashx.textLayout.formats:ITextLayoutFormat):void

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

ITextLayoutFormat インスタンスである incoming のプロパティ値を、この TextLayoutFormat オブジェクトの値に連結します。この(受信側)TextLayoutFormat オブジェクトでは、値が FormatValue.INHERIT のプロパティと、値が undefined の継承プロパティには、incoming オブジェクトからの新しい値が設定されます。値が undefined の非継承プロパティにはデフォルト値が設定されます。その他のすべてのプロパティ値は、変更されません。

パラメーター

incoming:flashx.textLayout.formats:ITextLayoutFormat — 値の連結元のインスタンス。

関連する API エレメント


例  ( この例の使用方法 )

この例では、ある TextLayoutFormat オブジェクトに設定された値を、2 番目のオブジェクト(textFormatLayout)内にある値が未定義の対応するプロパティに追加し、受信側オブジェクトを使用してテキストをフォーマットします。
package flashx.textLayout.formats.examples {
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.formats.TextLayoutFormat;
    
    public class TextLayoutFormat_concatExample extends Sprite
    {
        public function TextLayoutFormat_concatExample()
        {
            // create a container and add it to the stage
            var container:Sprite = new Sprite();
            this.stage.addChild(container);
            // create TextFlow, ParagraphElement, and SpanElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span:SpanElement = new SpanElement();
            // create two TextLayoutFormat objects
            var textLayoutFormat:TextLayoutFormat = new TextLayoutFormat();
            var textLayoutFormat2:TextLayoutFormat = new TextLayoutFormat();
            // set format attributes in the first one
            textLayoutFormat.textIndent = 8;
            textLayoutFormat.color = 0x336633;
            textLayoutFormat.fontSize = 18;
            // set some of the same attributes on the second one
            textLayoutFormat2.textIndent = 24;
            textLayoutFormat2.color = 0x0000CC;
            textLayoutFormat2.fontSize = 12;
            textLayoutFormat2.fontFamily = "Arial, Helvetica, _sans";
            // concat textLayoutFormat2 settings; assign format to the text flow
            textLayoutFormat.concat(textLayoutFormat2);    
            textFlow.hostFormat = textLayoutFormat; 
            // add text to the span, the span to the paragraph, and the paragraph to the text flow.
            span.text = "Notice that fontFamily value has been added from textLayout2 to textLayout but " +
                "the other values have not been changed.";     
            p.addChild( span);
            textFlow.addChild(p);
            // update controller to display it
            var controller:ContainerController = new ContainerController(container, 200, 200 );
            textFlow.flowComposer.addController(controller);
            textFlow.flowComposer.updateAllControllers(); 
        }
    }
}

concatInheritOnly

()メソッド 
public function concatInheritOnly(incoming:flashx.textLayout.formats:ITextLayoutFormat):void

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

ITextLayoutFormat インスタンスである incoming のプロパティ値を、この TextLayoutFormat オブジェクトの値に連結します。この(受信側)TextLayoutFormat オブジェクトでは、値が FormatValue.INHERIT のプロパティと、値が undefined の継承プロパティには、incoming オブジェクトからの新しい値が設定されます。その他のすべてのプロパティ値は、変更されません。

パラメーター

incoming:flashx.textLayout.formats:ITextLayoutFormat — 値の連結元のインスタンス。

関連する API エレメント


例  ( この例の使用方法 )

この例では、ある TextLayoutFormat オブジェクトの値を、2 番目の TextLayoutFormat オブジェクト内にある値が未定義の対応するプロパティに追加します(ただし、プロパティが継承可能の場合のみ)。この例では、受け取り側の TextLayoutFormat オブジェクトの結果でテキストをフォーマットします。
package flashx.textLayout.formats.examples {
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.formats.TextLayoutFormat;
    
    public class TextLayoutFormat_concatInheritOnlyExample extends Sprite
    {
        public function TextLayoutFormat_concatInheritOnlyExample()
        {
            // create a container and add it to the stage
            var container:Sprite = new Sprite();
            this.stage.addChild(container);
            // create TextFlow, ParagraphElement, and SpanElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span:SpanElement = new SpanElement();
            // create two TextLayoutFormat objects
            var textLayoutFormat:TextLayoutFormat = new TextLayoutFormat();
            var textLayoutFormat2:TextLayoutFormat = new TextLayoutFormat();
            // set format attributes in the first one
            textLayoutFormat.color = 0xFF0000;
            textLayoutFormat.fontSize = undefined;            
            // set attributes on the second one (fontSize set here, too)
            textLayoutFormat2.color = 0x00FF00;
            textLayoutFormat2.backgroundColor = 0x00CCCC;
            textLayoutFormat2.fontSize = 16;
            textLayoutFormat2.fontFamily = "Times Roman";
            // concat textLayoutFormat2 settings; assign format to the text flow
            textLayoutFormat.concatInheritOnly(textLayoutFormat2);    
            textFlow.hostFormat = textLayoutFormat; 
            // add text to the span, the span to the paragraph, and the paragraph to the text flow.
            span.text = "Notice that the value of backgroundColor is "
            span.text += textLayoutFormat.backgroundColor;
            span.text += ", even though it is set in textLayoutFormat2. This is because " +
                "this property does not inherit. Also notice that font color does not change " +
                "because it is not undefined."
            p.addChild( span);
            textFlow.addChild(p);
            // update controller to display it
            var controller:ContainerController = new ContainerController(container, 200, 200 );
            textFlow.flowComposer.addController(controller);
            textFlow.flowComposer.updateAllControllers();  
        }
    }
}

copy

()メソッド 
public function copy(incoming:flashx.textLayout.formats:ITextLayoutFormat):void

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

TextLayoutFormat 設定を ITextLayoutFormat インスタンスである values からこの TextLayoutFormat オブジェクトにコピーします。valuesnull の場合、この TextLayoutFormat オブジェクトは、すべてのプロパティの値が未定義の状態で初期化されます。

パラメーター

incoming:flashx.textLayout.formats:ITextLayoutFormat — 値のコピー元のオプションインスタンス。


例  ( この例の使用方法 )

この例では、copy() を使用して、TextLayoutFormat オブジェクトのデフォルトフォーマット設定を、一部のフォーマットプロパティが設定された TextLayoutFormat オブジェクトでオーバーライドします。
package flashx.textLayout.formats.examples {
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.formats.TextLayoutFormat;
    
    public class TextLayoutFormat_copyExample extends Sprite
    {
        public function TextLayoutFormat_copyExample()
        {
            // create a container and add it to the stage
            var container:Sprite = new Sprite();
            this.stage.addChild(container);
            // create TextFlow, ParagraphElement, and SpanElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span:SpanElement = new SpanElement();
            // create two TextLayoutFormat objects
            var textLayoutFormat:TextLayoutFormat = new TextLayoutFormat();
            var textLayoutFormat2:TextLayoutFormat = new TextLayoutFormat();
            // set format attributes in the second one
            textLayoutFormat2.textIndent = 8;
            textLayoutFormat2.color = 0x336633;
            textLayoutFormat2.fontFamily = "Times Roman";
            textLayoutFormat2.fontSize = 18;
            // add text to the span, the span to the paragraph, and the paragraph to the text flow.
            span.text = "Notice that formatting values set in textLayoutFormat2 override " +
                "the default values in textLayoutFormat."; 
            p.addChild(span);
            textFlow.addChild(p);
            // copy format settings of textLayoutFormat2; assign format to the text flow
            textLayoutFormat.copy(textLayoutFormat2);
            textFlow.hostFormat = textLayoutFormat;  
            // add paragraph to textFlow and update controller to display it
            textFlow.addChild(p);
            var controller:ContainerController = new ContainerController(container, 200, 200 );
            textFlow.flowComposer.addController(controller);
            textFlow.flowComposer.updateAllControllers();      
        }
    }
}

createTextLayoutFormat

()メソッド 
public static function createTextLayoutFormat(initialValues:Object):flashx.textLayout.formats:TextLayoutFormat

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

新しい TextLayoutFormat オブジェクトを作成します。すべての設定は空か、またはオプションで、用意されている initialValues オブジェクトから初期化されます。

パラメーター

initialValues:Object — ITextLayoutFormat オブジェクトの値がコピーされる場合は、初期値のコピー元のオプションインスタンスです。それ以外の場合、このパラメーターは Dictionary や Object のように扱われ、繰り返されます。

戻り値
flashx.textLayout.formats:TextLayoutFormat

getStyle

()メソッド 
public function getStyle(styleProp:String):*

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

スタイル名を指定する styleProp パラメーターで指定されたスタイルの値を返します。

パラメーター

styleProp:String — その値を取得するスタイルの名前です。

戻り値
* — 指定したスタイルの値です。 タイプは、アクセス中のスタイルのタイプによって異なります。スタイルが設定されていない場合、undefined を返します。

isEqual

()メソッド 
public static function isEqual(p1:flashx.textLayout.formats:ITextLayoutFormat, p2:flashx.textLayout.formats:ITextLayoutFormat):Boolean

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

ITextLayoutFormat インスタンス p1 のプロパティと ITextLayoutFormat インスタンス p2 のプロパティを比較し、すべてのプロパティが一致する場合は true を返します。

パラメーター

p1:flashx.textLayout.formats:ITextLayoutFormatp2 と比較するインスタンス。
 
p2:flashx.textLayout.formats:ITextLayoutFormatp1 と比較するインスタンス。

戻り値
Boolean — すべてのプロパティが一致する場合は true、それ以外の場合は false。

removeClashing

()メソッド 
public function removeClashing(incoming:flashx.textLayout.formats:ITextLayoutFormat):void

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

この TextLayoutFormat オブジェクトのプロパティが ITextLayoutFormat インスタンスである incoming のプロパティと一致しない場合は、undefined に設定します。

パラメーター

incoming:flashx.textLayout.formats:ITextLayoutFormat — この TextLayoutFormat オブジェクトのプロパティ値と比較するインスタンス。


例  ( この例の使用方法 )

この例では、removeClashing() を呼び出し、textLayoutFormat2 から、textLayoutFormat と異なるフォーマット値をすべて削除します。異なる値を undefined に設定し、適用された値をキャンセルします。
package flashx.textLayout.formats.examples {
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.formats.TextLayoutFormat;
    
    public class TextLayoutFormat_removeClashingExample extends Sprite
    {
        public function TextLayoutFormat_removeClashingExample()
        {
            // create a container and add it to the stage
            var container:Sprite = new Sprite();
            this.stage.addChild(container);
            // create TextFlow, ParagraphElement, and SpanElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span:SpanElement = new SpanElement();
            // create two TextLayoutFormat objects
            var textLayoutFormat:TextLayoutFormat = new TextLayoutFormat();
            var textLayoutFormat2:TextLayoutFormat = new TextLayoutFormat();
            // set format attributes for textLayoutFormat2
            textLayoutFormat.textIndent = 8;
            textLayoutFormat.color = 0x336633;
            textLayoutFormat.fontFamily = "Arial, Helvetica, _sans";
            textLayoutFormat.fontSize = 24;
            // set fontFamily to same value for textLayoutFormat2            
            textLayoutFormat2.fontFamily = "Arial, Helvetica, _sans";
            // add text to the span, the span to the paragraph, and the paragraph to the text flow.
            span.text = "Notice that fontFamily (Arial, Helvetica, _sans) is applied." 
            p.addChild( span);
            textFlow.addChild(p);    
            // call removeClashing(), cancelling any values that clash with textLayoutFormat; 
            // assign it to the text flow
            textLayoutFormat.removeClashing(textLayoutFormat2);  
            textFlow.hostFormat = textLayoutFormat;  
            // add paragraph to textFlow and update controller to display it
            textFlow.addChild(p);
            var controller:ContainerController = new ContainerController(container, 200, 200 );
            textFlow.flowComposer.addController(controller);
            textFlow.flowComposer.updateAllControllers();  
        }
    }
}

removeMatching

()メソッド 
public function removeMatching(incoming:flashx.textLayout.formats:ITextLayoutFormat):void

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

この TextLayoutFormat オブジェクトのプロパティが ITextLayoutFormat インスタンスである incoming のプロパティと一致する場合は、undefined に設定します。

パラメーター

incoming:flashx.textLayout.formats:ITextLayoutFormat — この TextLayoutFormat オブジェクトのプロパティ値と比較するインスタンス。


例  ( この例の使用方法 )

この例では、removeMatching() を呼び出し、textLayoutFormat2 のフォーマット値と一致する値を textLayoutFormat からすべて削除します。
package flashx.textLayout.formats.examples {
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.formats.TextLayoutFormat;
    
    public class TextLayoutFormat_removeMatchingExample extends Sprite
    {
        public function TextLayoutFormat_removeMatchingExample()
        {
            // create a container and add it to the stage
            var container:Sprite = new Sprite();
            this.stage.addChild(container);
            // create TextFlow, ParagraphElement, and SpanElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span:SpanElement = new SpanElement();
            // create two TextLayoutFormat objects
            var textLayoutFormat:TextLayoutFormat = new TextLayoutFormat();
            var textLayoutFormat2:TextLayoutFormat = new TextLayoutFormat();
            // set format attributes for textLayoutFormat
            textLayoutFormat.textIndent = 8;
            textLayoutFormat.color = 0x336633;
            textLayoutFormat.fontFamily = "Arial, Helvetica, _sans";
            textLayoutFormat.fontSize = 24;
            // add text to the span, the span to the paragraph, and the paragraph to the text flow
            span.text = "Notice that fontFamily (Arial, Helvetica, _sans) is not applied." 
            p.addChild( span);
            textFlow.addChild(p);
            // set fontFamily to same value for textLayoutFormat2            
            textLayoutFormat2.fontFamily = "Arial, Helvetica, _sans";        
            // call removeMatching() to remove any values that match textLayoutFormat2; 
            // assign textLayoutFormat to the text flow
            textLayoutFormat.removeMatching(textLayoutFormat2);
            textFlow.hostFormat = textLayoutFormat;  
            // add paragraph to textFlow and update controller to display it
            textFlow.addChild(p);
            var controller:ContainerController = new ContainerController(container, 200, 200 );
            textFlow.flowComposer.addController(controller);
            textFlow.flowComposer.updateAllControllers();  
        }
    }
}

setStyle

()メソッド 
public function setStyle(styleProp:String, newValue:*):void

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

styleProp パラメーターにより指定されたスタイルの値を、newValue パラメーターで指定する値に設定します。

パラメーター

styleProp:String — 設定するスタイルの名前です。
 
newValue:* — スタイルに設定する値です。

TextLayoutFormatExample.as

この例では、マージンが 15 ピクセル、最初の行のインデントが 20 ピクセル、左揃えタブストップが 40 ピクセルで段落をフォーマットします。Arial フォント(代わりのデバイスフォントで)を使用し、サイズを 14 ピクセル、色を緑に設定し、カーニングをオンにし、行送り(lineHeight)を 140%に設定します。
package flashx.textLayout.formats.examples
{
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.formats.TabStopFormat;
    import flashx.textLayout.formats.TextLayoutFormat;
    import flash.text.engine.TabAlignment;
    
    public class TextLayoutFormatExample extends Sprite
    {
        public function TextLayoutFormatExample()
        {
            var textFlow:TextFlow = new TextFlow();
            var textLayoutFormat:TextLayoutFormat = new TextLayoutFormat();
            textLayoutFormat.paragraphStartIndent = 15;
            textLayoutFormat.paragraphSpaceBefore = 15;
            textLayoutFormat.paragraphEndIndent = 15;
            textLayoutFormat.paragraphSpaceAfter = 15;
            textLayoutFormat.textIndent = 20;
            textLayoutFormat.color = 0x336633;
            textLayoutFormat.fontFamily = "Arial, Helvetica, _sans";
            textLayoutFormat.fontSize = 14;
            textLayoutFormat.kerning = flash.text.engine.Kerning.ON;
            textLayoutFormat.lineHeight = "140%";

            var tabStop1:TabStopFormat = new TabStopFormat();
            tabStop1.alignment = flash.text.engine.TabAlignment.START;
            tabStop1.position = 40;
            textLayoutFormat.tabStops = new Array(tabStop1);
            textFlow.hostFormat = textLayoutFormat;

            var p:ParagraphElement = new ParagraphElement();
            var span:SpanElement = new SpanElement();
            span.text = "This example formats a paragraph with 15 pixel margins, a 20 pixel first " +
                 "line indent, and a left-aligned tab stop at 40 pixels (last line). It uses the " +
                 "Arial font (with alternate device fonts), sets the size to 14 pixels, the color to green, " +
                 " turns on kerning, \n \t and sets leading (lineHeight) to 140%.";
            p.addChildAt(0, span);
            textFlow.addChildAt(0, p);

            textFlow.flowComposer.addController(new ContainerController(this,310,200));
            textFlow.flowComposer.updateAllControllers();
        }
    }
}
TextLayoutFormatExample2.as

次の例は、Unicode の日本語文字列をテキストフローに変換し、右から左に垂直方向で表示されるように TextLayoutFormat プロパティを設定します。
package flashx.textLayout.formats.examples
{
    import flash.display.Sprite;
    import flash.system.Capabilities;
    
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.formats.BlockProgression;
    import flashx.textLayout.formats.JustificationRule;
    import flashx.textLayout.formats.TextLayoutFormat;
    import flashx.textLayout.formats.VerticalAlign;
    
    public class TextLayoutFormatExample2 extends Sprite
    {
        public function TextLayoutFormatExample2()
        {
            // create TextFlow object
            var textFlow:TextFlow = new TextFlow();   
            // create TextLayoutFormat object
            var textLayoutFormat:TextLayoutFormat = new TextLayoutFormat();
            // define Japanese text in a string of Unicode characters
            var jaText:String = String.fromCharCode(
                0x30AF, 0x30ED, 0x30B9, 0x30D7, 0x30E9, 0x30C3, 0x30C8, 0x30D5, 
                0x30A9, 0x30FC, 0x30E0, 0x4E0A, 0x3067, 0x518D, 0x751F, 0x53EF, 
                0x80FD, 0x306A
            ) + 
            "Flash Video" +
            String.fromCharCode(
                0x3092, 0x914D, 0x4FE1, 0x3001, 0x653F, 0x5E9C, 0x6700, 0x65B0, 
                0x60C5, 0x5831, 0x3092, 0x3088, 0x308A, 0x591A, 0x304F, 0x306E, 
                0x56FD, 0x6C11, 0x306B, 0x9AD8, 0x54C1, 0x8CEA, 0x306A, 0x753B, 
                0x50CF, 0x3067, 0x7C21, 0x5358, 0x304B, 0x3064, 0x30EA, 0x30A2, 
                0x30EB, 0x30BF, 0x30A4, 0x30E0, 0x306B, 0x63D0, 0x4F9B, 0x3059, 
                0x308B, 0x3053, 0x3068, 0x304C, 0x53EF, 0x80FD, 0x306B, 0x306A, 
                0x308A, 0x307e, 0x3057, 0x305F, 0x3002);
            // convert the text into a TextFlow object
            textFlow = TextConverter.importToFlow(jaText, TextConverter.PLAIN_TEXT_FORMAT);
            // set the locale and fontFamily
            textLayoutFormat.locale = "ja";
            if (Capabilities.os.search("Mac OS") > -1) 
                textLayoutFormat.fontFamily = String.fromCharCode(0x5C0F, 0x585A, 0x660E, 0x671D) + " Pro R"; // "Kozuka Mincho Pro R"                    koFont.fontName = "Adobe " + String.fromCharCode(0xBA85, 0xC870) + " Std M"; // "Adobe Myungjo Std M"
            else 
                textLayoutFormat.fontFamily = "Kozuka Mincho Pro R";
            // specify right-to-left block progression, east Asian justification, and top vertical alignment
            textLayoutFormat.blockProgression = BlockProgression.RL;
            textLayoutFormat.justificationRule = JustificationRule.EAST_ASIAN;
            textLayoutFormat.verticalAlign = VerticalAlign.TOP;
            textFlow.hostFormat = textLayoutFormat;
            // add controller and update to display text
            textFlow.flowComposer.addController(new ContainerController(this, 300, 200));
            textFlow.flowComposer.updateAllControllers();
        }
    }
}




[ X ]英語で表示される理由
ActionScript 3.0 リファレンスガイドのコンテンツが英語で表示されます。

ActionScript 3.0 リファレンスガイドのすべての部分がすべての言語に翻訳されているわけではありません。言語エレメントが翻訳されていない場合、そのエレメントは英語で表示されます。例えば、ga.controls.HelpBox クラスはどの言語にも訳されていません。このため、リファレンスガイドの日本語バージョンでは、ga.controls.HelpBox クラスは英語で表示されます。