LayoutBase  - AS3 Flex

true の場合、ビューポートの境界に子をクリッピングするように指定します。false の場合、コンポーネントのサイズ指定に関係なく、コンテナの子がコンテナの境界を越えて拡張されます。

デフォルト値： false。

このレイアウトがドラッグ＆ドロップ操作の間にドロップインジケーターに対して使用する DisplayObject です。通常は、このプロパティを直接設定することはなく、代わりにドロップターゲットのスキンクラスで dropIndicator スキンパーツを定義します。

List コントロールは、DragEvent.DRAG_ENTER イベントが発生すると、このプロパティを設定します。List は、このプロパティの初期値として自身の dropIndicator スキンパーツを使用します。List は、DragEvent.DRAG_EXIT イベントが発生すると、このプロパティをクリアします。

コンポーネントの座標系における、ビューポートの原点の x 座標です。デフォルト値は (0,0) であり、これはコンポーネントの左上隅に対応します。clipAndEnableScrolling が true である場合、通常、このプロパティを設定するとビューポートが次の値に設定されます。

      new Rectangle(horizontalScrollPosition, verticalScrollPosition, width, height)
      

デフォルト値： 0。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange イベントが送出されます。

このレイアウトによってエレメントが測定され、そのサイズと位置が設定される GroupBase コンテナです。

サブクラスは、setter をオーバーライドして、ターゲット固有のアクションを実行できます。例えば、3D レイアウトは、ここでターゲットの maintainProjectionCenter プロパティを設定できます。

デフォルト値： null。

関連する API エレメント

固定の行 / 列サイズが要求されたときに、特定のサイズが指定されていない場合、レイアウトによって使用されます。ビュー内にスクロールされていないレイアウトエレメントのサイズを推定するために仮想レイアウトによって使用されます。

次の例に示すように、このプロパティは、コンテナのすべての子の高さを定義するために Flex で使用されるコンポーネントを参照します。

      <s:Group>
        <s:layout>
          <s:VerticalLayout variableRowHeight="false"
              typicalLayoutElement="{b3}"/> 
        </s:layout>
        <s:Button id="b1" label="Button 1"/>
        <s:Button id="b2" label="Button 2"/>
        <s:Button id="b3" label="Button 3" fontSize="36"/>
        <s:Button id="b4" label="Button 4" fontSize="24"/>
      </s:Group>

このプロパティが未設定であり、ターゲットが null 以外の場合は、ターゲットの最初のレイアウトエレメントがキャッシュされ、返されます。

デフォルト値は、ターゲットの最初のレイアウトエレメントです。

デフォルト値： null。

関連する API エレメント

1 つのコンテナには任意の数の子を追加できます。ただし、すべての子にアイテムレンダラーのインスタンスが必要です。コンテナに多数の子が既にある場合、さらに子を追加しようとすると、パフォーマンスが低下することがあります。

すべての子に対してアイテムレンダラーを作成する代わりに、仮想レイアウトを使用するようにコンテナを設定することもできます。仮想レイアウトを使用する場合、コンテナはアイテムレンダラーを再利用し、現在表示されている子に対してのみアイテムレンダラーを作成します。コンテナがスクロールされて現在表示されている子が画面外に移動した場合、新しく画面上に移動してきた子は、前の子のアイテムレンダラーを再利用できます。

仮想レイアウトを使用するようにコンテナを設定するには、コンテナに関連付けられているレイアウトの useVirtualLayout プロパティを true に設定します。レイアウトが VerticalLayout、HorizontalLayout または TileLayout に設定された DataGroup または SkinnableDataContainer のみが仮想レイアウトをサポートします。 仮想化をサポートしていないレイアウトサブクラスは、このプロパティを変更しないようにする必要があります。

メモ：useVirtualLayout を true に設定すると、BasicLayout クラスはランタイムエラーをスローします。

true の場合、仮想化をサポートするレイアウトは、getElementAt() ではなく target.getVirtualElementAt() メソッドを使用し、getScrollRect() の値で表示されると予想されるエレメントのみを取得する必要があります。

true の場合、レイアウトクラスは、レイアウトエレメントを取得してその境界を調べるのではなく、キャッシュされている情報のみに基づいて、updateDisplayList() メソッド内で scrollRect と重なるレイアウトエレメントのインデックスを計算できる必要があります。

通常、仮想レイアウトは、ビュー内のエレメントについて計算されたサイズと位置に基づいて、updateDisplayList() メソッドの中でキャッシュされている情報を更新します。

