org.unbland.ui.UIScrollPane

	Property	Defined by
		areaBounds : Rectangle [read-only] 各パラメータの計算結果が反映されたこの UI のエリア領域です.	UIScrollPane
		areaHeight : Number この UI のエリア領域の高さを示す数値です.	UIScrollPane
		areaWidth : Number この UI のエリア領域の幅を示す数値です.	UIScrollPane
		autoRendering : Boolean この UI のレンダリングを自動的に行うか否かです.	UIBase
		background : Sprite [read-only]	UIScrollPane
		container : Sprite [read-only]	UIScrollPane
		corner : Sprite [read-only] cornerClass を元に生成されたコーナーです.	UIScrollPane
		cornerBounds : Rectangle [read-only] 各パラメータの計算結果が反映されたコーナーのエリア領域です.	UIScrollPane
		cornerClass : Class この UI に使用するコーナーのクラスです.	UIScrollPane
		cornerMargin : Margin コーナーのマージンを設定するためのオブジェクトです.	UIScrollPane
		enabled : Boolean この UI がユーザーのマウスやキーボード操作を受け付けるか否かです.	UIScrollPane
		foreground : Sprite [read-only]	UIScrollPane
		hScrollBar : UIScrollBar [read-only] vScrollBarClass を元に生成された水平スクロールバーです.	UIScrollPane
		hScrollBarBounds : Rectangle [read-only] 各パラメータの計算結果が反映された水平方向スクロールバーのエリア領域です.	UIScrollPane
		hScrollBarClass : Class この UI に使用する水平スクロールバーのクラスです.	UIScrollPane
		hScrollBarMargin : Margin 水平スクロールバーのマージンを設定するためのオブジェクトです.	UIScrollPane
		hScrollBarVisibility : String 水平スクロールバーの表示設定です.	UIScrollPane
		maxAreaHeight : Number この UI のエリア領域の最大高を示す数値です.	UIScrollPane
		maxAreaWidth : Number この UI のエリア領域の最大幅を示す数値です.	UIScrollPane
		maxScrollX : Number [read-only] 水平方向の最大スクロール量を示す数値です.	UIScrollPane
		maxScrollY : Number [read-only] 垂直方向の最大スクロール量を示す数値です.	UIScrollPane
		minAreaHeight : Number この UI のエリア領域の最小高を示す数値です.	UIScrollPane
		minAreaWidth : Number この UI のエリア領域の最小幅を示す数値です.	UIScrollPane
		minKnobSize : Number スクロールバーのノブの最小サイズを示す数値です.	UIScrollPane
		minScrollX : Number [read-only] 水平方向の最小スクロール量を示す数値です.	UIScrollPane
		minScrollY : Number [read-only] 垂直方向の最小スクロール量を示す数値です.	UIScrollPane
		overlay : Boolean 各種スクロールバーやコーナーのエリア領域を踏まえずに viewport を計算するか否かです.	UIScrollPane
		pixelSnapped : Boolean レンダリングの時に各パーツをピクセルに吸着して配置するか否かです.	UIBase
		resizable : Boolean コーナーをドラッグしてのリサイズが可能か否かです.	UIScrollPane
		scrollX : Number 水平方向のスクロール量を示す数値です.	UIScrollPane
		scrollY : Number 垂直方向のスクロール量を示す数値です.	UIScrollPane
		viewport : Rectangle [read-only] この UI のスクロール可能な矩形領域です.	UIScrollPane
		vScrollBar : UIScrollBar [read-only] vScrollBarClass を元に生成された垂直スクロールバーです.	UIScrollPane
		vScrollBarBounds : Rectangle [read-only] 各パラメータの計算結果が反映された垂直方向スクロールバーのエリア領域です.	UIScrollPane
		vScrollBarClass : Class この UI に使用する垂直スクロールバーのクラスです.	UIScrollPane
		vScrollBarMargin : Margin 垂直スクロールバーのマージンを設定するためのオブジェクトです.	UIScrollPane
		vScrollBarVisibility : String 垂直スクロールバーの表示設定です.	UIScrollPane

	Method	Defined by
		UIScrollPane(areaWidth:Number, areaHeight:Number, vScrollBarClass:Class = null, hScrollBarClass:Class = null, cornerClass:Class = null, vScrollBarMargin:Margin = null, hScrollBarMargin:Margin = null, cornerMargin:Margin = null, pixelSnapped:Boolean = true, autoRendering:Boolean = true) UIScrollPane クラスは抽象クラスのため直接インスタンス化できません.	UIScrollPane
		bind(ui1:IUIBase, propName1:String, ui2:IUIBase, propName2:String, isTwoWay:Boolean = false):void UI のプロパティ同士が同期するように設定します.	UIBase
		dispose():void このオブジェクト内で使用されている全てのオブジェクトを開放します.	UIScrollPane
		lock():void update メソッドの呼び出しによる UI の更新処理をロックします.	UIBase
		render():void レンダリング (パーツの再配置など) を行います.	UIScrollPane
		unbind(ui1:IUIBase, propName1:String, ui2:IUIBase, propName2:String):void UI のプロパティ同士の同期を解除します.	UIBase
		unlock():void 更新処理のロックを解除し, ロック中に更新されたプロパティがある場合は更新処理を行います.	UIBase
		update():void 各プロパティの情報を元に UI のエリア領域などを更新します.	UIBase

