| パッケージ | spark.core |
| インターフェイス | public interface IViewport extends IVisualElement , ILayoutElement , ILayoutDirectionElement , IEventDispatcher |
| 実装者 | GroupBase, RichEditableText |
| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
ビューポートは、そのままではアプリケーションユーザーによって移動できません。ただし、ビューポートとスクロールバーを組み合わせて、ユーザーがビューポートをスクロールしてコンポーネントのコンテンツ全体を表示できるようにすることができます。コンポーネントにスクロールバーを追加するには、Scroller コンポーネントを使用します。
関連する API エレメント
パブリックプロパティ
継承されるパブリックプロパティを隠す
継承されるパブリックプロパティを表示| プロパティ | 定義元 | ||
|---|---|---|---|
 | alpha : Number
指定されたオブジェクトのアルファ透明度値を示します。 | IVisualElement | |
| baseline : Object
アンカーターゲットからコントロールのベースライン位置までの垂直距離（ピクセル単位）です。 | ILayoutElement | |
| baselinePosition : Number [読み取り専用]
コンポーネントのテキストにおける 1 行目のベースラインの y 座標です。 | ILayoutElement | |
| bottom : Object
コンポーネントの下端からアンカーターゲットの下端までの垂直距離（ピクセル単位）です。 | ILayoutElement | |
| clipAndEnableScrolling : Boolean
true の場合、ビューポートの境界に子をクリッピングするように指定します。 | IViewport | ||
| contentHeight : Number [読み取り専用]
ビューポートのコンテンツの高さです。 | IViewport | ||
| contentWidth : Number [読み取り専用]
ビューポートのコンテンツの幅です。 | IViewport | ||
| depth : Number
コンテナ内のアイテムのレンダリング順序を決定します。 | IVisualElement | |
| designLayer : DesignLayer
このビジュアルエレメントに関連付けるオプションの DesignLayer インスタンスを指定します。 | IVisualElement | |
| hasLayoutMatrix3D : Boolean [読み取り専用]
エレメントが 3D マトリックスを持つ場合は true です。 | ILayoutElement | |
| height : Number
表示オブジェクトの高さを示します（ピクセル単位）。 | IVisualElement | |
| horizontalCenter : Object
コンポーネントの中心からアンカーターゲットのコンテンツ領域の中心までの水平距離（ピクセル単位）です。 | ILayoutElement | |
| horizontalScrollPosition : Number
コンポーネントの座標系における、ビューポートの原点の x 座標です。デフォルト値は (0,0) であり、これはコンポーネントの左上隅に対応します。 | IViewport | ||
| includeInLayout : Boolean
このコンポーネントを親コンテナのレイアウトに含めるかどうかを指定します。 | ILayoutElement | |
| is3D : Boolean [読み取り専用]
エレメントが 3D の場合は true です。 | IVisualElement | |
| layoutDirection : String
エレメントの任意のレイアウト方向を指定します。LayoutDirection.LTR（左から右）、LayoutDirection.RTL（右から左）または null（継承する）のいずれかを指定します。 | ILayoutDirectionElement | |
| left : Object
コンポーネントの左端からアンカーターゲットの左端までの水平距離（ピクセル単位）です。 | ILayoutElement | |
| owner : DisplayObjectContainer
この IVisualElement オブジェクトのオーナーです。 | IVisualElement | |
| parent : DisplayObjectContainer [読み取り専用]
このコンポーネントの親コンテナまたは親コンポーネントです。 | IVisualElement | |
| percentHeight : Number
コンポーネントの高さを親のサイズに対する比率（パーセンテージ）で指定します。 | ILayoutElement | |
| percentWidth : Number
コンポーネントの幅を親のサイズに対する比率（パーセンテージ）で指定します。 | ILayoutElement | |
| postLayoutTransformOffsets : mx.geom:TransformOffsets
親のレイアウトに影響を与えない方法で、オブジェクトの変換に適用できる一連の調整を定義します。 | IVisualElement | |
| right : Object
コンポーネントの右端からアンカーターゲットの右端までの水平距離（ピクセル単位）です。 | ILayoutElement | |
| top : Object
コンポーネントの上端からアンカーターゲットの上端までの垂直距離（ピクセル単位）です。 | ILayoutElement | |
| verticalCenter : Object
コンポーネントの中心からアンカーターゲットのコンテンツ領域の中心までの垂直距離（ピクセル単位）です。 | ILayoutElement | |
| verticalScrollPosition : Number
コンポーネントの座標系における、ビューポートの原点の y 座標です。デフォルト値は (0,0) であり、これはコンポーネントの左上隅に対応します。 | IViewport | ||
| visible : Boolean
このビジュアルエレメントの可視性を制御します。 | IVisualElement | |
| width : Number
表示オブジェクトの幅を示します（ピクセル単位）。 | IVisualElement | |
| x : Number
親 DisplayObjectContainer のローカル座標を基準にした DisplayObject インスタンスの x 座標を示します。 | IVisualElement | |
| y : Number
親 DisplayObjectContainer のローカル座標を基準にした DisplayObject インスタンスの y 座標を示します。 | IVisualElement | |
パブリックメソッド
| メソッド | 定義元 | ||
|---|---|---|---|
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。 | IEventDispatcher | |
|
イベントをイベントフローに送出します。 | IEventDispatcher | |
|
エレメントの境界の x 座標を、指定したエレメントサイズで返します。 | ILayoutElement | |
|
エレメントの境界の y 座標を、指定したエレメントサイズで返します。 | ILayoutElement | |
要求されたスクロール単位でスクロールする、ビューポートの現在の horizontalScrollPosition に追加する量を返します。 | IViewport | ||
|
エレメントのレイアウトの高さを返します。 | ILayoutElement | |
|
エレメントのレイアウトの幅を返します。 | ILayoutElement | |
|
画面に描画するためにエレメントで使用する x 座標を返します。 | ILayoutElement | |
|
画面に描画するためにエレメントで使用する y 座標を返します。 | ILayoutElement | |
|
兄弟を基準としてコンポーネントのレイアウトを計算するために使用される変換マトリックスを返します。 | ILayoutElement | |
|
このエレメントのレイアウト変換 Matrix3D を返します。 | ILayoutElement | |
|
エレメントの最大の高さを返します。 | ILayoutElement | |
|
エレメントの最大の幅を返します。 | ILayoutElement | |
|
エレメントの最小の高さを返します。 | ILayoutElement | |
|
エレメントの最小の幅を返します。 | ILayoutElement | |
|
エレメントの推奨高さを返します。 | ILayoutElement | |
|
エレメントの推奨幅を返します。 | ILayoutElement | |
要求されたスクロール単位でスクロールする、ビューポートの現在の verticalScrollPosition に追加する量を返します。 | IViewport | ||
|
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 | IEventDispatcher | |
|
エレメントの layoutDirection を変更する場合、または親エレメントの layoutDirection を変更する場合は、エレメントでこのメソッドを呼び出す必要があります。 | ILayoutDirectionElement | |
|
EventDispatcher オブジェクトからリスナーを削除します。 | IEventDispatcher | |
|
画面に描画するためにエレメントで使用する座標を設定します。 | ILayoutElement | |
|
エレメントのレイアウトサイズを設定します。 | ILayoutElement | |
|
兄弟を基準としてコンポーネントのレイアウトサイズおよび位置を計算するために使用される変換 Matrix を設定します。 | ILayoutElement | |
|
兄弟を基準としてコンポーネントのレイアウトサイズおよび位置を計算するために使用される変換 Matrix3D を設定します。 | ILayoutElement | |
| transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
コンポーネントの独自の座標空間内で指定され、親の座標空間内に固定される、特定のポイントを保持して変換の回転、拡大 / 縮小および平行移動を更新するためのユーティリティメソッドです。 | ILayoutElement | |
|
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 | IEventDispatcher | |
プロパティの詳細
clipAndEnableScrolling | プロパティ |
clipAndEnableScrolling:Boolean| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
true の場合、ビューポートの境界に子をクリッピングするように指定します。false の場合、コンポーネントのサイズ指定に関係なく、コンテナの子がコンテナの境界を越えて拡張されます。
デフォルト値： false。
実装
public function get clipAndEnableScrolling():Boolean public function set clipAndEnableScrolling(value:Boolean):void関連する API エレメント
contentHeight | プロパティ |
contentHeight:Number [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
ビューポートのコンテンツの高さです。clipAndEnabledScrolling が true の場合、ビューポートの contentHeight は垂直方向のスクロールの限界を定義し、ビューポートの実際の高さは表示できるコンテンツの量を定義します。コンテンツを縦にスクロールするには、verticalScrollPosition を 0 ～ contentHeight - height の範囲で変化させます。
このプロパティの実装は Bindable である必要があり、propertyChange タイプのイベントを生成する必要があります。
実装
public function get contentHeight():NumbercontentWidth | プロパティ |
contentWidth:Number [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
ビューポートのコンテンツの幅です。clipAndEnabledScrolling が true の場合、ビューポートの contentWidth は水平方向のスクロールの限界を定義し、ビューポートの実際の幅は表示できるコンテンツの量を定義します。コンテンツを横にスクロールするには、horizontalScrollPosition を 0 ～ contentWidth - width の範囲で変化させます。
このプロパティの実装は Bindable である必要があり、propertyChange タイプのイベントを生成する必要があります。
実装
public function get contentWidth():NumberhorizontalScrollPosition | プロパティ |
horizontalScrollPosition:Number| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
コンポーネントの座標系における、ビューポートの原点の x 座標です。デフォルト値は (0,0) であり、これはコンポーネントの左上隅に対応します。clipAndEnableScrolling が true である場合、通常、このプロパティを設定するとビューポートが次の値に設定されます。
new Rectangle(horizontalScrollPosition, verticalScrollPosition, width, height)
このプロパティの実装は Bindable である必要があり、propertyChange タイプのイベントを生成する必要があります。
デフォルト値： 0。
実装
public function get horizontalScrollPosition():Number public function set horizontalScrollPosition(value:Number):void関連する API エレメント
verticalScrollPosition | プロパティ |
verticalScrollPosition:Number| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
コンポーネントの座標系における、ビューポートの原点の y 座標です。デフォルト値は (0,0) であり、これはコンポーネントの左上隅に対応します。clipAndEnableScrolling が true である場合、通常、このプロパティを設定するとビューポートが次の値に設定されます。
new Rectangle(horizontalScrollPosition, verticalScrollPosition, width, height)
このプロパティの実装は Bindable である必要があり、propertyChange タイプのイベントを生成する必要があります。
デフォルト値： 0。
実装
public function get verticalScrollPosition():Number public function set verticalScrollPosition(value:Number):void関連する API エレメント
メソッドの詳細
getHorizontalScrollPositionDelta | () | メソッド |
public function getHorizontalScrollPositionDelta(navigationUnit:uint):Number| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
要求されたスクロール単位でスクロールする、ビューポートの現在の horizontalScrollPosition に追加する量を返します。
パラメーター
navigationUnit:uint — スクロールする量です。この値は次のいずれかの spark.core.NavigationUnit 定数にする必要があります。
LEFT または RIGHT を使用します。最初または最後の列にスクロールするには、HOME または END を使用します。
|
Number — horizontalScrollPosition に追加するピクセル数です。
|
関連する API エレメント
getVerticalScrollPositionDelta | () | メソッド |
public function getVerticalScrollPositionDelta(navigationUnit:uint):Number| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
要求されたスクロール単位でスクロールする、ビューポートの現在の verticalScrollPosition に追加する量を返します。
パラメーター
navigationUnit:uint — スクロールする量です。unit の値は次のいずれかの spark.core.NavigationUnit 定数にする必要があります。
UP または DOWN を使用します。最初または最後の行にスクロールするには、HOME または END を使用します。
|
Number — verticalScrollPosition に追加するピクセル数です。
|
関連する API エレメント
例 この例の使用方法
IViewportExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate Spark IViewport interface -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:mx="library://ns.adobe.com/flex/mx"
xmlns:s="library://ns.adobe.com/flex/spark" >
<s:layout>
<s:HorizontalLayout/>
</s:layout>
<s:Panel title="IViewport Component Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<s:Label text="The Group container implements IViewport. Therefore, you can clip its contents and use it with scrollbars."
color="blue"
top="10"/>
<s:Group id="myGroup" width="100" height="100"
clipAndEnableScrolling="true"
horizontalScrollPosition="50" verticalScrollPosition="50"
left="100" top="40">
<mx:Image width="300" height="400"
source="@Embed(source='/assets/logo.jpg')"/>
</s:Group>
<s:VScrollBar viewport="{myGroup}" height="100" left="210" top="40"/>
<s:HScrollBar viewport="{myGroup}" width="100" left="100" top="150"/>
</s:Panel>
</s:Application>
Tue Jun 12 2018, 10:34 AM Z