同様に、measure() メソッドを使用する場合、仮想レイアウトは、エレメントを測定するのではなく、typicalLayoutElement および他のキャッシュされているレイアウト情報を基にして、ターゲットの測定されたサイズプロパティを更新する必要があります。

コンテナは、以前に作成されたものの使用されなくなっているアイテムレンダラーをリサイクルすることで、useVirtualLayout = true が設定されているレイアウトと協調します。コンテナの最後の updateDisplayList() の呼び出しの間に要求された getVirtualElementAt() インデックスの範囲内にインデックスがないアイテムは、現在使用されていないものと見なされます。

デフォルト値： false。

関連する API エレメント

コンポーネントの座標系における、ビューポートの原点の y 座標です。デフォルト値は (0,0) であり、これはコンポーネントの左上隅に対応します。clipAndEnableScrolling が true である場合、通常、このプロパティを設定するとビューポートが次の値に設定されます。

      new Rectangle(horizontalScrollPosition, verticalScrollPosition, width, height)
      

デフォルト値： 0。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange イベントが送出されます。

コンストラクターです。

ドラッグ＆ドロップ動作中の指定された dropLocation までのスクロール距離を計算します。ドラッグスクロール中のスクロール距離を計算するために showDropIndicator() メソッドによって呼び出されます。

パラメーター

関連する API エレメント

ドラッグ＆ドロップ動作中にユーザーが指定された座標でマウスを離した場合に、新しいアイテムを挿入するインデックスを返します。calculatedDropLocation() メソッドによって呼び出されます。

パラメーター

関連する API エレメント

ドラッグ＆ドロップ動作の終了時にアイテムが挿入される位置をユーザーに対して視覚的にフィードバックするドロップインジケーターの境界を計算します。showDropIndicator() メソッドによって呼び出されます。

パラメーター

関連する API エレメント

指定した dragEvent に対するドロップターゲットのデータプロバイダー内でのドロップ位置を計算します。

パラメーター

関連する API エレメント

useVirtualLayout が true の場合、レイアウトターゲットが変化するときにターゲットでこのメソッドを使用すると、キャッシュされているレイアウト情報をクリアできます。

例えば、DataGroup の dataProvider または itemRenderer プロパティが変化すると、キャッシュされているエレメントのサイズが無効になります。

useVirtualLayout プロパティが false に変化すると、このメソッドが自動的に呼び出されます。

useVirtualLayout = true をサポートするサブクラスは、このメソッドをオーバーライドする必要があります。

レイアウトエレメントが追加されてからターゲットのサイズと表示リストが検証されるまでの間に、ターゲットで呼び出されます。各エレメント状態をキャッシュするレイアウト（仮想レイアウトなど）では、このメソッドをオーバーライドしてキャッシュを更新できます。

ターゲットでこのメソッドを呼び出す場合は、updateDisplayList() の呼び出し時に指定したインデックスにレイアウトエレメントが存在することのみが保証されます。例えば、仮想レイアウトを備えた DataGroup は、ターゲットの dataProvider にアイテムが追加されると、このメソッドを呼び出します。

デフォルトでは、このメソッドは何も実行しません。

パラメーター

関連する API エレメント

このメソッドは、レイアウトエレメントが削除されてからターゲットのサイズと表示リストが検証されるまでの間に、ターゲットで呼び出されます。各エレメント状態をキャッシュするレイアウト（仮想レイアウトなど）では、このメソッドをオーバーライドしてキャッシュを更新できます。

ターゲットでこのメソッドを呼び出す場合は、updateDisplayList() の呼び出し時に指定したインデックスにレイアウトエレメントが存在しないことのみが保証されます。例えば、仮想レイアウトを備えた DataGroup は、dataProvider プロパティにアイテムが追加されると、このメソッドを呼び出します。

デフォルトでは、このメソッドは何も実行しません。

パラメーター

関連する API エレメント

指定されたエレメントのレイアウト境界を矩形として返します。インデックスが無効の場合、対応するエレメントが null の場合、includeInLayout=false の場合、またはこのレイアウトの target プロパティが null の場合は、null を返します。

useVirtualLayout=true をサポートするレイアウトサブクラスは、このメソッドをオーバーライドして、ビューに表示されていないエレメントの概算値を計算する必要があります。

パラメーター

関連する API エレメント

scrollRect の上端にまたがっているか、その上にある最初のレイアウトエレメントの境界を返します。

これは、getVerticalScrollPositionDelta() メソッドのデフォルト実装で使用される便利なメソッドです。getVerticalScrollPositionDelta() のデフォルト実装を利用するサブクラスでは、このメソッドをオーバーライドして、有効な top プロパティと bottom プロパティを持つ境界矩形を正確に指定する必要があります。

