ASDoc

mx.core
ScrollView クラス

直接の既知のサブクラス
mx.controls.TextArea, mx.controls.listclasses.ItemScrollSelectList, mx.controls.listclasses.ScrollSelectList

ScrollView クラス
mx.core.View の拡張

ScrollView クラスは、スクロールバーおよびマスクを含むコントロールの基本クラスです。スクロールバーはユーザーが操作し、表示可能領域を変更するメソッドおよびプロパティには開発者がアクセスします。複数の子を持つことが可能な View コンテナとは異なり、ScrollView が持つ子オブジェクトは 1 つのみで、そのオブジェクトを配置およびマスクして、表示可能なコンテンツを表示します。スクロールする項目は、このコンテンツオブジェクトの子であることが必要です。このコンテンツオブジェクトは UIObject から派生しているか、少なくとも setSize() メソッドと move() メソッドをサポートしている必要があります。

MXML シンタックス

ScrollView クラスには次のプロパティがあります。

 <mx:tagname
   hPosition="0"
   hScrollPolicy="off|on|auto"
   liveScrolling="false|true"
   maxHPosition="No default.
   maxVPosition="No default.
   scrollTipFunction="No default.
   showScrollTips="false|true"
   vPosition="0"
   vScrollPolicy="auto|off|on"
 />

メソッド
	`childLoaded( obj:MovieClip) : Void`ScrollView のバージョンの `childLoaded()` メソッドはマスクも作成します。
	`createChildren( ) : Void`この ScrollView の子であるオブジェクトを作成します。ここでは境界線とマスクです。
	`createChildWithStyles( classOrSymbol, name:String, props:Object, inheritingStyleSheet:mx.styles.CSSStyleSheet, nonInheritingStyleSheet:mx.styles.CSSStyleSheet) : MovieClip`コンテンツオブジェクトを作成します。
	`getViewMetrics( ) : Object`スクロールバーを考慮する ViewMetrics を返します (可視の場合)。
	`init( ) : Void`変数を初期化し、MouseWheel のサポートを確立します。
	`layoutChildren( ) : Void`スクロールバーとコンテンツの位置とサイズを設定し、マスクを調整します。
	`setScrollProperties( colCount:Number, colWidth:Number, rwCount:Number, rwHeight:Number, hPadding:Number, wPadding:Number) : Void`必要に応じてスクロールバーが設定されるように、コンテンツの形状に関する情報を ScrollView に提供します。

mx.core.View クラスから継承されるメソッド

childLoaded   constructObject2   createChild   createChildren   destroyAllChildren   destroyChild   destroyChildAt   draw   getBorderMetrics   getChildAt   getChildIndex   getViewMetrics   init   layoutChildren   layoutChrome   setChildIndex

mx.core.UIComponent クラスから継承されるメソッド

drawFocus getFocus getFocusManager setEnabled setFocus

プロパティ
	`className:String`このクラスの名前です。
	`hPosition:Number`ScrollView コントロールの左上隅に表示されるコンテンツの左端のピクセルです。
	`hScrollPolicy:String`水平スクロールバーを常にオンにするか、常にオフにするか、または `setScrollProperties()` メソッドに渡されるパラメータに基づいて自動的に変更するかを示します。
	`liveScrolling:Boolean`サムの移動に合わせてスクロールするか、サムが離されるまで表示を更新しないかを指定します。
	`maxHPosition:NumberhPosition` の最大値です。
	`maxVPosition:Number [読み取り専用]vPosition` の最大値です。
	`scrollTipFunction:Function`この関数は、`showScrollTips` プロパティが `true` に設定されている場合に、スクロールサムがドラッグされ、ScrollTip として使用するストリングを返す必要がある場合に呼び出します。
	`showScrollTips:Boolean`スクロールサムをドラッグしたときに、その近くにツールヒントを表示するかどうかを指定します。
`static`	`version:String`このクラスのバージョンを表すストリングです。
	`vPosition:Number`ScrollView コントロールの左上隅に表示されるコンテンツの上端のピクセルです。
	`vScrollPolicy:String`水平スクロールバーを常にオンにするか、常にオフにするか、または `setScrollProperties()` メソッドに渡されるパラメータに基づいて自動的に変更するかを示します。

mx.core.View クラスから継承されるプロパティ

baselinePosition className numChildren version

mx.core.UIComponent クラスから継承されるプロパティ

enabled errorString tabEnabled tabIndex version

エフェクト

mx.core.UIObject クラスから継承されるエフェクト

