FlowComposerBase

パッケージ	flashx.textLayout.compose
クラス	public class FlowComposerBase
継承	FlowComposerBase Object
サブクラス	StandardFlowComposer

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

FlowComposerBase クラスは、Text Layout Framework フローコンポーザークラスの基本クラスで、ContainerController オブジェクトのテキスト行の構成を制御します。

FlowComposerBase は、複数タイプのフローコンポーザーに共通するメソッドとプロパティを実装するユーティリティクラスです。アプリケーションコードは一般に、このクラスをインスタンス化または使用しません（カスタムフローコンポーザーを作成するために拡張する場合を除く）。

パブリックプロパティ

継承されるパブリックプロパティを隠す

継承されるパブリックプロパティを表示

	プロパティ		定義元
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		damageAbsoluteStart : int [読み取り専用] 構成と更新が必要なテキストフローの、最初のエレメントの直前の絶対位置。	FlowComposerBase
		numLines : int [読み取り専用] フロー内で構成される合計行数。	FlowComposerBase
		swfContext : ISWFContext 必要に応じて FTE 呼び出しを行うために使用される ISWFContext インスタンスです。	FlowComposerBase
		textFlow : flashx.textLayout.elements:TextFlow [読み取り専用] このフローコンポーザーが関連付けられている TextFlow オブジェクト。	FlowComposerBase

パブリックメソッド

継承されるパブリックメソッドを隠す

継承されるパブリックメソッドを表示

	メソッド		定義元
		FlowComposerBase() コンストラクターです。	FlowComposerBase
		damage(startPosition:int, damageLength:int, damageType:String):void 損傷していて再構成が必要なものとして行にマークをつけます。	FlowComposerBase
		findLineAtPosition(absolutePosition:int, preferPrevious:Boolean = false):flashx.textLayout.compose:TextFlowLine 指定された位置のコンテンツを含む、TextFlowLine オブジェクトを返します。	FlowComposerBase
		findLineIndexAtPosition(absolutePosition:int, preferPrevious:Boolean = false):int 指定された位置のコンテンツを含む TextFlowLine オブジェクトの、連続する行番号を返します。	FlowComposerBase
		getLineAt(index:int):flashx.textLayout.compose:TextFlowLine 指定された行番号の行を返します。	FlowComposerBase
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		isDamaged(absolutePosition:int):Boolean フローの開始と指定された位置のコンテンツを含む行との間の TextFlowLine オブジェクトに、損傷とマークされるものがあるかどうかを示します。	FlowComposerBase
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		toLocaleString():String ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		updateLengths(startPosition:int, deltaLength:int):void TextFlow へのマッピングが維持されるように行の長さを更新します。	FlowComposerBase
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object

プロパティの詳細

damageAbsoluteStart

プロパティ

damageAbsoluteStart:int [読み取り専用]

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

構成と更新が必要なテキストフローの、最初のエレメントの直前の絶対位置。

実装
public function get damageAbsoluteStart():int

numLines

プロパティ

numLines:int [読み取り専用]

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

フロー内で構成される合計行数。デフォルトでは、TLF はフロー全体を構成しないので、この値は不正確である場合があります。すべての行を構成するには、composeToPosition を使用します。

実装
public function get numLines():int

swfContext

プロパティ

swfContext:ISWFContext

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

必要に応じて FTE 呼び出しを行うために使用される ISWFContext インスタンスです。

デフォルトでは、ISWFContext 実装はこの FlowComposerBase オブジェクトです。アプリケーションでは、別の SWF ファイルに埋め込まれているフォントを使用したりテキスト行をキャッシュして再利用したりするための、カスタム実装を用意できます。

実装
public function get swfContext():ISWFContext
public function set swfContext(value:ISWFContext):void

textFlow

プロパティ

textFlow:flashx.textLayout.elements:TextFlow [読み取り専用]

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

このフローコンポーザーが関連付けられている TextFlow オブジェクト。

実装
public function get textFlow():flashx.textLayout.elements:TextFlow

()

コンストラクター

public function FlowComposerBase()

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

コンストラクターです。

メソッドの詳細

damage

()

メソッド

public function damage(startPosition:int, damageLength:int, damageType:String):void

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