デフォルトでは、このメソッドは、width=0、height=1（上端が scrollRect の上端より 1 だけ小さい）、および left=0 の矩形を返します。

サブクラスでは、このメソッドをオーバーライドして、有効な top プロパティと bottom プロパティを持つ境界矩形を正確に指定する必要があります。

パラメーター

関連する API エレメント

scrollRect の下端にまたがっているか、その下にある最初のレイアウトエレメントの境界を返します。

これは、getVerticalScrollPositionDelta() メソッドのデフォルト実装で使用される便利なメソッドです。getVerticalScrollPositionDelta() のデフォルト実装を利用するサブクラスでは、このメソッドをオーバーライドして、有効な top プロパティと bottom プロパティを持つ境界矩形を正確に指定する必要があります。

デフォルトでは、このメソッドは、width=0、height=1（下端が scrollRect の下端より 1 だけ大きい）、および left=0 の矩形を返します。

パラメーター

関連する API エレメント

scrollRect の左端にまたがっているか、その左にある最初のレイアウトエレメントの境界を返します。

これは、getHorizontalScrollPositionDelta() メソッドのデフォルト実装で使用される便利なメソッドです。getHorizontalScrollPositionDelta() のデフォルト実装を利用するサブクラスでは、このメソッドをオーバーライドして、有効な left プロパティと right プロパティを持つ境界矩形を正確に指定する必要があります。

デフォルトでは、このメソッドは、width=1、height=0（左端が scrollRect の左端より 1 だけ小さい）、および top=0 の矩形を返します。

パラメーター

関連する API エレメント

scrollRect の右端にまたがっているか、その右にある最初のレイアウトエレメントの境界を返します。

これは、getHorizontalScrollPositionDelta() メソッドのデフォルト実装で使用される便利なメソッドです。getHorizontalScrollPositionDelta() のデフォルト実装を利用するサブクラスでは、このメソッドをオーバーライドして、有効な left プロパティと right プロパティを持つ境界矩形を正確に指定する必要があります。

デフォルトでは、このメソッドは、width=1、height=0（右端が scrollRect の右端より 1 だけ大きい）、および top=0 の矩形を返します。

パラメーター

関連する API エレメント

異なるスクロールオプションを処理するために、水平スクロール位置に対する変更を返します。END、HOME、LEFT、PAGE_LEFT、PAGE_RIGHT、および RIGHT オプションは、NavigationUnit クラスで定義されています。

パラメーター

関連する API エレメント

フォーカスを持っている現在のアイテムと NavigationUnit に関するユーザー入力に基づいてナビゲート先のアイテムを決定する委譲メソッドです。このメソッドは、キーボードナビゲーションを処理するために ListBase のサブクラスで使用されます。ListBase は、ユーザー入力を NavigationUnit 定数にマップします。

サブクラスは、このメソッドをオーバーライドして、検出された現在のインデックスとキーストロークに基づくその他の値を計算できます。

パラメーター

指定したインデックスにあるエレメントをビュー内にスクロールするために必要な verticalScrollPosition デルタと horizontalScrollPosition デルタを計算します。

このメソッドは、verticalScrollPosition と horizontalScrollPosition に対する変更が最小限になるように計算を行います。

clipAndEnableScrolling が true であり、指定したインデックスにあるエレメントをターゲットのスクロール矩形にすべて表示できない場合は、エレメントを完全にスクロール矩形の境界内にスクロールする horizontalScrollPosition と verticalScrollPosition に追加するデルタを返します。

パラメーター

関連する API エレメント

レイアウト座標のターゲットのスクロール矩形の境界を返します。レイアウトメソッドでは、ターゲットのスクロール矩形を直接取得しないでください。

異なるスクロールオプションを処理するために、垂直スクロール位置に対する変更を返します。 DOWN、END、HOME、PAGE_DOWN、PAGE_UP、および UP オプションは、NavigationUnit クラスで定義されています。

パラメーター

関連する API エレメント

showDropIndicator() メソッドによって作成されて、以前に表示したドロップインジケーターを非表示にし、表示リストから削除して、ドラッグスクロールも停止します。

関連する API エレメント

ターゲットのデフォルトサイズをそのコンテンツに基づいて測定します。また、必要に応じて、ターゲットのデフォルト最小サイズを測定します。