focusInEffect focusOutEffect

mx.core.UIObject クラスから継承されるエフェクト

creationCompleteEffect   hideEffect   mouseDownEffect   mouseOutEffect   mouseOverEffect   mouseUpEffect   moveEffect   resizeEffect   showEffect

イベント

scroll コンテンツがスクロールされたときにブロードキャストします。このイベントオブジェクトには、次のプロパティが含まれます。
- direction vertical または horizontal です。
- position 元の位置を表します。
- delta 位置の変化を表します。
- target イベントをトリガしたコンポーネントへの参照です。
- type scroll イベントの名前です。

mx.core.View クラスから継承されるイベント

childCreated childDestroyed childIndexChanged

mx.core.UIComponent クラスから継承されるイベント

focusIn focusOut invalid keyDown keyUp valid valueCommitted

mx.core.UIObject クラスから継承されるイベント

creationComplete  dragComplete  dragDrop  dragEnter  dragExit  dragOver  draw  effectEnd  effectStart  hide  hideToolTip  initialize  load  mouseChangeSomewhere  mouseDown  mouseDownSomewhere  mouseMove  mouseMoveSomewhere  mouseOut  mouseOver  mouseUp  mouseUpSomewhere  move  resize  show  showToolTip  unload

スタイル

mx.core.UIObject クラスから継承されるスタイル

color   fontFamily   fontSize   fontStyle   fontWeight   horizontalGap   leading   marginLeft   marginRight   textAlign   textDecoration   textIndent   verticalGap

メソッドの詳細

childLoaded

childLoaded( obj:MovieClip)
										
													 :  Void

ScrollView のバージョンの childLoaded() メソッドはマスクも作成します。

パラメータ
obj:MovieClip - ロードされる子です。

関連項目
View

createChildren

createChildren( )
										
													 :  Void

この ScrollView の子であるオブジェクトを作成します。ここでは境界線とマスクです。このメソッドは、ScrollView が最初に作成されたときに呼び出されます。サブクラスがこのメソッドをオーバーライドする場合は、ScrollView.createChildren() メソッドのロジックが実行されるように、サブクラスが super.createChildren() メソッドを呼び出す必要があります。

createChildWithStyles

createChildWithStyles( classOrSymbol, name:String, props:Object, inheritingStyleSheet:mx.styles.CSSStyleSheet, nonInheritingStyleSheet:mx.styles.CSSStyleSheet)
										
													 :  MovieClip

コンテンツオブジェクトを作成します。

メモ : View.createChild() メソッドとは異なり、ScrollView クラスが持つことができる子は 1 つのみです。createChild() を続けて呼び出すと、古い子が削除されて新しい子に置き換えられます。

パラメータ
    classOrSymbol - クラスへの参照、シンボルのリンケージ識別子、または外部コンテンツのファイルパスまたは URL です。クラス名は二重引用符で囲まずに指定します。コンポーネントはストリングとして指定しないでください。
    name:String - 子のインスタンス名です。
    props:Object - 初期化プロパティを含むオブジェクトです。
    inheritingStyleSheet:mx.styles.CSSStyleSheet - 初期化する継承スタイルを含む CSSStyleSheet です。
    nonInheritingStyleSheet:mx.styles.CSSStyleSheet - 初期化する非継承スタイルを含む CSSStyleSheet です。

関連項目
View

getViewMetrics

getViewMetrics( )
										
													 :  Object

スクロールバーを考慮する ViewMetrics を返します (可視の場合)。

戻り値
左端、右端、上端、および下端の太さがピクセル数で指定されたオブジェクトです。

関連項目
View

init

init( )
										
													 :  Void

変数を初期化し、MouseWheel のサポートを確立します。このメソッドは、オブジェクトが最初に作成されたときに呼び出されます。サブクラスがこのメソッドをオーバーライドする場合は、ScrollView.init のロジックが実行されるように、サブクラスが super.init() メソッドを呼び出す必要があります。

layoutChildren

layoutChildren( )
										
													 :  Void

スクロールバーとコンテンツの位置とサイズを設定し、マスクを調整します。

関連項目
View

setScrollProperties

setScrollProperties( colCount:Number, colWidth:Number, rwCount:Number, rwHeight:Number, hPadding:Number, wPadding:Number)
										
													 :  Void

必要に応じてスクロールバーが設定されるように、コンテンツの形状に関する情報を ScrollView に提供します。このメソッドでは、コンテンツのどの部分を可視にするかは変更されません。

