| パッケージ | flashx.textLayout.elements |
| クラス | public class FlowElement |
| 継承 | FlowElement  Object |
| 実装 | ITextLayoutFormat |
| サブクラス | FlowGroupElement, FlowLeafElement |
| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
構成可能な FlowElement ツリーのルートは、常に、TextFlow オブジェクトです。ツリーのリーフエレメントは、常に、FlowLeafElement クラスのサブクラスです。構成可能な TextFlow に配置されているすべてのリーフには、上位の ParagraphElement があります。
FlowElement オブジェクトを直接作成することはできません。new FlowElement() を呼び出すと、エラー例外がスローされます。
関連する API エレメント
継承されるパブリックプロパティを隠す
継承されるパブリックプロパティを表示| プロパティ | 定義元 | ||
|---|---|---|---|
| alignmentBaseline : *
TextLayoutFormat：行の基準を揃えるベースラインを指定します。 | FlowElement | ||
| backgroundAlpha : *
TextLayoutFormat：背景のアルファ（透明）値です（カスケード時に定義されていない場合、デフォルトの値が採用されます）。 | FlowElement | ||
| backgroundColor : *
TextLayoutFormat：テキストの背景色です（カスケード時に定義されていない場合、デフォルトの値が採用されます）。 | FlowElement | ||
| baselineShift : *
TextLayoutFormat：ベースラインを dominantBaseline 値から移動させる量です。 | FlowElement | ||
| blockProgression : *
TextLayoutFormat：垂直方向または並行方向の行配置を指定します。 | FlowElement | ||
| breakOpportunity : *
TextLayoutFormat：折り返しのあるテキストを複数行に分割する際の、改行可能位置を制御します。 | FlowElement | ||
| cffHinting : *
TextLayoutFormat：このテキストに使用される CFF ヒンティングのタイプです。 | FlowElement | ||
| clearFloats : *
TextLayoutFormat：フロートを回り込むようにテキストを配置する方法を制御します。 | FlowElement | ||
| color : *
TextLayoutFormat：テキストの色です。 | FlowElement | ||
| columnCount : *
TextLayoutFormat：テキスト列の数です（カスケード時に定義されていない場合、デフォルトの値が採用されます）。 | FlowElement | ||
| columnGap : *
TextLayoutFormat：列間のふち取り領域をピクセル単位で指定します（カスケード時に定義されていない場合、デフォルトの値が採用されます）。 | FlowElement | ||
| columnWidth : *
TextLayoutFormat：列幅（ピクセル単位）です（カスケード時に定義されていない場合、デフォルトの値が採用されます）。 | FlowElement | ||
| computedFormat : flashx.textLayout.formats:ITextLayoutFormat [読み取り専用]
このエレメントに有効な計算済みのフォーマット属性を返します。 | FlowElement | ||
 | constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | |
| coreStyles : Object [読み取り専用] この FlowElement の coreStyles を返します。 | FlowElement | ||
| digitCase : *
TextLayoutFormat：このテキストに使用される数字の大文字小文字区別のタイプです。 | FlowElement | ||
| digitWidth : *
TextLayoutFormat：このテキストに使用される数字の幅のタイプです。 | FlowElement | ||
| direction : *
TextLayoutFormat：テキストブロック内のテキストのデフォルトの双方向埋め込みレベルを指定します。 | FlowElement | ||
| dominantBaseline : *
TextLayoutFormat：行のエレメントの垂直座標を決定するために alignmentBaseline に吸着させるエレメントのベースラインを指定します。 | FlowElement | ||
| firstBaselineOffset : *
TextLayoutFormat：コンテナ内の最初の行のベースライン位置を指定します。 | FlowElement | ||
| fontFamily : *
TextLayoutFormat：使用するフォント名またはフォント名のカンマ区切りリストです。 | FlowElement | ||
| fontLookup : *
TextLayoutFormat：使用するフォント参照です。 | FlowElement | ||
| fontSize : *
TextLayoutFormat：テキストのサイズ（ピクセル単位）です。 | FlowElement | ||
| fontStyle : *
TextLayoutFormat：テキストのスタイルです。 | FlowElement | ||
| fontWeight : *
TextLayoutFormat：テキストの太さです。 | FlowElement | ||
| format : flashx.textLayout.formats:ITextLayoutFormat このエレメントに直接適用される TextLayoutFormat プロパティです。 | FlowElement | ||
| id : String
エレメントに識別名を割り当て、id の参照により、エレメントへのスタイルの設定を可能にします。 | FlowElement | ||
| justificationRule : *
TextLayoutFormat：段落のテキストの均等配置に使用するルールです。 | FlowElement | ||
| justificationStyle : *
TextLayoutFormat：段落の均等配置に使用するスタイルです。 | FlowElement | ||
| kerning : *
TextLayoutFormat：カーニングでは、読みやすくするために、特定の文字ペア間でピクセルを調整します。 | FlowElement | ||
| leadingModel : *
TextLayoutFormat：行送りの基準と行送り方向の組み合わせである、行送りモデルを指定します。 | FlowElement | ||
| ligatureLevel : *
TextLayoutFormat：フォントで定義された合字のうち、どの合字がテキストで使用されるかを制御します。 | FlowElement | ||
| lineBreak : *
TextLayoutFormat：コンテナ内のテキスト折り返しを制御します（カスケード時に定義されていない場合、デフォルトの値が採用されます）。 | FlowElement | ||
| lineHeight : *
TextLayoutFormat：テキストの行送りを制御します。 | FlowElement | ||
| lineThrough : *
TextLayoutFormat：true の場合、打ち消し線が適用されます。打ち消し線はテキストの中央に描画される線です。 | FlowElement | ||
| linkActiveFormat : *
TextLayoutFormat：通常の状態のリンクに使用されるフォーマット属性を定義します。 | FlowElement | ||
| linkHoverFormat : *
TextLayoutFormat：マウスがリンクの境界内に移動されたときにホバー状態のリンクに対して使用されるフォーマット属性を定義します。 | FlowElement | ||
| linkNormalFormat : *
TextLayoutFormat：通常の状態のリンクに使用されるフォーマット属性を定義します。 | FlowElement | ||
| listAutoPadding : *
TextLayoutFormat：リストの始端におけるパディング値が auto である場合に、始端に対して自動インデントを指定します。 | FlowElement | ||
| listMarkerFormat : *
TextLayoutFormat：フォーマット属性のリストマーカーを定義します。 | FlowElement | ||
| listStylePosition : *
TextLayoutFormat：有効な値は、ListStylePosition.INSIDE、ListStylePosition.OUTSIDE、FormatValue.INHERIT です。 デフォルト値は定義されていません。つまり、未設定です。カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。 | FlowElement | ||
| listStyleType : *
TextLayoutFormat：有効な値は、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 です。 デフォルト値は定義されていません。つまり、未設定です。カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。 | FlowElement | ||
| locale : *
TextLayoutFormat：テキストのロケールです。 | FlowElement | ||
| paddingBottom : *
TextLayoutFormat：下部のインセット（ピクセル単位）です。 | FlowElement | ||
| paddingLeft : *
TextLayoutFormat：左側のインセット（ピクセル単位）です。 | FlowElement | ||
| paddingRight : *
TextLayoutFormat：右側のインセット（ピクセル単位）です。 | FlowElement | ||
| paddingTop : *
TextLayoutFormat：上部のインセット（ピクセル単位）です。 | FlowElement | ||
| paragraphEndIndent : *
TextLayoutFormat：段落の終端をどれだけインデントするかを指定する数値（ピクセル単位）です。 | FlowElement | ||
| paragraphSpaceAfter : *
TextLayoutFormat：段落の後に空けるスペースを指定する数値（ピクセル単位）です。 | FlowElement | ||
| paragraphSpaceBefore : *
TextLayoutFormat：段落の前に空けるスペースを指定する数値（ピクセル単位）です。 | FlowElement | ||
| paragraphStartIndent : *
TextLayoutFormat：段落の始端をどれだけインデントするかを指定する数値（ピクセル単位）です。 | FlowElement | ||
| parent : FlowGroupElement [読み取り専用] この FlowElement オブジェクトの親を返します。 | FlowElement | ||
| parentRelativeEnd : int [読み取り専用] 親に含まれるこの FlowElement オブジェクトの相対的な末尾を返します。 | FlowElement | ||
| parentRelativeStart : int [読み取り専用] 親に含まれるこの FlowElement オブジェクトの相対的な先頭を返します。 | FlowElement | ||
| renderingMode : *
TextLayoutFormat：このテキストに使用されるレンダリングモードです。 | FlowElement | ||
| styleName : *
TextLayoutFormat：エレメントに識別クラスを割り当て、styleName を参照することで、エレメントへのスタイルの設定を可能にします。 | FlowElement | ||
| styles : Object [読み取り専用] この FlowElement のスタイルを返します。 | FlowElement | ||
| tabStops : *
TextLayoutFormat：段落に関連付けるタブストップを指定します。 | FlowElement | ||
| textAlign : *
TextLayoutFormat：コンテナを基準とした段落内の行揃えです。 | FlowElement | ||
| textAlignLast : *
TextLayoutFormat：均等配置テキストの、コンテナを基準とした段落内の最後（単一）の行の行揃えです。 | FlowElement | ||
| textAlpha : *
TextLayoutFormat：テキストのアルファ（透明）値です。 | FlowElement | ||
| textDecoration : *
TextLayoutFormat：テキストの装飾です。 | FlowElement | ||
| textIndent : *
TextLayoutFormat：段落の一行目をどれだけインデントするかを指定する数値（ピクセル単位）です。 | FlowElement | ||
| textJustify : *
TextLayoutFormat：テキストの均等配置オプションを指定します。 | FlowElement | ||
| textLength : int [読み取り専用]
この FlowElement オブジェクトとその子が所有するテキストの長さの合計を返します。 | FlowElement | ||
| textRotation : *
TextLayoutFormat：テキストの回転角度を決定します。 | FlowElement | ||
| tracking : Object [書き込み専用]
追跡を設定します。trackingRight プロパティと同義です。 | FlowElement | ||
| trackingLeft : *
TextLayoutFormat：各文字の左側にトラッキング（または手動カーニング）をどれだけ適用するかの数値（ピクセル単位または fontSize のパーセント（120％など））です。 | FlowElement | ||
| trackingRight : *
TextLayoutFormat：各文字の右側にトラッキング（または手動カーニング）をどれだけ適用するかの数値（ピクセル単位または fontSize のパーセント（120％など））です。 | FlowElement | ||
| typeName : String
各 FlowElement には typeName が含まれます。 | FlowElement | ||
| typographicCase : *
TextLayoutFormat：このテキストに使用される文字の大文字小文字区別のタイプです。 | FlowElement | ||
| userStyles : Object FlowElement オブジェクトでのユーザースタイルの読み取りおよび書き込みを可能にします。 | FlowElement | ||
| verticalAlign : *
TextLayoutFormat：垂直方向の行揃えまたは均等配置です（カスケード時に定義されていない場合、デフォルトの値が採用されます）。 | FlowElement | ||
| whiteSpaceCollapse : *
TextLayoutFormat：テキストを TextFlow にインポートする際、空白を圧縮または保持します。 | FlowElement | ||
| wordSpacing : *
TextLayoutFormat：均等配置に使用する単語間の最適間隔、最小間隔、および最大間隔（通常の間隔幅の倍数）を指定します。 | FlowElement | ||
| メソッド | 定義元 | ||
|---|---|---|---|
基本クラス - new FlowElement() を呼び出すと、エラー例外がスローされます。 | FlowElement | ||
styleProp パラメーターにより指定されたスタイルを、この FlowElement オブジェクトからクリアします。 | FlowElement | ||
この FlowElement オブジェクトのディープコピー（すべての子を含む）を作成し、指定された 2 つの文字位置間のコンテンツをコピーし、そのコピーを FlowElement オブジェクトとして返します。 | FlowElement | ||
userStyles を他の otherElement の userStyles と比較します。 | FlowElement | ||
テキストフロー内のエレメントの開始位置を絶対インデックスとして返します。 | FlowElement | ||
この FlowElement オブジェクトに対して相対的な、指定された位置の文字を返します。 | FlowElement | ||
この FlowElement に対して相対的な、指定された位置の文字コードを返します。 | FlowElement | ||
上位エレメントに対して相対的な、このエレメントの先頭を返します。 | FlowElement | ||
テキストフロー階層内の次の FlowElement 兄弟を返します。 | FlowElement | ||
このエレメントに関連付けられている ParagraphElement オブジェクトを返します。 | FlowElement | ||
テキストフロー階層内の前の FlowElement 兄弟を返します。 | FlowElement | ||
styleProp パラメーターによって指定されたスタイルの値を返します。これは、スタイル名を指定するもので、任意のユーザースタイル名を含むことができます。 | FlowElement | ||
フローエレメント内の指定されたテキスト範囲を取得します。 | FlowElement | ||
テキストフロー階層を遡って、エレメントのルート TextFlow オブジェクトを返します。 | FlowElement | ||
|
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | |
実装オブジェクトが作成され、MXML タグに指定されたすべてのコンポーネントプロパティが初期化された後に、MXML オブジェクトに対して呼び出されます。 | FlowElement | ||
|
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | |
|
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | |
|
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | |
styleProp パラメーターにより指定されたスタイルの値を、newValue パラメーターで指定する値に設定します。 | FlowElement | ||
この FlowElement オブジェクトのコピーを作成し、指定された 2 つの文字位置間のコンテンツをコピーします。 | FlowElement | ||
relativePosition パラメーターで指定された位置（このエレメントのテキストの相対位置）で、この FlowElement オブジェクトを分割します。 | FlowElement | ||
|
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのプリミティブな値を返します。 | Object | |
alignmentBaseline | プロパティ |
alignmentBaseline:*| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
TextLayoutFormat：行の基準を揃えるベースラインを指定します。例えば、dominantBaseline を ASCENT に設定し、alignmentBaseline を DESCENT に設定すると、テキスト上部が DESCENT ベースライン上またはラインの下に揃えられます。一般に、ベースラインは行内の最大エレメントにより決定されます。
有効な値は、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 エレメント
backgroundAlpha | プロパティ |
backgroundAlpha:*| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
TextLayoutFormat：背景のアルファ（透明）値です（カスケード時に定義されていない場合、デフォルトの値が採用されます）。値 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 |
TextLayoutFormat：テキストの背景色です（カスケード時に定義されていない場合、デフォルトの値が採用されます）。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 |
TextLayoutFormat：ベースラインを 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 |
TextLayoutFormat：垂直方向または並行方向の行配置を指定します。行は、上から下（横書用の 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 |
TextLayoutFormat：折り返しのあるテキストを複数行に分割する際の、改行可能位置を制御します。テキストを標準的に改行する場合は、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 |
TextLayoutFormat：このテキストに使用される 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 |
TextLayoutFormat：フロートを回り込むようにテキストを配置する方法を制御します。none という値を使用すると、テキストはフロートの最も近くに回り込んで配置されます。 left という値を使用すると、テキストは left float を持つコンテナのすべての部分を飛び越えて配置され、right という値を使用すると、テキストは right float を持つコンテナのすべての部分を飛び越えて配置されます。 both という値を使用すると、テキストはすべてのフロートを飛び越えて配置されます。
有効な値は、ClearFloats.START、ClearFloats.END、ClearFloats.LEFT、ClearFloats.RIGHT、ClearFloats.BOTH、ClearFloats.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 |
TextLayoutFormat：テキストの色です。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 |
TextLayoutFormat：テキスト列の数です（カスケード時に定義されていない場合、デフォルトの値が採用されます）。列数は、列の他の設定をオーバーライドします。値は整数か、指定されない場合は 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 |
TextLayoutFormat：列間のふち取り領域をピクセル単位で指定します（カスケード時に定義されていない場合、デフォルトの値が採用されます）。値は数値で指定します。
有効な値は、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 |
TextLayoutFormat：列幅（ピクセル単位）です（カスケード時に定義されていない場合、デフォルトの値が採用されます）。列の幅を指定して列の数を指定しない場合、TextLayout により、コンテナ幅と columnGap の設定に基づき、その幅の列が可能な限り最大数作成されます。余りのスペースがある場合は、最後の列の後に置かれます。値は数値で指定します。
有効な値は、FormatValue.AUTO、FormatValue.INHERIT の文字列および 0 ～ 8000 の数値です。
デフォルト値は定義されていません。つまり、未設定です。
カスケード時に定義されていない場合、このプロパティの値は FormatValue.AUTO になります。
実装
public function get columnWidth():* public function set columnWidth(value:any):void例外
RangeError — 設定値がこのプロパティの範囲にない場合。
|
関連する API エレメント
computedFormat | プロパティ |
computedFormat:flashx.textLayout.formats:ITextLayoutFormat [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
このエレメントに有効な計算済みのフォーマット属性を返します。親エレメントからの属性の継承を考慮します。
実装
public function get computedFormat():flashx.textLayout.formats:ITextLayoutFormat関連する API エレメント
coreStyles | プロパティ |
coreStyles:Object [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
この FlowElement の coreStyles を返します。 getter によりコアスタイルのディクショナリが作成されることに注意してください。 coreStyles オブジェクトは、TextLayoutFormat で定義され、TextLayoutFormat.description 内にあるフォーマットをカプセル化します。 coreStyles オブジェクトは、stylename-value ペアの配列により構成されています。
実装
public function get coreStyles():Object関連する API エレメント
digitCase | プロパティ |
digitCase:*| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
TextLayoutFormat：このテキストに使用される数字の大文字小文字区別のタイプです。値を DigitCase.OLD_STYLE に設定すると、様々なアセンダとディセンダを持つ小文字の書体に近づきます。その文字幅は形状によって設定されます。このスタイルは、選択した書体（最も一般的には Supplemental フォントまたは Expert フォント）でのみ有効です。DigitCase.LINING に設定すると、大文字全体の高さとなり、一般にグラフで整列させる場合に文字幅が等幅になります。
有効な値は、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 |
TextLayoutFormat：このテキストに使用される数字の幅のタイプです。値は、個々の数字を表示する場合に最適な DigitWidth.PROPORTIONAL と、表、グラフおよび縦の列に数字を表示する場合に最適な DigitWidth.TABULAR があります。
有効な値は、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 |
TextLayoutFormat：テキストブロック内のテキストのデフォルトの双方向埋め込みレベルを指定します。ラテン文字などでは左から右の読み順、アラビア文字やヘブライ文字などでは右から左の読み順となります。このプロパティは、コンテナレベルで適用された場合、列の方向にも影響します。列もテキストと同様、左から右、または右から左のいずれかに設定できます。以下に例を示します。
有効な値は、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 |
TextLayoutFormat：行のエレメントの垂直座標を決定するために alignmentBaseline に吸着させるエレメントのベースラインを指定します。TextBaseline.AUTO を指定した場合、親段落の locale プロパティに基づいて、行の基準が選択されます。日本語と中国語の場合、選択されるベースラインの値は TextBaseline.IDEOGRAPHIC_CENTER で、他のすべての言語では TextBaseline.ROMAN となります。ベースラインに関するこれらの選択は、フォントおよびフォントサイズの選択によって決定されます。
有効な値は、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 |
TextLayoutFormat：コンテナ内の最初の行のベースライン位置を指定します。このプロパティがどのベースラインを参照するかは、コンテナレベルのロケールにより異なります。これは、日本語と中国語で TextBaseline.IDEOGRAPHIC_BOTTOM、他のすべての言語で TextBaseline.ROMAN となります。コンテナの上部のインセット（blockProgression が RL の場合は右側のインセット）から 1 行目のベースラインへのオフセットの値には、BaselineOffset.ASCENT（行のアセント）、BaselineOffset.LINE_HEIGHT（1 行目の高さ）、または絶対距離を指定する任意の固定数値を指定できます。BaselineOffset.AUTO に指定すると、行のアセントとコンテナの上部のインセットが揃えられます。
有効な値は、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 |
TextLayoutFormat：使用するフォント名またはフォント名のカンマ区切りリストです。リスト内の使用できる先頭のフォントを使用してエレメントをレンダリングします。例えば、「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 |
TextLayoutFormat：使用するフォント参照です。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 |
TextLayoutFormat：テキストのサイズ（ピクセル単位）です。
有効な値は、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 |
TextLayoutFormat：テキストのスタイルです。プレーンテキストには 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 |
TextLayoutFormat：テキストの太さです。プレーンテキスト用の 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 エレメント
format | プロパティ |
format:flashx.textLayout.formats:ITextLayoutFormatこのエレメントに直接適用される TextLayoutFormat プロパティです。
各エレメントには、そのフォーマットの一部としてプロパティが適用されている場合があります。このエレメントに適用されるプロパティは、親から継承されるプロパティをオーバーライドします。また、このエレメントに適用されるプロパティは、このエレメントの子に継承されます（ただし、子でオーバーライドされない場合）。エレメントにプロパティが適用されていない場合、これは null になります。
実装
public function get format():flashx.textLayout.formats:ITextLayoutFormat public function set format(value:flashx.textLayout.formats:ITextLayoutFormat):void関連する API エレメント
id | プロパティ |
id:String| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
エレメントに識別名を割り当て、id の参照により、エレメントへのスタイルの設定を可能にします。例えば、次の行は、span1 という id を持つ SpanElement オブジェクトの色を設定します。
textFlow.getElementByID("span1").setStyle("color", 0xFF0000);
実装
public function get id():String public function set id(value:String):void関連する API エレメント
justificationRule | プロパティ |
justificationRule:*| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
TextLayoutFormat：段落のテキストの均等配置に使用するルールです。デフォルト値は FormatValue.AUTO で、段落の locale プロパティに基づいてテキストの均等配置が行われます。日本語と中国語以外のすべての言語では、FormatValue.AUTO は JustificationRule.SPACE になり、空白文字に追加のスペースが追加されます。日本語と中国語の場合、FormatValue.AUTO は JustficationRule.EAST_ASIAN になります。均等配置によって、句読点のスペース設定の一部が変更されます。ローマンテキストの場合、カンマと日本語の句点には 1 文字分の幅を使用しますが、日中韓のテキストでは半文字分しか使用しません。また、従来の日中韓の活字規則に従って、連続する句読点間のスペースは狭くなります。次の例の、段落の 2 行目に適用された行送りにも注目してください。日中韓では、最後の 2 行が左に寄せられます。ローマンでは、2 行目以降が左に寄せられます。
有効な値は、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 |
TextLayoutFormat：段落の均等配置に使用するスタイルです。JustificationRule.EAST_ASIAN の justificationRule 設定との連携でのみ使用します。デフォルト値の FormatValue.AUTO は、すべてのロケールで JustificationStyle.PUSH_IN_KINSOKU に解決されます。JustificationStyle クラスで定義される定数値は、禁則文字の取扱いオプションを指定します。禁則文字とは日本語の文字で、行の最初や最後にすることのできない文字です。テキストの文字間隔を狭くしたくない場合は、JustificationStyle.PUSH-OUT-ONLY を指定します。JustificationRule.SPACE の justificationRule のような効果を得たい場合は、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 |
TextLayoutFormat：カーニングでは、読みやすくするために、特定の文字ペア間でピクセルを調整します。カーニングは、カーニングテーブルを持つすべてのフォントに対してサポートされています。
有効な値は、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 |
TextLayoutFormat：行送りの基準と行送り方向の組み合わせである、行送りモデルを指定します。行送り基準は、lineHeight プロパティが参照するベースラインです。行送り方向は、lineHeight プロパティが参照する特定の行までの距離が、その行の前の行のベースラインを基点とするのか、それともその行の後の行のベースラインを基点とするのかを決定します。デフォルト値の FormatValue.AUTO は、段落の locale プロパティに基づいて解決されます。これは、日本語と中国語で LeadingModel.IDEOGRAPHIC_TOP_DOWN、他のすべての言語で LeadingModel.ROMAN_UP_UP となります。
行送りの基準：
行送り方向：
有効な値は、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 |
TextLayoutFormat：フォントで定義された合字のうち、どの合字がテキストで使用されるかを制御します。これらの各設定に出現する合字は、フォントによって異なります。2 つ以上の letter-form が 1 つの文字に結合された場合には、合字が起こります。合字は通常、「fi」、「fl」、「ae」などの文字の組の用に共通のコンポーネントを共有する連続した文字を置き換えます。合字は、ラテン語およびラテン語以外の文字セットの両方で使用されます。LigatureLevel クラス（MINIMUM、COMMON、UNCOMMON、EXOTIC）の値で有効化された合字は、追加的なものです。各値によって新しい合字が有効になりますが、以前からの型も含まれます。
注意：アラビア語またはシリア語フォントを使用する場合は、ligatureLevel を MINIMUM 以上に設定する必要があります。
有効な値は、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 |
TextLayoutFormat：コンテナ内のテキスト折り返しを制御します（カスケード時に定義されていない場合、デフォルトの値が採用されます）。コンテナ内のテキストを、コンテナの幅に収まるよう設定（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 |
TextLayoutFormat：テキストの行送りを制御します。LeadingModel に基づいた、前または次の行のベースラインから現在の行のベースラインまでの距離は、行内の任意の文字に適用される最大行送り値と等しくなります。これは、数値またはパーセントのいずれかで指定します。パーセントで指定する場合、140％などのように文字列値を入力します。
有効な数値は、-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 |
TextLayoutFormat：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 |
TextLayoutFormat：通常の状態のリンクに使用されるフォーマット属性を定義します。この値は、下位の階層に伝達され、下位要素のリンクがある場合はそれらのリンクにも適用されます。 inherit、ITextLayoutFormat を受け入れるか、またはキーと値をメンバーとして持つオブジェクトの配列を 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 |
TextLayoutFormat：マウスがリンクの境界内に移動されたときにホバー状態のリンクに対して使用されるフォーマット属性を定義します。この値は、下位の階層に伝達され、下位要素のリンクがある場合はそれらのリンクにも適用されます。 inherit、ITextLayoutFormat を受け入れるか、またはキーと値をメンバーとして持つオブジェクトの配列を 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 |
TextLayoutFormat：通常の状態のリンクに使用されるフォーマット属性を定義します。この値は、下位の階層に伝達され、下位要素のリンクがある場合はそれらのリンクにも適用されます。 inherit、ITextLayoutFormat を受け入れるか、またはキーと値をメンバーとして持つオブジェクトの配列を 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 |
TextLayoutFormat：リストの始端におけるパディング値が 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 |
TextLayoutFormat：フォーマット属性のリストマーカーを定義します。この値は、下位の階層に伝達され、下位要素のリンクがある場合はそれらのリンクにも適用されます。 inherit、IListMarkerFormat を受け入れるか、またはキーと値をメンバーとして持つオブジェクトの配列を 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 |
TextLayoutFormat:
有効な値は、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 |
TextLayoutFormat:
有効な値は、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 |
TextLayoutFormat：テキストのロケールです。大文字小文字変換およびシェイピングを制御します。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 |
TextLayoutFormat：下部のインセット（ピクセル単位）です。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 |
TextLayoutFormat：左側のインセット（ピクセル単位）です。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 |
TextLayoutFormat：右側のインセット（ピクセル単位）です。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 |
TextLayoutFormat：上部のインセット（ピクセル単位）です。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 |
TextLayoutFormat：段落の終端をどれだけインデントするかを指定する数値（ピクセル単位）です。左から右のテキストでは右端、右から左のテキストでは左端です。
有効な値は、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 |
TextLayoutFormat：段落の後に空けるスペースを指定する数値（ピクセル単位）です。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 |
TextLayoutFormat：段落の前に空けるスペースを指定する数値（ピクセル単位）です。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 |
TextLayoutFormat：段落の始端をどれだけインデントするかを指定する数値（ピクセル単位）です。左から右のテキストでは左端、右から左のテキストでは右端です。
有効な値は、0 ～ 8000 の数値および FormatValue.INHERIT です。
デフォルト値は定義されていません。つまり、未設定です。
カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は 0 になります。
実装
public function get paragraphStartIndent():* public function set paragraphStartIndent(value:any):void例外
RangeError — 設定値がこのプロパティの範囲にない場合。
|
parent | プロパティ |
parent:FlowGroupElement [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
この FlowElement オブジェクトの親を返します。すべての FlowElement には、最大で 1 つの親があります。
実装
public function get parent():FlowGroupElementparentRelativeEnd | プロパティ |
parentRelativeEnd:int [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
親に含まれるこの FlowElement オブジェクトの相対的な末尾を返します。親が null の場合、これは常に textLength に等しくなります。親が null でない場合、値はこのオブジェクトとすべての前の兄弟のテキスト長の合計になります。これは、実際は、次のオブジェクトの最初の文字です。
実装
public function get parentRelativeEnd():int関連する API エレメント
parentRelativeStart | プロパティ |
renderingMode | プロパティ |
renderingMode:*| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
TextLayoutFormat：このテキストに使用されるレンダリングモードです。埋め込みフォント（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 |
TextLayoutFormat：エレメントに識別クラスを割り当て、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 |
この FlowElement のスタイルを返します。getter によりスタイルのディクショナリが作成されることに注意してください。 返されるオブジェクトは、フォーマットプロパティで設定されたすべてのスタイル（コアスタイルとユーザースタイルを含む）をカプセル化します。 返されるオブジェクトは、stylename-value ペアの配列により構成されています。
実装
public function get styles():Object関連する API エレメント
tabStops | プロパティ |
tabStops:*| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
TextLayoutFormat：段落に関連付けるタブストップを指定します。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 |
TextLayoutFormat：コンテナを基準とした段落内の行揃えです。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 |
TextLayoutFormat：均等配置テキストの、コンテナを基準とした段落内の最後（単一）の行の行揃えです。textAlign が TextAlign.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 |
TextLayoutFormat：テキストのアルファ（透明）値です。値 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 |
TextLayoutFormat：テキストの装飾です。アンダーラインを適用する場合に使用します。デフォルトは、なしです。
有効な値は、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 |
TextLayoutFormat：段落の一行目をどれだけインデントするかを指定する数値（ピクセル単位）です。一行目インデントをマイナスに指定すると、行はインデント内に寄せられ、コンテナより外に押し出される場合もあります。
有効な値は、-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 |
TextLayoutFormat：テキストの均等配置オプションを指定します。デフォルト値は TextJustify.INTER_WORD で、空白文字に追加のスペースが追加されます。TextJustify.DISTRIBUTE は、空白文字や個々の文字間に追加のスペースを追加します。JustificationRule.SPACE の justificationRule 値との連携でのみ使用します。
有効な値は、TextJustify.INTER_WORD、TextJustify.DISTRIBUTE、FormatValue.INHERIT です。
デフォルト値は定義されていません。つまり、未設定です。
カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は TextJustify.INTER_WORD になります。
実装
public function get textJustify():* public function set textJustify(value:any):void例外
RangeError — 設定値がこのプロパティの範囲にない場合。
|
関連する API エレメント
textLength | プロパティ |
textLength:int [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
この FlowElement オブジェクトとその子が所有するテキストの長さの合計を返します。エレメントにテキストがない場合、textLength の値は通常ゼロです。
ParagraphElement オブジェクトには、最終範囲と、最後の SpanElement オブジェクトの段落終了文字が含まれます。段落終了文字は、その SpanElement オブジェクトとすべてのその親の textLength の値に含めれれます。これは、SpanElement オブジェクトの text プロパティには含められません。
実装
public function get textLength():int関連する API エレメント
textRotation | プロパティ |
textRotation:*| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
TextLayoutFormat：テキストの回転角度を決定します。
有効な値は、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 エレメント
tracking | プロパティ |
trackingLeft | プロパティ |
trackingLeft:*| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
TextLayoutFormat：各文字の左側にトラッキング（または手動カーニング）をどれだけ適用するかの数値（ピクセル単位または 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 |
TextLayoutFormat：各文字の右側にトラッキング（または手動カーニング）をどれだけ適用するかの数値（ピクセル単位または 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 — 設定値がこのプロパティの範囲にない場合。
|
typeName | プロパティ |
typeName:String| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
各 FlowElement には typeName が含まれます。 typeName のデフォルト値は、textLayoutFormat TextConverter で使用されるストリングです。 この API を使用して、別の typeName を FlowElement に設定できます。 通常、この処理は CSS で type セレクターをサポートするために行います。
この方法について詳しくは、TEXT_FIELD_HTML_FORMAT のドキュメントを参照してください。
実装
public function get typeName():String public function set typeName(value:String):void関連する API エレメント
typographicCase | プロパティ |
typographicCase:*| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
TextLayoutFormat：このテキストに使用される文字の大文字小文字区別のタイプです。次に例を示します。
有効な値は、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 | プロパティ |
verticalAlign | プロパティ |
verticalAlign:*| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
TextLayoutFormat：垂直方向の行揃えまたは均等配置です（カスケード時に定義されていない場合、デフォルトの値が採用されます）。コンテナ内で 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 |
TextLayoutFormat：テキストを 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 |
TextLayoutFormat：均等配置に使用する単語間の最適間隔、最小間隔、および最大間隔（通常の間隔幅の倍数）を指定します。最適間隔は、必要なサイズの間隔をフォントで定義されている値に対する割合として指定するために使用します。 最小値および最大値は、textJustify が distribute である場合に使用されます。これらの値では、文字間隔を使用して行の均等配置を行う前に、単語間の間隔をどれくらい広げたり狭めたりできるかを指定します。
有効なパーセント値は、-1000 ～ 1000％の数値です。
有効な値には、FormatValue.INHERIT があります。
デフォルト値は定義されていません。つまり、未設定です。
カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。このプロパティを設定している祖先がない場合、値は 100％、50％、150％になります。
実装
public function get wordSpacing():* public function set wordSpacing(value:any):void例外
RangeError — 設定値がこのプロパティの範囲にない場合。
|
FlowElement | () | コンストラクター |
public function FlowElement()| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
基本クラス - new FlowElement() を呼び出すと、エラー例外がスローされます。
clearStyle | () | メソッド |
public function clearStyle(styleProp:String):void| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
styleProp パラメーターにより指定されたスタイルを、この FlowElement オブジェクトからクリアします。値を undefined に設定します。
パラメーター
styleProp:String — クリアするスタイルの名前です。
|
関連する API エレメント
例 ( この例の使用方法 )
clearStyle() でスタイル値を未定義に設定しますが、継承値は依然としてスタイルに適用できることを示します。
package flashx.textLayout.elements.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;
public class FlowElement_clearStyleExample extends Sprite{
public function FlowElement_clearStyleExample()
{
// create a container and a TextFlow object
var container:Sprite = new Sprite();
this.addChild(container);
var textFlow:TextFlow = new TextFlow();
// create a paragraph and set lineThrough style to true
var paragraph:ParagraphElement = new ParagraphElement();
paragraph.setStyle("color", 204);
// create two spans of text
var span1:SpanElement = new SpanElement();
var span2:SpanElement = new SpanElement();
var span3:SpanElement = new SpanElement();
span1.text = "After calling clearStyle(), the value of color for span1 is: ";
span2.text = " but the value of span1.getStyle() for color is ";
span3.text = " because getStyle() returns the inherited value that's applied to the style.";
span1.clearStyle("color"); // undefined
span1.text += span1.color;
paragraph.addChild(span1);
paragraph.addChild(span2);
span2.text += span1.getStyle("color"); //204
paragraph.addChild(span3);
textFlow.addChild(paragraph);
// add controller, then update controller to display text
var firstController:ContainerController = new ContainerController(container, 200, 200 );
textFlow.flowComposer.addController(firstController);
textFlow.flowComposer.updateAllControllers();
}
}
}
deepCopy | () | メソッド |
public function deepCopy(relativeStart:int = 0, relativeEnd:int = -1):FlowElement| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
この FlowElement オブジェクトのディープコピー（すべての子を含む）を作成し、指定された 2 つの文字位置間のコンテンツをコピーし、そのコピーを FlowElement オブジェクトとして返します。
引数なしの場合、deepCopy() はエレメント全体をコピーするようデフォルト設定されます。
パラメーター
relativeStart:int (default = 0) | |
relativeEnd:int (default = -1) |
FlowElement — ディープコピー操作により作成されたオブジェクトです。
|
関連する API エレメント
例 ( この例の使用方法 )
package flashx.textLayout.elements.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;
public class FlowElement_deepCopyExample extends Sprite{
public function FlowElement_deepCopyExample()
{
// 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 span1:SpanElement = new SpanElement();
var span2:SpanElement = new SpanElement();
// add text to the spans and spans to the paragraph
span1.text = "Hello, ";
span2.text = "World!";
p.fontSize = 48;
p.addChild(span1);
p.addChild(span2);
// make a deep copy of paragraph p, starting at relative offset 3; copy to end
var p2:ParagraphElement = p.deepCopy(3, -1) as ParagraphElement;
// add copied paragraph (p2) to textflow; add composer and controller
// and update controller to display text
textFlow.addChild(p2);
var controller:ContainerController = new ContainerController(container, 200, 200 );
textFlow.flowComposer.addController(controller);
textFlow.flowComposer.updateAllControllers(); // 'lo, World!'
}
}
}
equalUserStyles | () | メソッド |
public function equalUserStyles(otherElement:FlowElement):Boolean| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
userStyles を他の otherElement の userStyles と比較します。
パラメーター
otherElement:FlowElement — ユーザースタイルを比較する FlowElement オブジェクト
|
Boolean — ユーザースタイルが等しい場合は true、そうでない場合は false です。
|
関連する API エレメント
getAbsoluteStart | () | メソッド |
public function getAbsoluteStart():int| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
テキストフロー内のエレメントの開始位置を絶対インデックスとして返します。フロー内の最初の文字は、位置 0 となります。
戻り値int — TextFlow オブジェクトの先頭からの、エレメントの先頭のインデックスです。
|
関連する API エレメント
例 ( この例の使用方法 )
span2.getAbsoluteStart() を呼び出して span2 の開始位置を取得します。
package flashx.textLayout.elements.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;
public class FlowElement_getAbsoluteStartExample extends Sprite
{
public function FlowElement_getAbsoluteStartExample()
{
// 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 span1:SpanElement = new SpanElement();
var span2:SpanElement = new SpanElement();
// add text to the spans, spans to the paragraph, and paragraph to the text flow
span1.text = "The start of span2 ";
span2.text = "in this paragraph is at index: ";
p.fontSize = 20;
p.addChild(span1);
p.addChild(span2);
textFlow.addChild(p);
// find the starting position of span2 and update controller to display text
span2.text += span2.getAbsoluteStart(); // 19
var controller:ContainerController = new ContainerController(container, 200, 200 );
textFlow.flowComposer.addController(controller);
textFlow.flowComposer.updateAllControllers();
}
}
}
getCharAtPosition | () | メソッド |
public function getCharAtPosition(relativePosition:int):String| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
この FlowElement オブジェクトに対して相対的な、指定された位置の文字を返します。最初の文字は、相対位置 0 となります。
パラメーター
relativePosition:int — この文字の、この FlowElement オブジェクト内の相対位置です。
|
String — この文字を含むストリングです。
|
関連する API エレメント
例 ( この例の使用方法 )
package flashx.textLayout.elements.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;
public class FlowElement_getCharAtPositionExample extends Sprite
{
public function FlowElement_getCharAtPositionExample()
{
// create a container and a controller for it and add it to the stage
var container:Sprite = new Sprite();
var controller:ContainerController = new ContainerController( container, 400, 200 );
this.stage.addChild( container );
//create TextFlow, ParagraphElement, and SpanElement objects
var textFlow:TextFlow = new TextFlow();
var p:ParagraphElement = new ParagraphElement();
var span1:SpanElement = new SpanElement();
var span2:SpanElement = new SpanElement();
// add text to the two spans, calling getCharAtPosition() to return the
// character at relative position 27 in the first span
span1.text = "The character at offset 27 in this paragraph is: ";
span2.text = span1.getCharAtPosition(27) + "."; // i
// add spans to paragraph p
p.addChild(span1);
p.addChild(span2);
// add paragraph p to text flow and update controller to display it
textFlow.addChild(p);
textFlow.flowComposer.addController( controller );
textFlow.flowComposer.updateAllControllers();
}
}
}
getCharCodeAtPosition | () | メソッド |
public function getCharCodeAtPosition(relativePosition:int):int| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
この FlowElement に対して相対的な、指定された位置の文字コードを返します。最初の文字は、相対位置 0 となります。
パラメーター
relativePosition:int — この文字の、この FlowElement オブジェクト内の相対位置です。
|
int — 指定された位置の文字の Unicode 値です。
|
関連する API エレメント
例 ( この例の使用方法 )
package flashx.textLayout.elements.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;
public class FlowElement_getCharCodeAtPositionExample extends Sprite
{
public function FlowElement_getCharCodeAtPositionExample()
{
// create a container and a controller for it and add it to the stage
var container:Sprite = new Sprite();
var controller:ContainerController = new ContainerController( container, 400, 200 );
this.stage.addChild( container );
//create TextFlow, ParagraphElement, and SpanElement objects
var textFlow:TextFlow = new TextFlow();
var p:ParagraphElement = new ParagraphElement();
var span1:SpanElement = new SpanElement();
var span2:SpanElement = new SpanElement();
// add text to spans; use getCharCodeAtPosition() to add char code from pos. 16
// of span1
span1.text = "The character code at offset 16 in this paragraph is: ";
span2.text = String(span1.getCharCodeAtPosition(16)) + "."; // 100 (d)
// add spans to paragraph p
p.addChild(span1);
p.addChild(span2);
// add paragraph p to text flow and update controller to display it
textFlow.addChild(p);
textFlow.flowComposer.addController( controller );
textFlow.flowComposer.updateAllControllers();
}
}
}
getElementRelativeStart | () | メソッド |
public function getElementRelativeStart(ancestorElement:FlowElement):int| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
上位エレメントに対して相対的な、このエレメントの先頭を返します。上位エレメントが親チェーン内に存在すると想定します。上位エレメントが親である場合、これは this.parentRelativeStart と同じになります。上位要素が親の親である場合、これは、parentRelativeStart や parent.parentRelativeStart などと同じになります。
パラメーター
ancestorElement:FlowElement — このエレメントの先頭の相対位置の基準となるエレメントです。
|
int — このエレメントのオフセットです。
|
関連する API エレメント
例 ( この例の使用方法 )
getElementRelativeStart() を呼び出して、段落内のリンクの相対開始位置を判別します。
package flashx.textLayout.elements.examples {
import flash.display.Sprite;
import flashx.textLayout.container.ContainerController;
import flashx.textLayout.elements.LinkElement;
import flashx.textLayout.elements.ParagraphElement;
import flashx.textLayout.elements.SpanElement;
import flashx.textLayout.elements.TextFlow;
public class FlowElement_getElementRelativeStartExample extends Sprite
{
public function FlowElement_getElementRelativeStartExample()
{
// create a container and a controller for it and add it to the stage
var container:Sprite = new Sprite();
var controller:ContainerController = new ContainerController( container, 400, 200 );
this.stage.addChild( container );
//create TextFlow, ParagraphElement, SpanElement, and LinkElement objects
var textFlow:TextFlow = new TextFlow();
var p:ParagraphElement = new ParagraphElement();
var span1:SpanElement = new SpanElement();
var link:LinkElement = new LinkElement();
var span2:SpanElement = new SpanElement();
var span3:SpanElement = new SpanElement();
// add text to first two spans
span1.text = "The relative start of the link SpanElement (";
span2.text = ") in this paragraph is at position ";
// create link span, add text and corresponding URL and add to link
var linkSpan:SpanElement = new SpanElement();
linkSpan.text = "Adobe's website";
link.href = "http://www.adobe.com";
link.addChild(linkSpan);
// add first span, link, and second span to paragraph p
p.addChild(span1);
p.addChild(link);
p.addChild(span2);
// call getElementRelativeStart() to get start of linkSpan and add to span 3
span3.text = String(linkSpan.getElementRelativeStart(p)) + "."; // 44.
p.addChild(span3);
// add paragraph p to text flow and update controller to display it
textFlow.addChild(p);
textFlow.flowComposer.addController( controller );
textFlow.flowComposer.updateAllControllers();
}
}
}
getNextSibling | () | メソッド |
public function getNextSibling():FlowElement| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
テキストフロー階層内の次の FlowElement 兄弟を返します。
戻り値FlowElement — 同じタイプの次の FlowElement オブジェクト、または兄弟がない場合は null です。
|
関連する API エレメント
例 ( この例の使用方法 )
span2.getNextSibling() の結果に red を設定します。
package flashx.textLayout.elements.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;
public class FlowElement_getNextSiblingExample extends Sprite
{
public function FlowElement_getNextSiblingExample()
{
// 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 span1:SpanElement = new SpanElement();
var span2:SpanElement = new SpanElement();
var nextSpanElement:SpanElement = new SpanElement();
// add text, set font size, add spans to paragraph, add paragraph to text flow
span1.text = "Hello, ";
span2.text = "World!";
p.fontSize = 48;
p.addChild(span1);
p.addChild(span2);
textFlow.addChild(p);
// get next SpanElement for span1 and set its color to red; display text
nextSpanElement = SpanElement(span1.getNextSibling());
nextSpanElement.color = 0xCC0000;
textFlow.flowComposer.addController(new ContainerController(this,stage.stageWidth,stage.stageHeight));
textFlow.flowComposer.updateAllControllers();
}
}
}
getParagraph | () | メソッド |
public function getParagraph():ParagraphElement| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
このエレメントに関連付けられている ParagraphElement オブジェクトを返します。テキストフロー階層を検索し、最初の ParagraphElement オブジェクトを返します。
戻り値ParagraphElement — この FlowElement オブジェクトに関連付けられている ParagraphElement オブジェクトです。
|
関連する API エレメント
例 ( この例の使用方法 )
getParagraph() を使用して、LinkElement オブジェクトの ParagraphElement を返します。
package flashx.textLayout.elements.examples {
import flash.display.Sprite;
import flashx.textLayout.container.ContainerController;
import flashx.textLayout.elements.ParagraphElement;
import flashx.textLayout.elements.LinkElement;
import flashx.textLayout.elements.SpanElement;
import flashx.textLayout.elements.TextFlow;
public class FlowElement_getParagraphExample extends Sprite
{
public function FlowElement_getParagraphExample()
{
// create a container and a controller for it and add to the stage
var container:Sprite = new Sprite();
var controller:ContainerController = new ContainerController( container, 400, 200 );
this.stage.addChild( container );
//create TextFlow, ParagraphElement, SpanElement, and LinkElement objects
var textFlow:TextFlow = new TextFlow();
var p:ParagraphElement = new ParagraphElement();
var span1:SpanElement = new SpanElement();
var link:LinkElement = new LinkElement();
var span2:SpanElement = new SpanElement();
// add text to first span
span1.text = "Text that includes a link to ";
// create link span, add text and corresponding URL and add to link
var linkSpan:SpanElement = new SpanElement();
linkSpan.text = "Adobe's website";
link.href = "http://www.adobe.com";
link.addChild(linkSpan);
// add text to second span and add spans and link to paragraph p
span2.text = ". Notice that paragraph p2 is identical to paragraph p.";
p.addChild(span1);
p.addChild(link);
p.addChild(span2);
// call getParagraph() to retrieve paragaph for LinkElement
var p2:ParagraphElement = link.getParagraph();
// add paragraph p2 to the text flow and display it
textFlow.addChild(p2);
textFlow.flowComposer.addController( controller );
textFlow.flowComposer.updateAllControllers();
}
}
}
getPreviousSibling | () | メソッド |
public function getPreviousSibling():FlowElement| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
テキストフロー階層内の前の FlowElement 兄弟を返します。
戻り値FlowElement — 同じタイプの前の FlowElement オブジェクト、または兄弟がない場合は null です。
|
関連する API エレメント
例 ( この例の使用方法 )
span2.getPreviousSibling() の結果に red を設定します。
package flashx.textLayout.elements.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;
public class FlowElement_getPreviousSiblingExample extends Sprite
{
public function FlowElement_getPreviousSiblingExample()
{
// 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 span1:SpanElement = new SpanElement();
var span2:SpanElement = new SpanElement();
var prevSpanElement:SpanElement = new SpanElement();
// add text, set font size, add spans to paragraph, add paragraph to text flow
span1.text = "Hello, ";
span2.text = "World!";
p.fontSize = 48;
p.addChild(span1);
p.addChild(span2);
textFlow.addChild(p);
// get previous SpanElement for span2 and set its color to red; display text
prevSpanElement = SpanElement(span2.getPreviousSibling());
prevSpanElement.color = 0xCC0000;
textFlow.flowComposer.addController(new ContainerController(this,400,200));
textFlow.flowComposer.updateAllControllers();
}
}
}
getStyle | () | メソッド |
public function getStyle(styleProp:String):*| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
styleProp パラメーターにより指定されたスタイルの値を返します。これは、スタイル名を指定するもので、任意のユーザースタイル名を含むことができます。既存の範囲、段落、テキストフローまたはコンテナのスタイルにアクセスします。特定のエレメントでスタイルの値が undefined の場合は、親ツリーを検索します。
パラメーター
styleProp:String — その値を取得するスタイルの名前です。
|
* — 指定したスタイルの値です。 タイプは、アクセス中のスタイルのタイプによって異なります。スタイルが設定されていない場合、undefined を返します。
|
関連する API エレメント
例 ( この例の使用方法 )
getStyle() を呼び出して、lineThrough スタイルが範囲に適用されるかどうかを判別します。
package flashx.textLayout.elements.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;
public class FlowElement_getStyleExample extends Sprite
{
public function FlowElement_getStyleExample()
{
// create a container and a TextFlow object
var container:Sprite = new Sprite();
this.stage.addChild(container);
var textFlow:TextFlow = new TextFlow();
// create a paragraph and set lineThrough style to true
var paragraph:ParagraphElement = new ParagraphElement();
paragraph.setStyle("lineThrough", true);
// create two spans of text
var p1Span1:SpanElement = new SpanElement();
var p1Span2:SpanElement = new SpanElement();
p1Span1.text = "It was a dark and stormy night. ";
p1Span2.text = "The quick red fox jumped over the lazy brown dog.";
paragraph.addChild(p1Span1);
paragraph.addChild(p1Span2);
// call getStyle() for 1st span to see if lineThrough is on
if(p1Span1.getStyle("lineThrough") == true)
p1Span1.setStyle("lineThrough", false) // if so, turn it off for this span
textFlow.addChild(paragraph);
// add composer and controller, then update controller to display text
var controller:ContainerController = new ContainerController(container, 200, 200 );
textFlow.flowComposer.addController(controller);
textFlow.flowComposer.updateAllControllers();
}
}
}
getText | () | メソッド |
public function getText(relativeStart:int = 0, relativeEnd:int = -1, paragraphSeparator:String = " "):String| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
フローエレメント内の指定されたテキスト範囲を取得します。
パラメーター
relativeStart:int (default = 0) | |
relativeEnd:int (default = -1) | |
paragraphSeparator:String (default = " ") |
String — 要求されたテキスト。
|
getTextFlow | () | メソッド |
public function getTextFlow():flashx.textLayout.elements:TextFlow| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
テキストフロー階層を遡って、エレメントのルート TextFlow オブジェクトを返します。
戻り値flashx.textLayout.elements:TextFlow — この FlowElement オブジェクトのルート TextFlow オブジェクトです。
|
関連する API エレメント
例 ( この例の使用方法 )
getTextFlow() を LinkElement オブジェクトとともに使用して、そのルート TextFlow を返します。
package flashx.textLayout.elements.examples {
import flash.display.Sprite;
import flashx.textLayout.container.ContainerController;
import flashx.textLayout.elements.ParagraphElement;
import flashx.textLayout.elements.LinkElement;
import flashx.textLayout.elements.SpanElement;
import flashx.textLayout.elements.TextFlow;
public class FlowElement_getTextFlowExample extends Sprite
{
public function FlowElement_getTextFlowExample()
{
// create a container and a controller for it and add to the stage
var container:Sprite = new Sprite();
var controller:ContainerController = new ContainerController(container, 400, 200);
this.stage.addChild( container );
//create TextFlow, ParagraphElement, SpanElement, and LinkElement objects
var textFlow:TextFlow = new TextFlow();
var p:ParagraphElement = new ParagraphElement();
var span1:SpanElement = new SpanElement();
var link:LinkElement = new LinkElement();
var span2:SpanElement = new SpanElement();
// add text to first span
span1.text = "Text that includes a link to ";
// create link span, add text and corresponding URL and add to link
var linkSpan:SpanElement = new SpanElement();
linkSpan.text = "Adobe's website";
link.href = "http://www.adobe.com";
link.addChild(linkSpan);
// add text to second span, add spans and link to paragraph p, and
// add paragraph p to textFlow
span2.text = ". Notice that textFlow2 is identical to textFlow.";
p.addChild(span1);
p.addChild(link);
p.addChild(span2);
textFlow.addChild(p);
// use getTextFlow() with LinkElement to return its TextFlow; update controller
// and display it
var textFlow2:TextFlow = link.getTextFlow();
textFlow2.flowComposer.addController( controller );
textFlow2.flowComposer.updateAllControllers();
}
}
}
initialized | () | メソッド |
setStyle | () | メソッド |
public function setStyle(styleProp:String, newValue:*):void| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
styleProp パラメーターにより指定されたスタイルの値を、newValue パラメーターで指定する値に設定します。範囲、段落、テキストフローまたはコンテナスタイルを設定でき、任意のユーザーの名前と値のペアを含めることができます。
注意：カスタムスタイルを割り当てた場合、Text Layout Framework はそれをインポートおよびエクスポートすることはできますが、コンパイルされた MXML はそれをサポートできません。
パラメーター
styleProp:String — 設定するスタイルの名前です。
| |
newValue:* — スタイルに設定する値です。
|
関連する API エレメント
例 ( この例の使用方法 )
setStyle() を呼び出して、範囲の色を設定し、テキストフローのフォントスタイルをイタリックに設定します。
package flashx.textLayout.elements.examples {
import flash.display.Sprite;
import flash.text.engine.FontPosture;
import flashx.textLayout.container.ContainerController;
import flashx.textLayout.elements.ParagraphElement;
import flashx.textLayout.elements.SpanElement;
import flashx.textLayout.elements.TextFlow;
public class FlowElement_setStyleExample extends Sprite
{
public function FlowElement_setStyleExample()
{
// create a container and a controller for it and add it to the stage
var container:Sprite = new Sprite();
var controller:ContainerController = new ContainerController( container, 400, 200 );
this.stage.addChild( container );
// create TextFlow, ParagraphElement, and SpanElement objects
var textFlow:TextFlow = new TextFlow();
var p:ParagraphElement = new ParagraphElement();
var span1:SpanElement = new SpanElement();
var span2:SpanElement = new SpanElement();
// add text to the spans
span1.text = "Hello, ";
span2.text = "World!";
// set the color style for span2 and add spans to paragraph p
span2.setStyle("color", 0xCC0000);
p.addChild(span1);
p.addChild(span2);
// add paragraph to text flow, set fontStyle for the text flow to italic,
// and update controller to display the paragraph
textFlow.addChild(p);
textFlow.setStyle("fontStyle", FontPosture.ITALIC);
textFlow.flowComposer.addController( controller );
textFlow.flowComposer.updateAllControllers();
}
}
}
shallowCopy | () | メソッド |
public function shallowCopy(relativeStart:int = 0, relativeEnd:int = -1):FlowElement| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
この FlowElement オブジェクトのコピーを作成し、指定された 2 つの文字位置間のコンテンツをコピーします。新しい FlowElement オブジェクトとしてコピーを返します。deepCopy() とは異なり、shallowCopy() は、この FlowElement オブジェクトの子をコピーしません。
引数なしの場合、shallowCopy() はコンテンツ全体をコピーするようデフォルト設定されます。
パラメーター
relativeStart:int (default = 0) | |
relativeEnd:int (default = -1) |
FlowElement — コピー操作により作成されるオブジェクトです。
|
関連する API エレメント
例 ( この例の使用方法 )
package flashx.textLayout.elements.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;
public class FlowElement_shallowCopyExample extends Sprite
{
public function FlowElement_shallowCopyExample()
{
// 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 span1:SpanElement = new SpanElement();
var span2:SpanElement = new SpanElement();
var span3:SpanElement = new SpanElement();
// add text to the spans, spans to the paragraph
span1.text = "paragraph2 has ";
span3.text = " children, so it would display nothing."
p.fontSize = 20;
p.addChild(span1);
p.addChild(span2);
p.addChild(span3);
// create paragraph p2 as a shallow copy of paragraph p
var p2:ParagraphElement = p.shallowCopy(3, -1) as ParagraphElement;
// add the number of children that p2 has to span2 for paragraph p
span2.text += p2.numChildren; // 0
// add paragraph p 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();
}
}
}
splitAtPosition | () | メソッド |
public function splitAtPosition(relativePosition:int):FlowElement| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
relativePosition パラメーターで指定された位置（このエレメントのテキストの相対位置）で、この FlowElement オブジェクトを分割します。このメソッドは、SpanElement オブジェクトと FlowGroupElement オブジェクトのみを分割します。
パラメーター
relativePosition:int — 元のオブジェクトのコンテンツを分割する位置で、最初の位置は 0 です。
|
FlowElement — 指定された位置で開始する、元のオブジェクトのコンテンツを含む新規オブジェクトです。
|
例外
RangeError — relativePosition が textLength より大きい場合、または 0 より小さい場合に発生します。
|
Tue Jun 12 2018, 10:34 AM Z