Property detail

areaBounds

property

areaBounds:Rectangle [read-only]

各パラメータの計算結果が反映されたこの UI のエリア領域です.

Implementation
public function get areaBounds():Rectangle

areaHeight

property

areaHeight:Number [read-write]

この UI のエリア領域の高さを示す数値です. 範囲外の数値は丸め込まれます.

Implementation
public function get areaHeight():Number
public function set areaHeight(value:Number):void

areaWidth

property

areaWidth:Number [read-write]

この UI のエリア領域の幅を示す数値です. 範囲外の数値は丸め込まれます.

Implementation
public function get areaWidth():Number
public function set areaWidth(value:Number):void

background

property

background:Sprite [read-only]

Implementation
public function get background():Sprite

container

property

container:Sprite [read-only]

Implementation
public function get container():Sprite

corner

property

corner:Sprite [read-only]

cornerClass を元に生成されたコーナーです.

このオブジェクトのプロパティは UIScrollPane クラスで操作されるため, 直接プロパティを指定することは推奨されません.

Implementation
public function get corner():Sprite

cornerBounds

property

cornerBounds:Rectangle [read-only]

各パラメータの計算結果が反映されたコーナーのエリア領域です.

Implementation
public function get cornerBounds():Rectangle

cornerClass

property

cornerClass:Class [read-write]

この UI に使用するコーナーのクラスです.

指定することで resizable プロパティが true の場合, コーナーをドラッグしてのリサイズが可能になります.

指定するクラスは Sprite クラスを継承している必要があります. また, インスタンス化に引数が必要なクラスを指定することは出来ません.

Implementation
public function get cornerClass():Class
public function set cornerClass(value:Class):void

Throws

— インスタンス化に失敗した場合.

See also

resizable

cornerMargin

property

cornerMargin:Margin [read-write]

コーナーのマージンを設定するためのオブジェクトです.

Implementation
public function get cornerMargin():Margin
public function set cornerMargin(value:Margin):void

enabled

property

enabled:Boolean [read-write]

この UI がユーザーのマウスやキーボード操作を受け付けるか否かです.

Implementation
public function get enabled():Boolean
public function set enabled(value:Boolean):void

foreground

property

foreground:Sprite [read-only]

Implementation
public function get foreground():Sprite

hScrollBar

property

hScrollBar:UIScrollBar [read-only]

vScrollBarClass を元に生成された水平スクロールバーです.

このオブジェクトのプロパティは UIScrollPane クラスで操作されるため, 直接プロパティを操作することは推奨されません.

Implementation
public function get hScrollBar():UIScrollBar

hScrollBarBounds

property

hScrollBarBounds:Rectangle [read-only]

各パラメータの計算結果が反映された水平方向スクロールバーのエリア領域です.

Implementation
public function get hScrollBarBounds():Rectangle

hScrollBarClass

property

hScrollBarClass:Class [read-write]

この UI に使用する水平スクロールバーのクラスです.

指定することで水平方向のスクロールが可能になります.

指定するクラスは UIScrollBar クラスを継承しており, かつ rail や knob 用のオブジェクトが配置されている必要があります. また, インスタンス化に引数が必要なクラスを指定することは出来ません.

Implementation
public function get hScrollBarClass():Class
public function set hScrollBarClass(value:Class):void