一般的な使用方法には、次の 3 つがあります。List コントロールや DataGrid コントロールなどのように、コンテンツが行と列のセットから成り、すべての列が同じ幅ですべての行が同じ高さである場合、パラメータを次のように設定します。

colCount = 表示される可能性がある列の総数
colWidth = 列のピクセル幅
rwCount = 行の総数
rwHeight = 行のピクセル高さ

コンテンツの行がすべて同じ高さで、列の幅が異なる場合は、次のように設定します。

colCount = すべての列の幅の合計
colWidth = 1
rwCount = 行の総数
rwHeight = 行のピクセル高さ

コンテンツが、"物理的な" サイズに基づいて厳密にスクロールされる swf や jpg などである場合は、次のように設定します。

colCount = コンテンツの幅
colWidth = 1
rwCount = コンテンツの高さ
rwHeight = 1

快適なスクロールを可能にするため、rowHeight または columnWidth を 1 に設定した場合は、矢印ボタンがクリックされるたびに 1 ピクセル以上のスクロールが行われるように、hScroller や vScroller の lineScrollSize を設定する必要があります。
padding パラメータはオプションです。このパラメータを使用すると、ScrollView に一方向または両方向にスクロール不可能な領域を含めることができます。
たとえば DataGrid コンテナの列ヘッダや行ヘッダは、一方向にのみスクロールし、scrollBars の位置計算に含めることができません。

パラメータ
    colCount:Number - 水平方向にスクロールする単位数です。
    colWidth:Number - 単位ごとの幅 (ピクセル数) です。
    rwCount:Number - 垂直方向にスクロールする単位数です。
    rwHeight:Number - 単位ごとの高さ (ピクセル数) です。
    hPadding:Number - スクロールされない左端のピクセル数 (行ヘッダ用) です。
    wPadding:Number - スクロールされない上端のピクセル数 (列ヘッダ用) です。

プロパティの詳細

className

className:String

このクラスの名前です。

hPosition

hPosition:Number

ScrollView コントロールの左上隅に表示されるコンテンツの左端のピクセルです。デフォルト値は 0 です。

hScrollPolicy

hScrollPolicy:String

水平スクロールバーを常にオンにするか、常にオフにするか、または setScrollProperties() メソッドに渡されるパラメータに基づいて自動的に変更するかを示します。有効な値は、on、off、および auto です。デフォルト値は off です。

liveScrolling

liveScrolling:Boolean

サムの移動に合わせてスクロールするか、サムが離されるまで表示を更新しないかを指定します。デフォルト値は true です。

maxHPosition

maxHPosition:Number

hPosition の最大値です。maxHPosition はコンテンツの幅から表示可能な領域の幅を引いたものです。したがってこれはコンテンツの幅ではありません。

maxVPosition

maxVPosition:Number [読み取り専用]

vPosition の最大値です。maxVPosition はコンテンツの高さから表示可能な領域の高さを引いたものです。したがってこれはコンテンツの高さではありません。

scrollTipFunction

scrollTipFunction:Function

この関数は、showScrollTips プロパティが true に設定されている場合に、スクロールサムがドラッグされ、ScrollTip として使用するストリングを返す必要がある場合に呼び出します。この関数には 2 つのパラメータが渡されます。1 つ目のパラメータは、スクロールバーの方向です。2 つ目はその scrollPosition です。次に例を示します。

function scrollTipFunction(direction:String, position:Number) :String
       {
         if (direction == "vertical") return myToolTips[position];
         else return "";
       }

showScrollTips

showScrollTips:Boolean

スクロールサムをドラッグしたときに、その近くにツールヒントを表示するかどうかを指定します。デフォルト値は false です。

version

static version:String

このクラスのバージョンを表すストリングです。

vPosition

vPosition:Number

ScrollView コントロールの左上隅に表示されるコンテンツの上端のピクセルです。デフォルト値は 0 です。

vScrollPolicy

vScrollPolicy:String

水平スクロールバーを常にオンにするか、常にオフにするか、または setScrollProperties() メソッドに渡されるパラメータに基づいて自動的に変更するかを示します。有効な値は、on、off、および auto です。デフォルト値は auto です。

mx.core ScrollView クラス

childLoaded

createChildren

createChildWithStyles

getViewMetrics

init

layoutChildren

setScrollProperties

className

hPosition

hScrollPolicy

liveScrolling

maxHPosition

maxVPosition

scrollTipFunction

showScrollTips

version

vPosition

vScrollPolicy

mx.core
ScrollView クラス