損傷していて再構成が必要なものとして行にマークをつけます。

パラメーター

	`startPosition:int` — 損傷範囲の始点

	`damageLength:int` — 損傷の文字数

	`damageType:String` — 損傷のタイプ。flashx.textLayout.compose.FlowDamageType の 1 つ

findLineAtPosition

()

メソッド

 public function findLineAtPosition(absolutePosition:int, preferPrevious:Boolean = false):flashx.textLayout.compose:TextFlowLine

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

指定された位置のコンテンツを含む、TextFlowLine オブジェクトを返します。

位置は、テキストフローの 2 つの文字間または他のエレメント間の仕切りと見なすことができます。absolutePosition の値が、ある行の最後のエレメントと次の行の最初のエレメントの間の位置である場合、preferPrevious パラメーターが true に設定されている場合は前の行が返され、preferPrevious パラメーターが false に設定されている場合は後の行が返されます。

パラメーター

	`absolutePosition:int` — TextFlowLine オブジェクトが必要なコンテンツの位置。

	`preferPrevious:Boolean` (default = `false`) — ある行の最後のエレメントと次の行の最初のエレメントの間に位置がある場合に、返される行を指定します。

戻り値

flashx.textLayout.compose:TextFlowLine — 指定された位置のコンテンツを含む TextFlowLine、または見つからない場合は null。

findLineIndexAtPosition

()

メソッド

public function findLineIndexAtPosition(absolutePosition:int, preferPrevious:Boolean = false):int

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

指定された位置のコンテンツを含む TextFlowLine オブジェクトの、連続する行番号を返します。

最初の行の番号は 0 で、最後の行の番号は行数から 1 を引いた数です。absolutePosition で指定された位置がテキストフローの末尾よりも後の場合、このメソッドはテキストフローに追加された次の新規行に割り当てられる数（現在の行数）を返す必要があります。

位置は、テキストフローの 2 つの文字間または他のエレメント間の仕切りと見なすことができます。absolutePosition の値が、あるコンテナの最後の行と次のコンテナの最初の行の間の位置である場合、preferPrevious パラメーターが true に設定されている場合は前のコンテナが返され、preferPrevious パラメーターが false に設定されている場合は後のコンテナが返されます。

パラメーター

	`absolutePosition:int` — テキスト行が必要なコンテンツの位置。

	`preferPrevious:Boolean` (default = `false`) — あるコンテナの最後の行と次のコンテナの最初の行の間に位置がある場合に、返されるコンテナインデックスを指定します。

戻り値

int — 指定された位置のテキスト行のインデックス。見つからない場合は、末尾よりも後として処理し、行数を返します。

getLineAt

()

メソッド

public function getLineAt(index:int):flashx.textLayout.compose:TextFlowLine

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

指定された行番号の行を返します。

行のリストには、ゼロから行数マイナス 1 の数までの番号が付けられています。index の値が行リストの範囲外の場合、この関数は null を返します。

パラメーター

index:int — 返す TextFlowLine オブジェクトの行番号。

戻り値

flashx.textLayout.compose:TextFlowLine — 指定された行番号の TextFlowLine、または見つからない場合は null。

isDamaged

()

メソッド

public function isDamaged(absolutePosition:int):Boolean

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

フローの開始と指定された位置のコンテンツを含む行との間の TextFlowLine オブジェクトに、損傷とマークされるものがあるかどうかを示します。

パラメーター

absolutePosition:int — 該当領域の最後の位置

戻り値

Boolean — フローの開始から absolutePosition のコンテンツを含む行までの TextFlowLine オブジェクトに損傷とマークされるものがある場合は、true。

updateLengths

()

メソッド

public function updateLengths(startPosition:int, deltaLength:int):void

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

TextFlow へのマッピングが維持されるように行の長さを更新します。

パラメーター

	`startPosition:int` — 長さの変更の開始位置

	`deltaLength:int` — 文字数の変更。

法律上の注意 | プライバシーポリシー

FlowComposerBase - AS3

パッケージx

言語エレメント

付録

パッケージ flashx.textLayout.compose

damageAbsoluteStart

numLines

swfContext

textFlow