Throws

— インスタンス化に失敗した場合.

See also

org.unbland.ui.UIScrollBar

hScrollBarMargin

property

hScrollBarMargin:Margin [read-write]

水平スクロールバーのマージンを設定するためのオブジェクトです.

Implementation
public function get hScrollBarMargin():Margin
public function set hScrollBarMargin(value:Margin):void

hScrollBarVisibility

property

hScrollBarVisibility:String [read-write]

水平スクロールバーの表示設定です. Visibility クラスによって有効な方向が定義されています.

The default value is "auto".

Implementation
public function get hScrollBarVisibility():String
public function set hScrollBarVisibility(value:String):void

See also

org.unbland.core.layout.Visibility

maxAreaHeight

property

maxAreaHeight:Number [read-write]

この UI のエリア領域の最大高を示す数値です. 最小値を下回る数値は丸め込まれます. 設定しない場合は NaN もしくは null を指定します.

The default value is NaN.

Implementation
public function get maxAreaHeight():Number
public function set maxAreaHeight(value:Number):void

See also

areaHeight
minContentHeight
areaBounds

maxAreaWidth

property

maxAreaWidth:Number [read-write]

この UI のエリア領域の最大幅を示す数値です. 最小値を下回る数値は丸め込まれます. 設定しない場合は NaN もしくは null を指定します.

The default value is NaN.

Implementation
public function get maxAreaWidth():Number
public function set maxAreaWidth(value:Number):void

See also

areaWidth
minContentWidth
areaBounds

maxScrollX

property

maxScrollX:Number [read-only]

水平方向の最大スクロール量を示す数値です.

Implementation
public function get maxScrollX():Number

See also

scrollX
minScrollX

maxScrollY

property

maxScrollY:Number [read-only]

垂直方向の最大スクロール量を示す数値です.

Implementation
public function get maxScrollY():Number

See also

scrollY
minScrollY

minAreaHeight

property

minAreaHeight:Number [read-write]

この UI のエリア領域の最小高を示す数値です. 最大値を上回る数値は丸め込まれます. 設定しない場合は NaN もしくは null を指定します.

The default value is NaN.

Implementation
public function get minAreaHeight():Number
public function set minAreaHeight(value:Number):void

See also

areaHeight
maxContentHeight
areaBounds

minAreaWidth

property

minAreaWidth:Number [read-write]

この UI のエリア領域の最小幅を示す数値です. 最大値を上回る数値は丸め込まれます. 設定しない場合は NaN もしくは null を指定します.

The default value is NaN.

Implementation
public function get minAreaWidth():Number
public function set minAreaWidth(value:Number):void

See also

areaWidth
maxContentWidth
areaBounds

minKnobSize

property

minKnobSize:Number [read-write]

スクロールバーのノブの最小サイズを示す数値です. 設定しない場合は NaN もしくは null を指定します.

The default value is NaN.

Implementation
public function get minKnobSize():Number
public function set minKnobSize(value:Number):void

minScrollX

property

minScrollX:Number [read-only]

水平方向の最小スクロール量を示す数値です.

Implementation
public function get minScrollX():Number

See also

scrollX
maxScrollX

minScrollY

property

minScrollY:Number [read-only]

垂直方向の最小スクロール量を示す数値です.

Implementation
public function get minScrollY():Number

See also

scrollY
maxScrollY

overlay

property

overlay:Boolean [read-write]

各種スクロールバーやコーナーのエリア領域を踏まえずに viewport を計算するか否かです.

このプロパティを true に設定すると areaBounds 及び viewport は同じ幅・高さを返すようになります.

The default value is false.

Implementation
public function get overlay():Boolean
public function set overlay(value:Boolean):void

See also

viewport

resizable

property

resizable:Boolean [read-write]

コーナーをドラッグしてのリサイズが可能か否かです.

cornerClass が設定されている場合のみ true に設定出来ます.

Implementation
public function get resizable():Boolean
public function set resizable(value:Boolean):void

Throws

— cornerClass が設定されていないのに true に設定しようとした場合.

See also

cornerClass

scrollX

property

scrollX:Number [read-write]

水平方向のスクロール量を示す数値です.

Implementation
public function get scrollX():Number
public function set scrollX(value:Number):void

See also

minScrollX
maxScrollX

scrollY

property

scrollY:Number [read-write]

