| パッケージ | flashx.textLayout.compose |
| クラス | public final class TextFlowLine |
| 継承 | TextFlowLine  Object |
| 実装 | IVerticalJustificationLine |
| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
このクラスを使用して、テキストの行がその位置、高さ、幅などを構成されている方法に関する情報にアクセスできます。テキストフロー（TextFlow）が変更されると、変更された箇所の行とその直前の行は、再構成が必要となるため、不正としてマークされます。変更された箇所の後の行は即座に損傷されませんが、テキストが構成されると、再生成される場合があります。損傷された TextFlowLine にアクセスすることは可能ですが、アクセスするすべての値は TextFlow の古い状態を反映したものとなります。TextFlow が再構成されると、新しい行が作成され、TextFlow.flowComposer.findLineAtPosition() を呼び出して新しい行を指定の位置に置くことができます。
継承されるパブリックプロパティを隠す
継承されるパブリックプロパティを表示| プロパティ | 定義元 | ||
|---|---|---|---|
| absoluteStart : int [読み取り専用]
TextFlow オブジェクト内の絶対文字位置としての位置です。 | TextFlowLine | ||
| ascent : Number [読み取り専用]
行の基準から最も高さのある文字の最上部までのピクセル数を指定します。 | TextFlowLine | ||
| columnIndex : int [読み取り専用] 行が配置される列の番号で、最初の列は 0 です。 | TextFlowLine | ||
 | constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | |
| controller : ContainerController [読み取り専用]
行が配置されるコンテナに対するコントローラー（ContainerController オブジェクト）です。 | TextFlowLine | ||
| descent : Number [読み取り専用]
行の基準から最も下に突き出している文字の最下部までのピクセル数を指定します。 | TextFlowLine | ||
| height : Number [読み取り専用] 行の高さ（ピクセル単位）です。 | TextFlowLine | ||
| lineOffset : Number [読み取り専用]
段落内で行を揃える前の、（段落の方向とコンテナのブロックの進行方向により決定される）適切なコンテナのインセットを基点とする行のオフセット（ピクセル単位）です。 | TextFlowLine | ||
| location : int [読み取り専用]
TextFlowLineLocation の値の 1 つで、段落内の行の位置を指定します。 | TextFlowLine | ||
| paragraph : ParagraphElement [読み取り専用]
行が配置されている段落（ParagraphElement）です。 | TextFlowLine | ||
| spaceAfter : Number [読み取り専用]
行後に空ける余白の量です。 | TextFlowLine | ||
| spaceBefore : Number [読み取り専用]
行前に空ける余白の量です。 | TextFlowLine | ||
| textHeight : Number [読み取り専用]
テキスト行の高さ、つまり ascent + descent に等しくなります。 | TextFlowLine | ||
| textLength : int [読み取り専用]
次の行までの文字数（行末のスペースを含む）です。 | TextFlowLine | ||
| textLineExists : Boolean [読み取り専用]
この TextFlowLine の flash.text.engine.TextLine オブジェクトが存在するかどうかを示します。 | TextFlowLine | ||
| unjustifiedTextWidth : Number [読み取り専用]
均等配置をしていない場合の行の幅です。 | TextFlowLine | ||
| validity : String [読み取り専用] 行の有効性です。 | TextFlowLine | ||
| x : Number
行のコンテナに対する水平方向の相対位置です。コンテナの左側からのオフセット（ピクセル単位）で表現されます。 | TextFlowLine | ||
| y : Number
行のコンテナに対する垂直方向の相対位置です。コンテナの上部からのオフセット（ピクセル単位）で表現されます。 | TextFlowLine | ||
| メソッド | 定義元 | ||
|---|---|---|---|
TextFlowLine(textLine:flash.text.engine:TextLine, paragraph:ParagraphElement, outerTargetWidth:Number = 0, lineOffset:Number = 0, absoluteStart:int = 0, numChars:int = 0) コンストラクター - 新しい TextFlowLine インスタンスを作成します。 | TextFlowLine | ||
行の境界を矩形として返します。 | TextFlowLine | ||
この行の flash.text.engine.TextLine オブジェクトを返します。このオブジェクトは、ガベージコレクションが原因で消失している場合、再作成される場合があります。 | TextFlowLine | ||
|
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | |
|
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | |
|
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | |
|
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | |
|
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのプリミティブな値を返します。 | Object | |
absoluteStart | プロパティ |
ascent | プロパティ |
columnIndex | プロパティ |
controller | プロパティ |
controller:ContainerController [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
行が配置されるコンテナに対するコントローラー（ContainerController オブジェクト）です。
実装
public function get controller():ContainerController関連する API エレメント
descent | プロパティ |
height | プロパティ |
lineOffset | プロパティ |
location | プロパティ |
paragraph | プロパティ |
paragraph:ParagraphElement [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
行が配置されている段落（ParagraphElement）です。
実装
public function get paragraph():ParagraphElement関連する API エレメント
spaceAfter | プロパティ |
spaceAfter:Number [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
行後に空ける余白の量です。
行が段落の最後の行で、行後に余白が適用されている場合、その行には spaceAfter の値が適用されます。行が列の一番下に来ると、spaceAfter は無視されます。そうでないと、その行は列内の他の行の前に入り、段落のこの最後の行と次の段落の最初の行の間に少なくともこの量の余白を保つようにするために、以降の行は垂直に配置されてしまいます。
実装
public function get spaceAfter():Number関連する API エレメント
spaceBefore | プロパティ |
spaceBefore:Number [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
行前に空ける余白の量です。
行が段落の最初の行で、行前に余白が適用されている場合、その行には spaceBefore の値が適用されます。行が列の一番上に来ると、spaceBefore は無視されます。そうでないと、その行は列内の他の行の後に入り、この最初の行と前の段落の最後の行の間に少なくともこの量の余白を保つようにするために、垂直に配置されます。
実装
public function get spaceBefore():Number関連する API エレメント
textHeight | プロパティ |
textHeight:Number [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
テキスト行の高さ、つまり ascent + descent に等しくなります。値は、y=0 のベースラインが文字（例：TextBaseline.IDEOGRAPHIC_TOP）であるかどうかにより、行を結合する文字の最上部と最下部、またはアセントとディセントのいずれかのベースライン間の差に基づいて計算されます。
実装
public function get textHeight():Number関連する API エレメント
textLength | プロパティ |
textLineExists | プロパティ |
unjustifiedTextWidth | プロパティ |
unjustifiedTextWidth:Number [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
均等配置をしていない場合の行の幅です。位置揃えされていないテキストの場合、この値は textLength と同じです。位置揃えされているテキストの場合、この値は位置揃えされていなかった場合の長さであり、textLength の値が実際の行の幅を表します。例えば、次のストリングが均等配置され、幅に 500 を割り当てられた場合は、実際の幅が 500 ですが、均等配置されていない幅は 268.9921875 になります。
実装
public function get unjustifiedTextWidth():Numbervalidity | プロパティ |
x | プロパティ |
x:Number| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
行のコンテナに対する水平方向の相対位置です。コンテナの左側からのオフセット（ピクセル単位）で表現されます。
注意：このプロパティは技術的には read-write ですが、read-only として扱う必要があります。setter は、IVerticalJustificationLine インターフェイスの要件を満たすためだけに存在します。このインターフェイスにはこのプロパティの getter と setter の両方が定義されています。setter を使用することは可能ですが、予期しない結果につながります。
実装
public function get x():Number public function set x(value:Number):void関連する API エレメント
y | プロパティ |
y:Number| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
行のコンテナに対する垂直方向の相対位置です。コンテナの上部からのオフセット（ピクセル単位）で表現されます。
注意：このプロパティは技術的には read-write ですが、read-only として扱う必要があります。setter は、IVerticalJustificationLine インターフェイスの要件を満たすためだけに存在します。このインターフェイスにはこのプロパティの getter と setter の両方が定義されています。setter を使用することは可能ですが、予期しない結果につながります。
実装
public function get y():Number public function set y(value:Number):void関連する API エレメント
TextFlowLine | () | コンストラクター |
public function TextFlowLine(textLine:flash.text.engine:TextLine, paragraph:ParagraphElement, outerTargetWidth:Number = 0, lineOffset:Number = 0, absoluteStart:int = 0, numChars:int = 0)| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
コンストラクター - 新しい TextFlowLine インスタンスを作成します。
注意：クライアントはこれを呼び出すことができません。これは、ユーザー自身のコンポーザーを記述するために公開されています。
パラメーターtextLine:flash.text.engine:TextLine — この行に使用される TextLine 表示オブジェクトです。
| |
paragraph:ParagraphElement — 行を配置する段落（ParagraphElement）です。
| |
outerTargetWidth:Number (default = 0) | |
lineOffset:Number (default = 0) | |
absoluteStart:int (default = 0) | |
numChars:int (default = 0) |
関連する API エレメント
getBounds | () | メソッド |
getTextLine | () | メソッド |
public function getTextLine(forceValid:Boolean = false):flash.text.engine:TextLine| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
この行の flash.text.engine.TextLine オブジェクトを返します。このオブジェクトは、ガベージコレクションが原因で消失している場合、再作成される場合があります。TextLine を再生成させるには、forceValid を true に設定します。TextLine を再生成できない場合、null を返します。
パラメーター
forceValid:Boolean (default = false) |
flash.text.engine:TextLine — この行のオブジェク、または TextLine オブジェクトを再作成できない場合は null です。
|
関連する API エレメント
Tue Jun 12 2018, 10:34 AM Z