これは、LayoutBase のサブクラスを作成するときにオーバーライドする必要のあるメソッドの 1 つです。これを行う必要のあるもう 1 つのメソッドは、updateDisplayList() です。これらのメソッドは、直接呼び出しません。Flex は、このメソッドをレイアウトパスの一部として呼び出します。レイアウトパスは、3 つの段階から構成されます。

最初に、ターゲットのプロパティが無効の場合、LayoutManager は、ターゲットの commitProperties メソッドを呼び出します。

2 番目に、ターゲットのサイズが無効の場合、LayoutManager は、ターゲットの validateSize() メソッドを呼び出します。ターゲットの validateSize() は、次にレイアウトの measure() を呼び出し、ターゲットのデフォルトサイズを計算します（ターゲットの explicitWidth プロパティと explicitHeight プロパティの両方で明示的に指定されなかった場合）。デフォルトサイズが変更された場合、Flex は、ターゲットの表示リストを無効にします。

最後に、ターゲットの表示リストが無効の場合、LayoutManager は、ターゲットの validateDisplayList を呼び出します。ターゲットの validateDisplayList は次に、レイアウトの updateDisplayList メソッドを呼び出し、ターゲットのエレメントのサイズと位置を設定します。

このメソッドを実装する場合は、ターゲットの measuredWidth プロパティと measuredHeight プロパティを設定し、ターゲットのデフォルトサイズを定義する必要があります。必要な場合は、measuredMinWidth プロパティと measuredMinHeight プロパティを設定して、デフォルトの最小サイズを定義することもできます。一般的な実装では、ターゲットのエレメントが繰り返し処理され、ILayoutElement で定義されたメソッドを使用して、エレメントの推奨 / 最小サイズを収集します。次に、ターゲットの measuredWidth、measuredHeight、measuredMinWidth および measuredMinHeight を設定します。

関連する API エレメント

verticalScrollPosition プロパティまたは horizontalScrollPosition プロパティの変更時に呼び出されます。

デフォルト実装では、updateScrollRect() を呼び出すことにより、ターゲットの scrollRect プロパティが更新されます。サブクラスは、このメソッドをオーバーライドして、現在の scrollPosition または scrollRect に基づく別の値を計算できます。

関連する API エレメント

指定したドロップ位置に基づいて、ドロップインジケーターのサイズ、位置、親を設定します。DropLocation オブジェクトを取得するには calculateDropLocation() メソッドを使用します。

必要条件が満たされた場合は、ドラッグスクロールを開始または停止します。

パラメーター

関連する API エレメント

ターゲットのエレメントのサイズと位置を設定します。

これは、LayoutBase のサブクラスを作成するときにオーバーライドする必要のあるメソッドの 1 つです。これを行う必要のあるもう 1 つのメソッドは、measure() です。これらのメソッドは、直接呼び出しません。Flex は、このメソッドをレイアウトパスの一部として呼び出します。レイアウトパスは、3 つの段階から構成されます。

最初に、ターゲットのプロパティが無効の場合、LayoutManager は、ターゲットの commitProperties メソッドを呼び出します。

2 番目に、ターゲットのサイズが無効の場合、LayoutManager は、ターゲットの validateSize() メソッドを呼び出します。ターゲットの validateSize() は、次にレイアウトの measure() を呼び出し、ターゲットのデフォルトサイズを計算します（ターゲットの explicitWidth プロパティと explicitHeight プロパティの両方で明示的に指定されなかった場合）。デフォルトサイズが変更された場合、Flex は、ターゲットの表示リストを無効にします。

最後に、ターゲットの表示リストが無効の場合、LayoutManager は、ターゲットの validateDisplayList を呼び出します。ターゲットの validateDisplayList は次に、レイアウトの updateDisplayList メソッドを呼び出し、ターゲットのエレメントのサイズと位置を設定します。

一般的な実装では、ターゲットのエレメントが繰り返し処理され、ILayoutElement で定義されるメソッドを使用して、エレメントの配置とサイズ変更を行います。次に、レイアウトは、ターゲットの contentWidth プロパティと contentHeight プロパティを計算および設定して、ターゲットのスクロール領域を定義する必要があります。

パラメーター

関連する API エレメント

レイアウトで scrollRect を更新するために、updateDisplayList の最後にターゲットによって呼び出されます。

clipAndEnableScrolling が true の場合、デフォルトの実装では、ターゲットの scrollRect の原点は verticalScrollPosition、horizontalScrollPosition に設定されます。サイズは、width、height パラメーター（ターゲットの伸縮されていない幅と高さ）に設定されます。

clipAndEnableScrolling が false の場合、デフォルト実装では、scrollRect が null に設定されます。

パラメーター

関連する API エレメント