垂直方向のスクロール量を示す数値です.

Implementation
public function get scrollY():Number
public function set scrollY(value:Number):void

See also

minScrollY
maxScrollY

viewport

property

viewport:Rectangle [read-only]

この UI のスクロール可能な矩形領域です.

overlay プロパティが false の場合, areaBounds から各スクロールバーやコーナーのエリア領域を省いた矩形領域です.

Implementation
public function get viewport():Rectangle

See also

overlay

vScrollBar

property

vScrollBar:UIScrollBar [read-only]

vScrollBarClass を元に生成された垂直スクロールバーです.

このオブジェクトのプロパティは UIScrollPane クラスで操作されるため, 直接プロパティを操作することは推奨されません.

Implementation
public function get vScrollBar():UIScrollBar

vScrollBarBounds

property

vScrollBarBounds:Rectangle [read-only]

各パラメータの計算結果が反映された垂直方向スクロールバーのエリア領域です.

Implementation
public function get vScrollBarBounds():Rectangle

vScrollBarClass

property

vScrollBarClass:Class [read-write]

この UI に使用する垂直スクロールバーのクラスです.

指定することで垂直方向のスクロールが可能になります.

Implementation
public function get vScrollBarClass():Class
public function set vScrollBarClass(value:Class):void

Throws

— インスタンス化に失敗した場合.

See also

org.unbland.ui.UIScrollBar

vScrollBarMargin

property

vScrollBarMargin:Margin [read-write]

垂直スクロールバーのマージンを設定するためのオブジェクトです.

Implementation
public function get vScrollBarMargin():Margin
public function set vScrollBarMargin(value:Margin):void

vScrollBarVisibility

property

vScrollBarVisibility:String [read-write]

垂直スクロールバーの表示設定です. Visibility クラスによって有効な方向が定義されています.

The default value is "auto".

Implementation
public function get vScrollBarVisibility():String
public function set vScrollBarVisibility(value:String):void

See also

org.unbland.core.layout.Visibility

Constructor detail

UIScrollPane

()

constructor

public function UIScrollPane(areaWidth:Number, areaHeight:Number, vScrollBarClass:Class = null, hScrollBarClass:Class = null, cornerClass:Class = null, vScrollBarMargin:Margin = null, hScrollBarMargin:Margin = null, cornerMargin:Margin = null, pixelSnapped:Boolean = true, autoRendering:Boolean = true)

UIScrollPane クラスは抽象クラスのため直接インスタンス化できません.

Parameters

	`areaWidth:Number` — この UI のエリア領域の幅を示す数値です.

	`areaHeight:Number` — この UI のエリア領域の高さを示す数値です.

	`vScrollBarClass:Class` (default = `null`) — この UI に使用する垂直スクロールバーのクラスです.

	`hScrollBarClass:Class` (default = `null`) — この UI に使用する水平スクロールバーのクラスです.

	`cornerClass:Class` (default = `null`) — この UI に使用するコーナーのクラスです.

	`vScrollBarMargin:Margin` (default = `null`) — 垂直スクロールバーのマージンを設定するためのオブジェクトです.

	`hScrollBarMargin:Margin` (default = `null`) — 垂直スクロールバーのマージンを設定するためのオブジェクトです.

	`cornerMargin:Margin` (default = `null`) — コーナーのマージンを設定するためのオブジェクトです.

	`pixelSnapped:Boolean` (default = `true`) — 自動レンダリングの時に各パーツをピクセルに吸着して配置するか否かです.

	`autoRendering:Boolean` (default = `true`) — この UI のレンダリングを自動的に行うか否かです.

Method detail

dispose

()

method

public override function dispose():void

このオブジェクト内で使用されている全てのオブジェクトを開放します.

render

()

method

public override function render():void

レンダリング (パーツの再配置など) を行います.

本来はこのメソッドを明示的に呼び出す必要はありませんが, プロパティを操作しても表示がおかしい場合は明示的に呼び出します.

プロパティを操作しても表示がおかしいのは以下のような場合です.

FlashPlayer 実行直後 (Event.RENDER の配信処理が行われない).

unbland as3 library API reference	All Packages \| All Classes \| Index \| Frames No Frames
Class UIScrollPane	Properties \| Methods

Package	org.unbland.ui
Class	public class UIScrollPane
Inheritance	UIScrollPane UIBase flash.display.Sprite