パッケージ | flashx.textLayout.container |
クラス | public class ContainerController |
継承 | ContainerController Object |
実装 | IInteractionEventHandler, ITextLayoutFormat, ISandboxSupport |
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
関連する API エレメント
flashx.textLayout.elements.TextFlow
flash.text.engine.TextLine
プロパティ | 定義元 | ||
---|---|---|---|
absoluteStart : int [読み取り専用]
コンテナ内の最初の文字を返します。 | ContainerController | ||
alignmentBaseline : *
TextLayoutFormat:行の基準を揃えるベースラインを指定します。 | ContainerController | ||
backgroundAlpha : *
TextLayoutFormat:背景のアルファ(透明)値です(カスケード時に定義されていない場合、デフォルトの値が採用されます)。 | ContainerController | ||
backgroundColor : *
TextLayoutFormat:テキストの背景色です(カスケード時に定義されていない場合、デフォルトの値が採用されます)。 | ContainerController | ||
baselineShift : *
TextLayoutFormat:ベースラインを dominantBaseline 値から移動させる量です。 | ContainerController | ||
blockProgression : *
TextLayoutFormat:垂直方向または並行方向の行配置を指定します。 | ContainerController | ||
breakOpportunity : *
TextLayoutFormat:折り返しのあるテキストを複数行に分割する際の、改行可能位置を制御します。 | ContainerController | ||
cffHinting : *
TextLayoutFormat:このテキストに使用される CFF ヒンティングのタイプです。 | ContainerController | ||
clearFloats : *
TextLayoutFormat:フロートを回り込むようにテキストを配置する方法を制御します。 | ContainerController | ||
color : *
TextLayoutFormat:テキストの色です。 | ContainerController | ||
columnCount : *
TextLayoutFormat:テキスト列の数です(カスケード時に定義されていない場合、デフォルトの値が採用されます)。 | ContainerController | ||
columnGap : *
TextLayoutFormat:列間のふち取り領域をピクセル単位で指定します(カスケード時に定義されていない場合、デフォルトの値が採用されます)。 | ContainerController | ||
columnState : ColumnState [読み取り専用]
コンテナ内の列の数および特性を表す ColumnState オブジェクトを返します。 | ContainerController | ||
columnWidth : *
TextLayoutFormat:列幅(ピクセル単位)です(カスケード時に定義されていない場合、デフォルトの値が採用されます)。 | ContainerController | ||
compositionHeight : Number [読み取り専用]
コンテナ内でテキストに使用できる垂直方向の範囲を返します。 | ContainerController | ||
compositionWidth : Number [読み取り専用]
コンテナ内でテキストに使用できる水平方向の範囲を返します。 | ContainerController | ||
computedFormat : flashx.textLayout.formats:ITextLayoutFormat [読み取り専用]
このコンテナに適用された属性(ルートエレメントから継承された属性を含む)とともに ITextLayoutFormat インスタンスを返します。 | ContainerController | ||
constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | ||
container : Sprite [読み取り専用]
この ContainerController インスタンスのテキスト行を含むコンテナ表示オブジェクトを返します。 | ContainerController | ||
containerControllerInitialFormat : flashx.textLayout.formats:ITextLayoutFormat [静的] | ContainerController | ||
coreStyles : Object [読み取り専用] この ContainerController の coreStyles を返します。 | ContainerController | ||
digitCase : *
TextLayoutFormat:このテキストに使用される数字の大文字小文字区別のタイプです。 | ContainerController | ||
digitWidth : *
TextLayoutFormat:このテキストに使用される数字の幅のタイプです。 | ContainerController | ||
direction : *
TextLayoutFormat:テキストブロック内のテキストのデフォルトの双方向埋め込みレベルを指定します。 | ContainerController | ||
dominantBaseline : *
TextLayoutFormat:行のエレメントの垂直座標を決定するために alignmentBaseline に吸着させるエレメントのベースラインを指定します。 | ContainerController | ||
firstBaselineOffset : *
TextLayoutFormat:コンテナ内の最初の行のベースライン位置を指定します。 | ContainerController | ||
flowComposer : IFlowComposer [読み取り専用]
テキストを構成およびハイライトするフローコンポーザーオブジェクトを、このコントローラーが管理するコンテナに返します。 | ContainerController | ||
fontFamily : *
TextLayoutFormat:使用するフォント名またはフォント名のカンマ区切りリストです。 | ContainerController | ||
fontLookup : *
TextLayoutFormat:使用するフォント参照です。 | ContainerController | ||
fontSize : *
TextLayoutFormat:テキストのサイズ(ピクセル単位)です。 | ContainerController | ||
fontStyle : *
TextLayoutFormat:テキストのスタイルです。 | ContainerController | ||
fontWeight : *
TextLayoutFormat:テキストの太さです。 | ContainerController | ||
format : flashx.textLayout.formats:ITextLayoutFormat
このコンテナの属性を含む ITextLayoutFormat オブジェクトを格納します。 | ContainerController | ||
horizontalScrollPolicy : String
水平方向のスクロールポリシーを指定します。ScrollPolicy クラスの定数、ON、OFF または AUTO のいずれかを割り当てて設定します。 | ContainerController | ||
horizontalScrollPosition : Number ステージ上の現在の水平方向のスクロール位置を指定します。 | ContainerController | ||
interactionManager : ISelectionManager [読み取り専用]
この TextFlow オブジェクトに関連付けられた InteractionManager です。 | ContainerController | ||
justificationRule : *
TextLayoutFormat:段落のテキストの均等配置に使用するルールです。 | ContainerController | ||
justificationStyle : *
TextLayoutFormat:段落の均等配置に使用するスタイルです。 | ContainerController | ||
kerning : *
TextLayoutFormat:カーニングでは、読みやすくするために、特定の文字ペア間でピクセルを調整します。 | ContainerController | ||
leadingModel : *
TextLayoutFormat:行送りの基準と行送り方向の組み合わせである、行送りモデルを指定します。 | ContainerController | ||
ligatureLevel : *
TextLayoutFormat:フォントで定義された合字のうち、どの合字がテキストで使用されるかを制御します。 | ContainerController | ||
lineBreak : *
TextLayoutFormat:コンテナ内のテキスト折り返しを制御します(カスケード時に定義されていない場合、デフォルトの値が採用されます)。 | ContainerController | ||
lineHeight : *
TextLayoutFormat:テキストの行送りを制御します。 | ContainerController | ||
lineThrough : *
TextLayoutFormat:true の場合、打ち消し線が適用されます。打ち消し線はテキストの中央に描画される線です。 | ContainerController | ||
linkActiveFormat : *
TextLayoutFormat:通常の状態のリンクに使用されるフォーマット属性を定義します。 | ContainerController | ||
linkHoverFormat : *
TextLayoutFormat:マウスがリンクの境界内に移動されたときにホバー状態のリンクに対して使用されるフォーマット属性を定義します。 | ContainerController | ||
linkNormalFormat : *
TextLayoutFormat:通常の状態のリンクに使用されるフォーマット属性を定義します。 | ContainerController | ||
listAutoPadding : *
TextLayoutFormat:リストの始端におけるパディング値が auto である場合に、始端に対して自動インデントを指定します。 | ContainerController | ||
listMarkerFormat : *
TextLayoutFormat:フォーマット属性のリストマーカーを定義します。 | ContainerController | ||
listStylePosition : *
TextLayoutFormat:有効な値は、ListStylePosition.INSIDE、ListStylePosition.OUTSIDE、FormatValue.INHERIT です。 デフォルト値は定義されていません。つまり、未設定です。カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。 | ContainerController | ||
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 です。 デフォルト値は定義されていません。つまり、未設定です。カスケード時に定義されていない場合、このプロパティは祖先から値を継承します。 | ContainerController | ||
locale : *
TextLayoutFormat:テキストのロケールです。 | ContainerController | ||
paddingBottom : *
TextLayoutFormat:下部のインセット(ピクセル単位)です。 | ContainerController | ||
paddingLeft : *
TextLayoutFormat:左側のインセット(ピクセル単位)です。 | ContainerController | ||
paddingRight : *
TextLayoutFormat:右側のインセット(ピクセル単位)です。 | ContainerController | ||
paddingTop : *
TextLayoutFormat:上部のインセット(ピクセル単位)です。 | ContainerController | ||
paragraphEndIndent : *
TextLayoutFormat:段落の終端をどれだけインデントするかを指定する数値(ピクセル単位)です。 | ContainerController | ||
paragraphSpaceAfter : *
TextLayoutFormat:段落の後に空けるスペースを指定する数値(ピクセル単位)です。 | ContainerController | ||
paragraphSpaceBefore : *
TextLayoutFormat:段落の前に空けるスペースを指定する数値(ピクセル単位)です。 | ContainerController | ||
paragraphStartIndent : *
TextLayoutFormat:段落の始端をどれだけインデントするかを指定する数値(ピクセル単位)です。 | ContainerController | ||
renderingMode : *
TextLayoutFormat:このテキストに使用されるレンダリングモードです。 | ContainerController | ||
rootElement : ContainerFormattedElement [読み取り専用]
コンテナに表示されるルートエレメントを返します。 | ContainerController | ||
styleName : *
TextLayoutFormat:エレメントに識別クラスを割り当て、styleName を参照することで、エレメントへのスタイルの設定を可能にします。 | ContainerController | ||
styles : Object [読み取り専用] この ContainerController のスタイルを返します。 | ContainerController | ||
tabStops : *
TextLayoutFormat:段落に関連付けるタブストップを指定します。 | ContainerController | ||
textAlign : *
TextLayoutFormat:コンテナを基準とした段落内の行揃えです。 | ContainerController | ||
textAlignLast : *
TextLayoutFormat:均等配置テキストの、コンテナを基準とした段落内の最後(単一)の行の行揃えです。 | ContainerController | ||
textAlpha : *
TextLayoutFormat:テキストのアルファ(透明)値です。 | ContainerController | ||
textDecoration : *
TextLayoutFormat:テキストの装飾です。 | ContainerController | ||
textFlow : flashx.textLayout.elements:TextFlow [読み取り専用]
コンテナにコンテンツが表示されている TextFlow オブジェクトを返します。 | ContainerController | ||
textIndent : *
TextLayoutFormat:段落の一行目をどれだけインデントするかを指定する数値(ピクセル単位)です。 | ContainerController | ||
textJustify : *
TextLayoutFormat:テキストの均等配置オプションを指定します。 | ContainerController | ||
textLength : int [読み取り専用] コンテナ内の文字数を返します。 | ContainerController | ||
textRotation : *
TextLayoutFormat:テキストの回転角度を決定します。 | ContainerController | ||
trackingLeft : *
TextLayoutFormat:各文字の左側にトラッキング(または手動カーニング)をどれだけ適用するかの数値(ピクセル単位または fontSize のパーセント(120%など))です。 | ContainerController | ||
trackingRight : *
TextLayoutFormat:各文字の右側にトラッキング(または手動カーニング)をどれだけ適用するかの数値(ピクセル単位または fontSize のパーセント(120%など))です。 | ContainerController | ||
typographicCase : *
TextLayoutFormat:このテキストに使用される文字の大文字小文字区別のタイプです。 | ContainerController | ||
userStyles : Object ContainerController オブジェクトでのユーザースタイルの読み取りおよび書き込みを可能にします。 | ContainerController | ||
verticalAlign : *
TextLayoutFormat:垂直方向の行揃えまたは均等配置です(カスケード時に定義されていない場合、デフォルトの値が採用されます)。 | ContainerController | ||
verticalScrollPolicy : String 垂直方向のスクロールポリシーを指定します。ScrollPolicy クラスの定数、ON、OFF または AUTO のいずれかを割り当てて設定します。 | ContainerController | ||
verticalScrollPosition : Number ステージ上の現在の垂直方向のスクロール位置を指定します。 | ContainerController | ||
whiteSpaceCollapse : *
TextLayoutFormat:テキストを TextFlow にインポートする際、空白を圧縮または保持します。 | ContainerController | ||
wordSpacing : *
TextLayoutFormat:均等配置に使用する単語間の最適間隔、最小間隔、および最大間隔(通常の間隔幅の倍数)を指定します。 | ContainerController |
メソッド | 定義元 | ||
---|---|---|---|
ContainerController(container:Sprite, compositionWidth:Number = 100, compositionHeight:Number = 100)
コンストラクター - ContainerController のインスタンスを作成します。 | ContainerController | ||
クライアントによるイベントの管理時に Event.ACTIVATE イベントを処理します。 | ContainerController | ||
ドラッグによる選択時にスクロールイベントを処理します。 | ContainerController | ||
セキュリティサンドボックス外からの mouseup イベントおよび mousemove イベントの転送開始をクライアントに要求する場合に呼び出します。 | ContainerController | ||
この FlowElement から、styleProp により指定されたスタイルをクリアします。 | ContainerController | ||
クライアントによるイベントの管理時に Event.DEACTIVATE イベントを処理します。 | ContainerController | ||
クライアントによるイベントの管理時に編集イベント(CUT、COPY、PASTE、SELECT_ALL)を処理します。 | ContainerController | ||
セキュリティサンドボックス外からの mouseup イベントおよび mousemove イベントの転送が不要になったことをクライアントに通知する場合に呼び出します。 | ContainerController | ||
クライアントによるイベントの管理時に FocusEvent.KEY_FOCUS_CHANGE イベントおよび FocusEvent.MOUSE_FOCUS_CHANGE イベントを処理します。 | ContainerController | ||
クライアントによるイベントの管理時に FocusEvent.FOCUS_IN イベントを処理します。 | ContainerController | ||
クライアントによるイベントの管理時に FocusEvent.FOCUS_OUT イベントを処理します。 | ContainerController | ||
直近の構成または更新操作が反映されたものとして、テキストが占める領域を返します。 | ContainerController | ||
指定した行数により、画面上下へのスクロールに必要なスクロール距離を計算します。 | ContainerController | ||
styleProp パラメーターにより指定されたスタイルの値を返します。 | ContainerController | ||
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | ||
クライアントによるイベントの管理時に、IMEEvent.IME_START_COMPOSITION イベントを処理します。 | ContainerController | ||
このコンテナ内のすべてのテキストを、構成の必要があるものとしてマーキングします。 | ContainerController | ||
構成を必要とするテキストがコンテナに含まれているかどうかを判別します。 | ContainerController | ||
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | ||
クライアントによるイベントの管理時に、KeyboardEvent.KEY_DOWN イベントを処理します。 | ContainerController | ||
クライアントによるイベントの管理時に、FocusEvent.KEY_FOCUS_CHANGE イベントを処理します。 | ContainerController | ||
クライアントによるイベントの管理時に、Keyboard.KEY_UP イベントを処理します。 | ContainerController | ||
クライアントによるイベントの管理時に、ContextMenuEvent.MENU_SELECT イベントを処理します。 | ContainerController | ||
クライアントによるイベントの管理時に、MouseEvent.DOUBLE_CLICK イベントを処理します。 | ContainerController | ||
クライアントによるイベントの管理時に、MouseEvent.MOUSE_DOWN イベントを処理します。 | ContainerController | ||
クライアントによるイベントの管理時に、MouseEvent.MOUSE_MOVE イベントを処理します。 | ContainerController | ||
セキュリティサンドボックス外からの mouseMove イベントを転送するためのクライアント呼び出しです。 | ContainerController | ||
クライアントによるイベントの管理時に、MouseEvent.MOUSE_OUT イベントを処理します。 | ContainerController | ||
クライアントによるイベントの管理時に、MouseEvent.MOUSE_OVER イベントを処理します。 | ContainerController | ||
クライアントによるイベントの管理時に、MouseEvent.MOUSE_UP イベントを処理します。 | ContainerController | ||
セキュリティサンドボックス外からの mouseUp イベントを転送するためのクライアント呼び出しです。 | ContainerController | ||
クライアントによるイベントの管理時に、MouseEvent.MOUSE_WHEEL イベントを処理します。 | ContainerController | ||
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | ||
テキスト範囲がコンテナ内に表示されるようにスクロールします。 | ContainerController | ||
ITextSupport を実装するコンポーネントに、選択したテキストの範囲を設定します。 | ContainerController | ||
コンテナ内でテキストに使用できる幅と高さを設定します。 | ContainerController | ||
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | ||
styleProp パラメーターにより指定されたスタイルの値を、newValue パラメーターで指定する値に設定します。 | ContainerController | ||
クライアントによるイベントの管理時に、SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATING イベントを処理します。 | ContainerController | ||
クライアントによるイベントの管理時に、TextEvent.TEXT_INPUT イベントを処理します。 | ContainerController | ||
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | ||
指定されたオブジェクトのストリング表現を返します。 | Object | ||
指定されたオブジェクトのプリミティブな値を返します。 | Object |
メソッド | 定義元 | ||
---|---|---|---|
背景シェイプ(背景色など)が描画される flash.display.Shape オブジェクトを追加します。 | ContainerController | ||
addInlineGraphicElement(parent:DisplayObjectContainer, inlineGraphicElement:DisplayObject, index:int):void
親の下位要素として flash.display.DisplayObject オブジェクトを追加します。 | ContainerController | ||
選択シェイプ(ブロック選択ハイライトやカーソルなど)が追加される flash.display.DisplayObjectContainer オブジェクトを追加します。 | ContainerController | ||
コンテナの下位要素として flash.text.engine.TextLine オブジェクトを追加します。 | ContainerController | ||
ContainerController のコンテキストメニューを作成します。 | ContainerController | ||
親内で最初のテキスト行を表示させるインデックスを取得します。 | ContainerController | ||
背景シェイプ(背景色など)が描画される flash.display.Shape オブジェクトを削除します。 | ContainerController | ||
flash.display.DisplayObject オブジェクトを親から削除します。 | ContainerController | ||
選択シェイプ(ブロック選択ハイライトやカーソルなど)を格納する flash.display.DisplayObjectContainer オブジェクトを削除します。 | ContainerController | ||
flash.text.engine.TextLine オブジェクトを親から削除します。 | ContainerController | ||
スクロールする場合、途中までしか表示されない行がスクロール可能な領域内に収まるよう、スクロール矩形をコンテナ矩形に設定します。 | ContainerController |
_mouseWheelListenerAttached | プロパティ |
tlf_internal var _mouseWheelListenerAttached:Boolean = false
absoluteStart | プロパティ |
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 — 設定値がこのプロパティの範囲にない場合。
|
columnState | プロパティ |
columnState:ColumnState
[読み取り専用] 言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
コンテナ内の列の数および特性を表す ColumnState オブジェクトを返します。IFlowComposer.compose()
または IFlowComposer.updateAllControllers()
のいずれかの結果としてテキストが再構成されると、これらの値は更新されます。
実装
public function get columnState():ColumnState
関連する API エレメント
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 エレメント
compositionHeight | プロパティ |
compositionWidth | プロパティ |
computedFormat | プロパティ |
computedFormat:flashx.textLayout.formats:ITextLayoutFormat
[読み取り専用] 言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
このコンテナに適用された属性(ルートエレメントから継承された属性を含む)とともに ITextLayoutFormat インスタンスを返します。
実装
public function get computedFormat():flashx.textLayout.formats:ITextLayoutFormat
関連する API エレメント
container | プロパティ |
containerControllerInitialFormat | プロパティ |
containerControllerInitialFormat:flashx.textLayout.formats:ITextLayoutFormat
実装
public static function get containerControllerInitialFormat():flashx.textLayout.formats:ITextLayoutFormat
public static function set containerControllerInitialFormat(value:flashx.textLayout.formats:ITextLayoutFormat):void
coreStyles | プロパティ |
coreStyles:Object
[読み取り専用] 言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
この ContainerController の coreStyles
を返します。getter によりコアスタイルのディクショナリが作成されることに注意してください。 返されるオブジェクトには、TextLayoutFormat で定義され、TextLayoutFormat.description 内にあるフォーマットが含まれます。 返されるオブジェクトは、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 エレメント
flowComposer | プロパティ |
flowComposer:IFlowComposer
[読み取り専用] 言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
テキストを構成およびハイライトするフローコンポーザーオブジェクトを、このコントローラーが管理するコンテナに返します。
実装
public function get flowComposer():IFlowComposer
関連する 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
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
このコンテナの属性を含む ITextLayoutFormat オブジェクトを格納します。このコントローラーは、コンテナが含まれる TextFlow からコンテナのプロパティを継承します。このプロパティは、同じテキストフロー内で複数のコントローラーが異なる列設定やパディングなどを指定することを許可します。
実装
public function get format():flashx.textLayout.formats:ITextLayoutFormat
public function set format(value:flashx.textLayout.formats:ITextLayoutFormat):void
関連する API エレメント
horizontalScrollPolicy | プロパティ |
horizontalScrollPosition | プロパティ |
interactionManager | プロパティ |
interactionManager:ISelectionManager
[読み取り専用] 言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
この TextFlow オブジェクトに関連付けられた InteractionManager です。
テキストに対するすべての選択と編集を制御します。TextFlow が選択可能でない場合、interactionManager は null になります。TextFlow を編集可能にするには、ISelectionManager と IEditManager の両方を意味する interactionManager を割り当てる必要があります。TextFlow を読み取り専用および選択可能にするには、ISelectionManager のみを意味する interactionManager を割り当てる必要があります。
実装
public function get interactionManager():ISelectionManager
関連する 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 — 設定値がこのプロパティの範囲にない場合。
|
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 エレメント
rootElement | プロパティ |
rootElement:ContainerFormattedElement
[読み取り専用] 言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
コンテナに表示されるルートエレメントを返します。ルートエレメントは、例えば DivElement または TextFlow インスタンスなどです。
実装
public function get rootElement():ContainerFormattedElement
関連する 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 |
この ContainerController のスタイルを返します。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 エレメント
textFlow | プロパティ |
textFlow:flashx.textLayout.elements:TextFlow
[読み取り専用] 言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
コンテナにコンテンツが表示されている TextFlow オブジェクトを返します。textFlow
と rootElement
の値が同じか、またはこれはルートエレメントの TextFlow オブジェクトです。例えば、コンテナのルートエレメントが DivElement の場合、値は、DivElement が属する TextFlow オブジェクトになります。
実装
public function get textFlow():flashx.textLayout.elements:TextFlow
関連する 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 | プロパティ |
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 エレメント
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 — 設定値がこのプロパティの範囲にない場合。
|
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 エレメント
verticalScrollPolicy | プロパティ |
verticalScrollPosition | プロパティ |
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 — 設定値がこのプロパティの範囲にない場合。
|
ContainerController | () | コンストラクター |
public function ContainerController(container:Sprite, compositionWidth:Number = 100, compositionHeight:Number = 100)
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
コンストラクター - ContainerController のインスタンスを作成します。ContainerController には、compositionWidth
と compositionHeight
のデフォルト値が設定されています。そのため、幅と高さを指定していない場合でも、テキストの一部がコンテナに表示されます。
container:Sprite — テキスト行を管理するための DisplayObjectContainer です。
| |
compositionWidth:Number (default = 100 ) — コンテナ内にテキストを構成するための幅の初期値です。
| |
compositionHeight:Number (default = 100 ) — コンテナ内にテキストを構成するための高さの初期値です。
|
activateHandler | () | メソッド |
public function activateHandler(event:Event):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
クライアントによるイベントの管理時に Event.ACTIVATE
イベントを処理します。
パラメーター
event:Event — イベントオブジェクトです。
|
関連する API エレメント
例 ( この例の使用方法 )
package flashx.textLayout.container.examples { import flash.display.Sprite; import flash.events.Event; import flashx.textLayout.container.ContainerController; public class ContainerController_activateHandlerExample extends ContainerController { public function ContainerController_activateHandlerExample(container:Sprite, compositionWidth:Number=100, compositionHeight:Number=100) { super(container, compositionWidth, compositionHeight); } override public function activateHandler(event:Event):void { // run the TLF handler for the activate event super.activateHandler(event); // and add your own code for the event trace("You are in activateHandler()"); } } }
addBackgroundShape | () | メソッド |
protected function addBackgroundShape(shape:Shape):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
背景シェイプ(背景色など)が描画される flash.display.Shape
オブジェクトを追加します。このメソッドのデフォルト実装(オーバーライド可能)は、flash.text.engine.TextLine
の子が存在する場合はその最初の子の直前の、存在しない場合は既存の最後の子の後ろの container
にオブジェクトを追加します。
パラメーター
shape:Shape — 追加する flash.display.Shape オブジェクト
|
関連する API エレメント
addInlineGraphicElement | () | メソッド |
protected function addInlineGraphicElement(parent:DisplayObjectContainer, inlineGraphicElement:DisplayObject, index:int):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 2.0 |
parent
の下位要素として flash.display.DisplayObject
オブジェクトを追加します。 このメソッドのデフォルト実装(オーバーライド可能)は、parent
の直接の子として、オブジェクトを指定されたインデックスに追加します。 TextLine またはコンテナに InlineGraphicElements を追加するために呼び出されます。
パラメーター
parent:DisplayObjectContainer — inlineGraphicElement を追加する flash.display.DisplayObjectContainer オブジェクト
| |
inlineGraphicElement:DisplayObject — 追加する flash.display.DisplayObject オブジェクト
| |
index:int — 親内のフロートの挿入インデックス
|
関連する API エレメント
addSelectionContainer | () | メソッド |
protected function addSelectionContainer(selectionContainer:DisplayObjectContainer):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
選択シェイプ(ブロック選択ハイライトやカーソルなど)が追加される flash.display.DisplayObjectContainer
オブジェクトを追加します。このメソッドのデフォルト実装(オーバーライド可能)では、container
の flash.text.engine.TextLine
の最初の子(存在する場合)の直前にオブジェクトが追加されます。オブジェクトは不透明で、normal ブレンドモードに設定されます。これ以外のケースでは、オブジェクトは container
の最後の子として追加されます。
パラメーター
selectionContainer:DisplayObjectContainer — 追加する flash.display.DisplayObjectContainer オブジェクト
|
関連する API エレメント
addTextLine | () | メソッド |
protected function addTextLine(textLine:flash.text.engine:TextLine, index:int):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
container
の下位要素として flash.text.engine.TextLine
オブジェクトを追加します。このメソッドのデフォルト実装(オーバーライド可能)は、container
の直接の子として、オブジェクトを指定されたインデックスに追加します。
パラメーター
textLine:flash.text.engine:TextLine — 追加する flash.text.engine.TextLine オブジェクト
| |
index:int — 親内のテキスト行の挿入インデックス
|
関連する API エレメント
autoScrollIfNecessary | () | メソッド |
beginMouseCapture | () | メソッド |
public function beginMouseCapture():void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
セキュリティサンドボックス外からの mouseup イベントおよび mousemove イベントの転送開始をクライアントに要求する場合に呼び出します。
clearStyle | () | メソッド |
createContextMenu | () | メソッド |
protected function createContextMenu():ContextMenu
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
ContainerController のコンテキストメニューを作成します。ContextMenu クラスのメソッドを使用して、メニューにアイテムを追加します。
このメソッドをオーバーライドしてカスタムのコンテキストメニューを定義できます。
戻り値ContextMenu |
関連する API エレメント
deactivateHandler | () | メソッド |
editHandler | () | メソッド |
public function editHandler(event:Event):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
クライアントによるイベントの管理時に編集イベント(CUT、COPY、PASTE、SELECT_ALL)を処理します。
パラメーター
event:Event — イベントオブジェクトです。
|
関連する API エレメント
例 ( この例の使用方法 )
package flashx.textLayout.container.examples { import flash.events.Event; import flash.display.Sprite; import flashx.textLayout.container.ContainerController; public class ContainerController_editHandlerExample extends ContainerController { public function ContainerController_editHandlerExample(container:Sprite, compositionWidth:Number=100, compositionHeight:Number=100) { super(container, compositionWidth, compositionHeight); } override public function editHandler(event:Event):void { // run the TLF handler for the focus event super.editHandler(event); // and add your own code for the event trace("You are in editHandler()"); } } }
endMouseCapture | () | メソッド |
public function endMouseCapture():void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
セキュリティサンドボックス外からの mouseup イベントおよび mousemove イベントの転送が不要になったことをクライアントに通知する場合に呼び出します。
focusChangeHandler | () | メソッド |
public function focusChangeHandler(event:FocusEvent):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
クライアントによるイベントの管理時に FocusEvent.KEY_FOCUS_CHANGE
イベントおよび FocusEvent.MOUSE_FOCUS_CHANGE
イベントを処理します。
パラメーター
event:FocusEvent — FocusEvent オブジェクトです。
|
関連する API エレメント
focusInHandler | () | メソッド |
public function focusInHandler(event:FocusEvent):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
クライアントによるイベントの管理時に FocusEvent.FOCUS_IN
イベントを処理します。
パラメーター
event:FocusEvent — FocusEvent オブジェクトです。
|
関連する API エレメント
例 ( この例の使用方法 )
package flashx.textLayout.container.examples { import flash.events.FocusEvent; import flash.display.Sprite; import flashx.textLayout.container.ContainerController; public class ContainerController_focusInHandlerExample extends ContainerController { public function ContainerController_focusInHandlerExample(container:Sprite, compositionWidth:Number=100, compositionHeight:Number=100) { super(container, compositionWidth, compositionHeight); } override public function focusInHandler(event:FocusEvent):void { // run the TLF handler for the focus event super.focusInHandler(event); // and add your own code for the event trace("You are in focusInHandler()"); } } }
focusOutHandler | () | メソッド |
public function focusOutHandler(event:FocusEvent):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
クライアントによるイベントの管理時に FocusEvent.FOCUS_OUT
イベントを処理します。
パラメーター
event:FocusEvent — FocusEvent オブジェクトです。
|
関連する API エレメント
getContentBounds | () | メソッド |
public function getContentBounds():Rectangle
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
直近の構成または更新操作が反映されたものとして、テキストが占める領域を返します。コンテナがスクロール可能でテキストが表示可能領域を超える場合、幅と高さを推定できます。
戻り値Rectangle — テキストが占める領域を表します。
|
関連する API エレメント
例 ( この例の使用方法 )
getContentBounds()
を使用してテキストの周囲に境界線を描画します。package flashx.textLayout.container.examples { import flash.geom.Rectangle; import flash.display.Sprite; import flashx.textLayout.elements.TextFlow; import flashx.textLayout.container.ContainerController; import flashx.textLayout.conversion.TextConverter; public class ContainerController_getContentBoundsExample extends Sprite { private const textMarkup:String = "<flow:TextFlow xmlns:flow='http://ns.adobe.com/textLayout/2008' fontSize='08' " + "textIndent='10' paragraphSpaceBefore='6' paddingTop='8' paddingLeft='8' paddingRight='8'>" + "<flow:p paragraphSpaceBefore='inherit'>" + "<flow:span>There are many </flow:span>" + "<flow:span fontStyle='italic'>such</flow:span>" + "<flow:span> lime-kilns in that tract of country, for the purpose of burning the white" + " marble which composes a large part of the substance of the hills. Some of them, built " + "years ago, and long deserted, with weeds growing in the vacant round of the interior, " + "which is open to the sky, and grass and wild-flowers rooting themselves into the chinks" + "of the stones, look already like relics of antiquity, and may yet be overspread with the" + " lichens of centuries to come.</flow:span>" + "</flow:p>" + "</flow:TextFlow>"; public function ContainerController_getContentBoundsExample(textFlow:TextFlow):void { // Body text TextFlow and flow composer var textFlow:TextFlow = new TextFlow(); textFlow = TextConverter.importToFlow(textMarkup, TextConverter.TEXT_LAYOUT_FORMAT); var container:Sprite = new Sprite(); var controller:ContainerController = new ContainerController(container, 120, 200); container.x = 150; container.y = 50; // Add controller to text flow; add container to stage and display text textFlow.flowComposer.addController(controller); addChild(container); textFlow.flowComposer.updateAllControllers(); // draw a border around the text drawBorder(controller); } private function drawBorder(controller:ContainerController):void { // get the rectangle that makes up the bounds of the content var bounds:Rectangle = controller.getContentBounds(); // retrieve the container and draw the border var container:Sprite = controller.container as Sprite; container.graphics.lineStyle(.5); container.graphics.moveTo(bounds.left,bounds.top); container.graphics.lineTo(bounds.right,bounds.top); container.graphics.lineTo(bounds.right,bounds.bottom); container.graphics.lineTo(bounds.left,bounds.bottom); container.graphics.lineTo(bounds.left,bounds.top); container.graphics.drawRect(bounds.left, bounds.top, bounds.width, bounds.height ); } } }
getFirstTextLineChildIndex | () | メソッド |
protected function getFirstTextLineChildIndex():int
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
親内で最初のテキスト行を表示させるインデックスを取得します。このメソッドのデフォルト実装(オーバーライド可能)は、container
の flash.text.engine.TextLine
の子が存在する場合はその最初の子のインデックス、存在しない場合は container
の最後の子のインデックスを返します。
int — 親内で最初のテキスト行を表示させるインデックスです。
|
関連する API エレメント
getScrollDelta | () | メソッド |
public function getScrollDelta(numLines:int):Number
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
指定した行数により、画面上下へのスクロールに必要なスクロール距離を計算します。正の数値で上にスクロールされ、TextFlow の上部がより多く表示されます。正の数値で下にスクロールされ、最下部の次の行が完全に表示されます。
例えば上にスクロールしても、このメソッドでは次の行が完全に表示されます。次の行の一部が表示されず、指定されている行数が 1 の場合、一部が表示されていなかった行は完全に表示されるようになります。
パラメーター
numLines:int — スクロールする必要がある行数です。
|
Number — スクロールする必要がある超過領域の量
|
getStyle | () | メソッド |
imeStartCompositionHandler | () | メソッド |
invalidateContents | () | メソッド |
public function invalidateContents():void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
このコンテナ内のすべてのテキストを、構成の必要があるものとしてマーキングします。
例 ( この例の使用方法 )
package flashx.textLayout.container.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.conversion.TextConverter; public class ContainerController_invalidateContentsExample extends Sprite { public function ContainerController_invalidateContentsExample() { // create container, text flow, composer, paragraph, and span var container:Sprite = new Sprite(); var textFlow:TextFlow = new TextFlow(); var paragraph:ParagraphElement = new ParagraphElement(); var span:SpanElement = new SpanElement; // add container to the stage; create controller and add it to the text flow addChild(container); container.x = 100; container.y = 50; var controller:ContainerController = new ContainerController(container, 200, 200); textFlow.flowComposer.addController(controller); // set font size and add text to the span; add the span to the paragraph textFlow.fontSize = 16; span.text = "Does invalidateContents() cause this text to be damaged?"; paragraph.addChild(span); textFlow.addChild(paragraph); //update controller to display text textFlow.flowComposer.updateAllControllers(); // invalidate the controller contents and check to see if they are damaged controller.invalidateContents(); if(controller.isDamaged()) span.text += "\nYes, it does."; else span.text += "\nNo, it doesn't"; textFlow.flowComposer.updateAllControllers(); } } }
isDamaged | () | メソッド |
public function isDamaged():Boolean
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
構成を必要とするテキストがコンテナに含まれているかどうかを判別します。
戻り値Boolean — コンテナが構成を必要としている場合は、true です。
|
例 ( この例の使用方法 )
package flashx.textLayout.container.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.conversion.TextConverter; public class ContainerController_isDamagedExample extends Sprite { public function ContainerController_isDamagedExample() { // create container, composer, text flow, paragraph, and span var container:Sprite = new Sprite(); var textFlow:TextFlow = new TextFlow(); var paragraph:ParagraphElement = new ParagraphElement(); var span:SpanElement = new SpanElement; // add container to the stage; create controller and add it to the text flow addChild(container); var controller:ContainerController = new ContainerController(container, 200, 700 ); textFlow.flowComposer.addController(controller); //set font size, add text to the span and the paragraph to the text flow textFlow.fontSize = 24; span.text = "Does this text flow need to be composed?"; paragraph.addChild(span); textFlow.addChild(paragraph); // display the text textFlow.flowComposer.updateAllControllers(); // replace 'this' with 'your' and check to see if text flow is damaged span.replaceText(5, 9, "your"); if(controller.isDamaged()) { span.text += " Yes it does."; } textFlow.flowComposer.updateAllControllers(); } } }
keyDownHandler | () | メソッド |
public function keyDownHandler(event:KeyboardEvent):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
クライアントによるイベントの管理時に、KeyboardEvent.KEY_DOWN
イベントを処理します。
パラメーター
event:KeyboardEvent — KeyboardEvent オブジェクトです。
|
関連する API エレメント
keyFocusChangeHandler | () | メソッド |
public function keyFocusChangeHandler(event:FocusEvent):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
クライアントによるイベントの管理時に、FocusEvent.KEY_FOCUS_CHANGE
イベントを処理します。
パラメーター
event:FocusEvent — FocusEvent オブジェクトです。
|
関連する API エレメント
keyUpHandler | () | メソッド |
public function keyUpHandler(event:KeyboardEvent):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
クライアントによるイベントの管理時に、Keyboard.KEY_UP
イベントを処理します。
パラメーター
event:KeyboardEvent — KeyboardEvent オブジェクトです。
|
関連する API エレメント
例 ( この例の使用方法 )
package flashx.textLayout.container.examples { import flash.events.KeyboardEvent; import flash.display.Sprite; import flashx.textLayout.container.ContainerController; public class ContainerController_keyUpHandlerExample extends ContainerController { public function ContainerController_keyUpHandlerExample(container:Sprite, compositionWidth:Number=100, compositionHeight:Number=100) { super(container, compositionWidth, compositionHeight); } override public function keyUpHandler(event:KeyboardEvent):void { // run the TLF handler for the KEY_UP event super.keyUpHandler(event); // and add your own code for the event trace("You are in keyUpHandler()"); } } }
menuSelectHandler | () | メソッド |
public function menuSelectHandler(event:ContextMenuEvent):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
クライアントによるイベントの管理時に、ContextMenuEvent.MENU_SELECT
イベントを処理します。
パラメーター
event:ContextMenuEvent — ContextMenuEvent オブジェクトです。
|
関連する API エレメント
例 ( この例の使用方法 )
package flashx.textLayout.container.examples { import flash.events.ContextMenuEvent; import flash.display.Sprite; import flashx.textLayout.container.ContainerController; public class ContainerController_menuSelectHandlerExample extends ContainerController { public function ContainerController_menuSelectHandlerExample(container:Sprite, compositionWidth:Number=100, compositionHeight:Number=100) { super(container, compositionWidth, compositionHeight); } override public function menuSelectHandler(event:ContextMenuEvent):void { // run the TLF handler for the MENU_SELECT event super.menuSelectHandler(event); // and add your own code for the event trace("You are in menuSelectHandler()"); } } }
mouseDoubleClickHandler | () | メソッド |
public function mouseDoubleClickHandler(event:MouseEvent):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
クライアントによるイベントの管理時に、MouseEvent.DOUBLE_CLICK
イベントを処理します。
パラメーター
event:MouseEvent — MouseEvent オブジェクトです。
|
関連する API エレメント
例 ( この例の使用方法 )
package flashx.textLayout.container.examples { import flash.events.MouseEvent; import flash.display.Sprite; import flashx.textLayout.container.ContainerController; public class ContainerController_mouseDoubleClickHandlerExample extends ContainerController { public function ContainerController_mouseDoubleClickHandlerExample(container:Sprite, compositionWidth:Number=100, compositionHeight:Number=100) { super(container, compositionWidth, compositionHeight); } override public function mouseDoubleClickHandler(event:MouseEvent):void { // run the TLF handler for the MOUSE_OVER event super.mouseDoubleClickHandler(event); // and add your own code for the event trace("You are in mouseDoubleClickHandler()"); } } }
mouseDownHandler | () | メソッド |
public function mouseDownHandler(event:MouseEvent):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
クライアントによるイベントの管理時に、MouseEvent.MOUSE_DOWN
イベントを処理します。
パラメーター
event:MouseEvent — MouseEvent オブジェクトです。
|
関連する API エレメント
mouseMoveHandler | () | メソッド |
public function mouseMoveHandler(event:MouseEvent):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
クライアントによるイベントの管理時に、MouseEvent.MOUSE_MOVE
イベントを処理します。
パラメーター
event:MouseEvent — MouseEvent オブジェクトです。
|
関連する API エレメント
mouseMoveSomewhere | () | メソッド |
mouseOutHandler | () | メソッド |
public function mouseOutHandler(event:MouseEvent):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
クライアントによるイベントの管理時に、MouseEvent.MOUSE_OUT
イベントを処理します。
パラメーター
event:MouseEvent — MouseEvent オブジェクトです。
|
関連する API エレメント
mouseOverHandler | () | メソッド |
public function mouseOverHandler(event:MouseEvent):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
クライアントによるイベントの管理時に、MouseEvent.MOUSE_OVER
イベントを処理します。
パラメーター
event:MouseEvent — MouseEvent オブジェクトです。
|
関連する API エレメント
例 ( この例の使用方法 )
package flashx.textLayout.container.examples { import flash.events.MouseEvent; import flash.display.Sprite; import flashx.textLayout.container.ContainerController; public class ContainerController_mouseOverHandlerExample extends ContainerController { public function ContainerController_mouseOverHandlerExample(container:Sprite, compositionWidth:Number=100, compositionHeight:Number=100) { super(container, compositionWidth, compositionHeight); } override public function mouseOverHandler(event:MouseEvent):void { // run the TLF handler for the MOUSE_OVER event super.mouseOverHandler(event); // and add your own code for the event trace("You are in mouseOverHandler()"); } } }
mouseUpHandler | () | メソッド |
public function mouseUpHandler(event:MouseEvent):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
クライアントによるイベントの管理時に、MouseEvent.MOUSE_UP
イベントを処理します。
パラメーター
event:MouseEvent — MouseEvent オブジェクトです。
|
関連する API エレメント
mouseUpSomewhere | () | メソッド |
mouseWheelHandler | () | メソッド |
public function mouseWheelHandler(event:MouseEvent):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
クライアントによるイベントの管理時に、MouseEvent.MOUSE_WHEEL
イベントを処理します。
パラメーター
event:MouseEvent — MouseEvent オブジェクトです。
|
関連する API エレメント
removeBackgroundShape | () | メソッド |
removeInlineGraphicElement | () | メソッド |
protected function removeInlineGraphicElement(parent:DisplayObjectContainer, inlineGraphicElement:DisplayObject):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 2.0 |
flash.display.DisplayObject
オブジェクトを親から削除します。 このメソッドのデフォルト実装(オーバーライド可能)は、オブジェクトがコンテナの直接の子である場合、そのオブジェクトを container
から削除します。オブジェクトが parent
の下位要素でなくても、このメソッドは呼び出し可能です。 このメソッドを実装する場合は、このような場合に何のアクションも実行されないようにする必要があります。
パラメーター
parent:DisplayObjectContainer — 削除する flash.display.DisplayObject オブジェクト
| |
inlineGraphicElement:DisplayObject |
関連する API エレメント
removeSelectionContainer | () | メソッド |
protected function removeSelectionContainer(selectionContainer:DisplayObjectContainer):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
選択シェイプ(ブロック選択ハイライトやカーソルなど)を格納する flash.display.DisplayObjectContainer
オブジェクトを削除します。このメソッドのデフォルト実装(オーバーライド可能)は、オブジェクトを親から削除します(存在する場合)。
パラメーター
selectionContainer:DisplayObjectContainer — 削除する flash.display.DisplayObjectContainer オブジェクト
|
関連する API エレメント
removeTextLine | () | メソッド |
protected function removeTextLine(textLine:flash.text.engine:TextLine):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
flash.text.engine.TextLine
オブジェクトを親から削除します。このメソッドのデフォルト実装(オーバーライド可能)は、オブジェクトがコンテナの直接の子である場合、そのオブジェクトを container
から削除します。オブジェクトが container
の下位要素でなくても、このメソッドは呼び出し可能です。このメソッドを実装する場合は、このような場合に何のアクションも実行されないようにする必要があります。
パラメーター
textLine:flash.text.engine:TextLine — 削除する flash.text.engine.TextLine オブジェクト
|
関連する API エレメント
scrollToRange | () | メソッド |
public function scrollToRange(activePosition:int, anchorPosition:int):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
テキスト範囲がコンテナ内に表示されるようにスクロールします。
パラメーター
activePosition:int — 選択範囲の拡張時に変更された選択範囲の端。選択範囲の先頭または末尾のいずれかを指定でき、テキストフローの先頭からのオフセットとして表します。
| |
anchorPosition:int — 選択範囲の拡張時に変更されなかった選択範囲の端です。選択範囲の先頭または末尾のいずれかを指定できます。
|
selectRange | () | メソッド |
public function selectRange(anchorIndex:int, activeIndex:int):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0, Flash Player 10.0 |
ITextSupport を実装するコンポーネントに、選択したテキストの範囲を設定します。いずれかの引数が範囲外である場合、選択は変更されません。インライン IME をサポートするコンポーネントでは、このメソッドへの呼び出しが必要です。
パラメーター
anchorIndex:int — 選択のアンカー終点位置にある文字の、ゼロベースのインデックス値
| |
activeIndex:int — 選択のアクティブ終点位置にある文字の、ゼロベースのインデックス値
|
setCompositionSize | () | メソッド |
public function setCompositionSize(w:Number, h:Number):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
コンテナ内でテキストに使用できる幅と高さを設定します。幅と高さはピクセル単位で指定できます。どちらの値にも NaN
を使用できます。 NaN
は、その値を測定することを示します。 最大幅の行やすべてのコンテンツの高さの合計を調べるために使用できます。 NaN を幅として指定した場合、TextLine.MAX_LINE_WIDTH
の最大幅で改行されます。 NaN
を高さとして指定した場合、コンテナの高さは無制限であると想定されます。 getContentBounds
で実際の測定値に戻すことができます。 TextFlow
の blockProgression
プロパティの計算値が BlockProgression.RL
である場合は、幅と高さの意味が入れ替わります。
パラメーター
w:Number — コンテナ内でテキストに使用できる幅(ピクセル単位)です。NaN は、幅が指定されていないことを示します。
| |
h:Number — コンテナ内でテキストに使用できる高さ(ピクセル単位)です。NaN は、高さが指定されていないことを示します。
|
関連する API エレメント
flashx.textLayout.formats.BlockProgression
getContentBounds()
例 ( この例の使用方法 )
setCompositionSize()
を使用して、構成の幅と高さを設定します。
package flashx.textLayout.container.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.conversion.TextConverter; public class ContainerController_setCompositionSizeExample extends Sprite { public function ContainerController_setCompositionSizeExample() { // create container, text flow, composer, paragraph, and span var container:Sprite = new Sprite(); var textFlow:TextFlow = new TextFlow(); var paragraph:ParagraphElement = new ParagraphElement(); var span:SpanElement = new SpanElement; // add container to the stage; create controller and add it to the text flow addChild(container); container.x = 100; container.y = 50; var controller:ContainerController = new ContainerController(container); textFlow.flowComposer.addController(controller); // set font size and add text to the span; add the span to the paragraph textFlow.fontSize = 12; controller.setCompositionSize(250, 200); span.text = "This example uses setCompositionSize() to set compositionWidth ("; span.text += controller.compositionWidth; span.text += ") and compositionHeight (" span.text += controller.compositionHeight; span.text += "), rather than setting them with:\nnew ContainerController()"; paragraph.addChild(span); // add paragraph to text flow, and display text textFlow.addChild(paragraph); textFlow.flowComposer.updateAllControllers(); } } }
setStyle | () | メソッド |
softKeyboardActivatingHandler | () | メソッド |
textInputHandler | () | メソッド |
public function textInputHandler(event:flash.events:TextEvent):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
クライアントによるイベントの管理時に、TextEvent.TEXT_INPUT
イベントを処理します。
パラメーター
event:flash.events:TextEvent — TextEvent オブジェクトです。
|
関連する API エレメント
例 ( この例の使用方法 )
package flashx.textLayout.container.examples { import flash.events.TextEvent; import flash.display.Sprite; import flashx.textLayout.container.ContainerController; public class ContainerController_textInputHandlerExample extends ContainerController { public function ContainerController_textInputHandlerExample(container:Sprite, compositionWidth:Number=100, compositionHeight:Number=100) { super(container, compositionWidth, compositionHeight); } override public function textInputHandler(event:TextEvent):void { // run the TLF handler for the textInput event super.textInputHandler(event); // and add your own code for the event - e.g. only allow alpha characters trace("You are in textInputHandler()"); } } }
updateGraphics | () | メソッド |
updateVisibleRectangle | () | メソッド |
protected function updateVisibleRectangle():void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
スクロールする場合、途中までしか表示されない行がスクロール可能な領域内に収まるよう、スクロール矩形をコンテナ矩形に設定します。スクロールしない場合、クリッピングが行われないよう、スクロール矩形を解除します。
package flashx.textLayout.container.examples { import flash.display.Sprite; import flashx.textLayout.compose.StandardFlowComposer; import flashx.textLayout.container.ContainerController; import flashx.textLayout.conversion.TextConverter; import flashx.textLayout.elements.TextFlow; public class ContainerControllerExample1 extends Sprite { private const textMarkup:String = "<flow:TextFlow xmlns:flow='http://ns.adobe.com/textLayout/2008' fontSize='8' " + "textIndent='10' paragraphSpaceBefore='6' paddingTop='8' paddingLeft='8' paddingRight='8'>" + "<flow:p paragraphSpaceBefore='inherit'>" + "<flow:span>There are many </flow:span>" + "<flow:span fontStyle='italic'>such</flow:span>" + "<flow:span> lime-kilns in that tract of country, for the purpose of burning the white" + " marble which composes a large part of the substance of the hills. Some of them, built " + "years ago, and long deserted, with weeds growing in the vacant round of the interior, " + "which is open to the sky, and grass and wild-flowers rooting themselves into the chinks" + "of the stones, look already like relics of antiquity, and may yet be overspread with the" + " lichens of centuries to come. Others, where the lime-burner still feeds his daily and " + "nightlong fire, afford points of interest to the wanderer among the hills, who seats " + "himself on a log of wood or a fragment of marble, to hold a chat with the solitary man. " + "It is a lonesome, and, when the character is inclined to thought, may be an intensely " + "thoughtful occupation; as it proved in the case of Ethan Brand, who had mused to such " + "strange purpose, in days gone by, while the fire in this very kiln was burning.</flow:span>" + "</flow:p>" + "<flow:p paragraphSpaceBefore='inherit'>" + "<flow:span>" + "The man who now watched the fire was of a different order, and troubled himself with no " + "thoughts save the very few that were requisite to his business. At frequent intervals, " + "he flung back the clashing weight of the iron door, and, turning his face from the " + "insufferable glare, thrust in huge logs of oak, or stirred the immense brands with a " + "long pole. Within the furnace were seen the curling and riotous flames, and the burning " + "marble, almost molten with the intensity of heat; while without, the reflection of the " + "fire quivered on the dark intricacy of the surrounding forest, and showed in the " + "foreground a bright and ruddy little picture of the hut, the spring beside its door, the " + "athletic and coal-begrimed figure of the lime-burner, and the halffrightened child, " + "shrinking into the protection of his father's shadow. And when again the iron door was " + "closed, then reappeared the tender light of the half-full moon, which vainly strove to" + "trace out the indistinct shapes of the neighboring mountains; and, in the upper sky, " + "there was a flitting congregation of clouds, still faintly tinged with the rosy sunset, " + "though thus far down into the valley the sunshine had vanished long and long ago.</flow:span>" + "</flow:p>" + "</flow:TextFlow>"; public function ContainerControllerExample1() { // create the TextFlow, containers, and container controllers var textFlow:TextFlow; var container:Sprite = new Sprite(); var container2:Sprite = new Sprite(); var controllerOne:ContainerController = new ContainerController(container, 200, 210); var controllerTwo:ContainerController = new ContainerController(container2, 200, 220); // import the text flow from markup using TextConverter and assign a StandardFlowComposer textFlow = TextConverter.importToFlow(textMarkup, TextConverter.TEXT_LAYOUT_FORMAT); textFlow.flowComposer = new StandardFlowComposer(); // draw the container circles, add them to the stage and position them container.graphics.beginFill(0xFFCC00); container.graphics.drawCircle(100, 100, 140); container.graphics.endFill(); container2.graphics.beginFill(0xFF0000); container2.graphics.drawCircle(100, 100, 140); container2.graphics.endFill(); addChild(container); addChild(container2); container.x = 25; container.y = 100; container2.x = 280; container2.y = 100; // add the controllers to the text flow and update them to display the text textFlow.flowComposer.addController(controllerOne); textFlow.flowComposer.addController(controllerTwo); textFlow.flowComposer.updateAllControllers(); } } }
package flashx.textLayout.container.examples { import flash.display.Sprite; import flash.display.StageAlign; import flash.events.Event; import flash.geom.Rectangle; import flashx.textLayout.container.ContainerController; import flashx.textLayout.container.ScrollPolicy; import flashx.textLayout.conversion.TextConverter; import flashx.textLayout.edit.SelectionManager; import flashx.textLayout.elements.TextFlow; import flashx.textLayout.formats.TextLayoutFormat; public class ContainerControllerExample2 extends Sprite { // these variables are accessible to both methods in the class private var headingFlow:TextFlow; private var bodyFlow:TextFlow; private var headController:ContainerController; private var bodyController:ContainerController; private const headingMarkup:String = "<flow:TextFlow xmlns:flow='http://ns.adobe.com/textLayout/2008'>" + "<flow:p textAlign='center'>" + "<flow:span fontFamily='Georgia' fontSize='36'>Ethan Brand</flow:span><flow:br/>" + "<flow:span fontSize='8' fontStyle='italic'>by </flow:span>" + "<flow:span fontSize='12' fontStyle='italic'>Nathaniel Hawthorne</flow:span>" + "</flow:p>" + "</flow:TextFlow>"; private const bodyMarkup:String = "<flow:TextFlow xmlns:flow='http://ns.adobe.com/textLayout/2008' fontSize='8' " + "textIndent='10' paragraphSpaceBefore='6' paddingTop='8' paddingBottom='8' paddingLeft='8' paddingRight='8'>" + "<flow:p paragraphSpaceBefore='inherit' >" + "<flow:span>There are many </flow:span>" + "<flow:span fontStyle='italic'>such</flow:span>" + "<flow:span> lime-kilns in that tract of country, for the purpose of burning the white" + " marble which composes a large part of the substance of the hills. Some of them, built " + "years ago, and long deserted, with weeds growing in the vacant round of the interior, " + "which is open to the sky, and grass and wild-flowers rooting themselves into the chinks " + "of the stones, look already like relics of antiquity, and may yet be overspread with the" + " lichens of centuries to come. Others, where the lime-burner still feeds his daily and " + "nightlong fire, afford points of interest to the wanderer among the hills, who seats " + "himself on a log of wood or a fragment of marble, to hold a chat with the solitary man. " + "It is a lonesome, and, when the character is inclined to thought, may be an intensely " + "thoughtful occupation; as it proved in the case of Ethan Brand, who had mused to such " + "strange purpose, in days gone by, while the fire in this very kiln was burning.</flow:span>" + "</flow:p>" + "<flow:p paragraphSpaceBefore='inherit'>" + "<flow:span>" + "The man who now watched the fire was of a different order, and troubled himself with no " + "thoughts save the very few that were requisite to his business. At frequent intervals, " + "he flung back the clashing weight of the iron door, and, turning his face from the " + "insufferable glare, thrust in huge logs of oak, or stirred the immense brands with a " + "long pole. Within the furnace were seen the curling and riotous flames, and the burning " + "marble, almost molten with the intensity of heat; while without, the reflection of the " + "fire quivered on the dark intricacy of the surrounding forest, and showed in the " + "foreground a bright and ruddy little picture of the hut, the spring beside its door, the " + "athletic and coal-begrimed figure of the lime-burner, and the halffrightened child, " + "shrinking into the protection of his father's shadow. And when again the iron door was " + "closed, then reappeared the tender light of the half-full moon, which vainly strove to " + "trace out the indistinct shapes of the neighboring mountains; and, in the upper sky, " + "there was a flitting congregation of clouds, still faintly tinged with the rosy sunset, " + "though thus far down into the valley the sunshine had vanished long and long ago.</flow:span>" + "</flow:p>" + "</flow:TextFlow>"; public function ContainerControllerExample2() { // align the stage and add a listener (resizeHandler) for RESIZE events stage.align = StageAlign.TOP_LEFT; stage.addEventListener(flash.events.Event.RESIZE, resizeHandler); // create heading text flow, import heading text, and assign composer headingFlow = new TextFlow(); headingFlow = TextConverter.importToFlow(headingMarkup, TextConverter.TEXT_LAYOUT_FORMAT); // create body text flow, import body text, and assign flow composer bodyFlow = new TextFlow(); bodyFlow = TextConverter.importToFlow(bodyMarkup, TextConverter.TEXT_LAYOUT_FORMAT); // create heading container, add controller, position container and add to stage var headContainer:Sprite = new Sprite(); headController = new ContainerController(headContainer, 300, 50); headingFlow.flowComposer.addController(headController); headContainer.x = 120; headContainer.y = 20; addChild(headContainer); // update controller to display heading text headingFlow.flowComposer.updateAllControllers(); // create container for body text and position it var bodyContainer:Sprite = new Sprite(); bodyController = new ContainerController(bodyContainer, 300, 200); bodyContainer.x = 125; bodyContainer.y = 85; // create container format to specify columns var bodyContainerFormat:TextLayoutFormat = new TextLayoutFormat(); bodyContainerFormat.columnWidth = 120; bodyContainerFormat.columnGap = 15; bodyController.format = bodyContainerFormat; // enable scrolling bodyController.verticalScrollPolicy = ScrollPolicy.AUTO; bodyFlow.interactionManager = new SelectionManager(); // add controller, add container to stage, and display body text bodyFlow.flowComposer.addController(bodyController); addChild(bodyContainer); bodyFlow.flowComposer.updateAllControllers(); } private function resizeHandler(event:Event):void { const verticalGap:Number = 25; const stagePadding:Number = 16; var stageWidth:Number = stage.stageWidth - stagePadding; var stageHeight:Number = stage.stageHeight - stagePadding; var headlineWidth:Number = stageWidth; var headlineContainerHeight:Number = stageHeight; // Initial compose to get height of headline after resize headController.setCompositionSize(headlineWidth, headlineContainerHeight); headingFlow.flowComposer.compose(); var rect:Rectangle = headController.getContentBounds(); headlineContainerHeight = rect.height; // Resize and place headline text container // Call setCompositionSize() again with updated headline height headController.setCompositionSize(headlineWidth, headlineContainerHeight ); headController.container.x = stagePadding / 2; headController.container.y = stagePadding / 2; headingFlow.flowComposer.updateAllControllers(); // Resize and place body text container var bodyContainerHeight:Number = (stageHeight - verticalGap - headlineContainerHeight); bodyController.setCompositionSize(stageWidth, bodyContainerHeight ); bodyController.container.x = (stagePadding/2); bodyController.container.y = (stagePadding/2) + headlineContainerHeight + verticalGap; bodyFlow.flowComposer.updateAllControllers(); } } }
Tue Jun 12 2018, 10:34 AM Z