| Package | org.unbland.ui.controllers |
| Class | public class UIScrollController |
| Inheritance | UIScrollController UINumericController UIController flash.events.EventDispatcher |
コントロール対象となるオブジェクトは以下の通りです.
| Property | Defined by | ||
|---|---|---|---|
![]() | autoRendering : Boolean
この UI のレンダリングを自動的に行うか否かです.
| UIController | |
| direction : String
この UI が示す数値が増加する方向です.
| UIScrollController | ||
| ease : Ease
イージングを制御するオブジェクトです.
| UIScrollController | ||
![]() | enabled : Boolean
この UI がユーザーのマウスやキーボード操作を受け付けるか否かです.
| UIController | |
![]() | governed : Boolean
この UI が示す数値を最小値と最大値の範囲内に丸め込むか否かです.
| UINumericController | |
| isScrolling : Boolean [read-only]
この UI が現在スクロール中か否かです.
| UIScrollController | ||
| knobBounds : Rectangle [read-only]
各パラメータの計算結果が反映されたつまみのエリア領域です.
| UIScrollController | ||
| knobIncluded : Boolean
つまみの幅・高さのサイズを含めて計算を行うか否かです.
| UIScrollController | ||
![]() | length : Number
最小値から最大値までの長さです.
| UINumericController | |
![]() | max : Number
この UI が示す数値の最大値です.
| UINumericController | |
![]() | min : Number
この UI が示す数値の最小値です.
| UINumericController | |
![]() | percentage : Number
最小値から最大値までの長さに対する数値の百分率です.
| UINumericController | |
![]() | pixelSnapped : Boolean
レンダリングの時に各パーツをピクセルに吸着して配置するか否かです.
| UIController | |
| railBounds : Rectangle [read-only]
各パラメータの計算結果が反映されたレールのエリア領域です.
| UIScrollController | ||
| railEnabled : Boolean
レールに対してマウスが有効か否かです.
| UIScrollController | ||
![]() | ratio : Number
最小値から最大値までの長さに対する数値の比率です.
| UINumericController | |
| scrollEnabled : Boolean [read-only]
この UI が今現在スクロールが可能か否かです.
| UIScrollController | ||
| sync : Boolean
この UI が示す数値とつまみの位置を同期するか否かです.
| UIScrollController | ||
| value : Number
この UI が示す数値です.
| UIScrollController | ||
| Method | Defined by | ||
|---|---|---|---|
|
UIScrollController(view:DisplayObjectContainer, direction:String = "up", value:Number = 0.0, min:Number = 0.0, max:Number = 0.0, pixelSnapped:Boolean = true, autoRendering:Boolean = true)
新しい UIScrollController インスタンスを作成します.
| UIScrollController | ||
![]() |
UI のプロパティ同士が同期するように設定します.
| UIController | |
|
dispose():void
このオブジェクト内で使用されている全てのオブジェクトを開放します.
| UIScrollController | ||
![]() |
lock():void
update メソッドの呼び出しによる UI の更新処理をロックします.
| UIController | |
|
render():void
レンダリング (パーツの再配置など) を行います.
| UIScrollController | ||
|
scroll(value:Number):void
イージングが設定されている場合は対象の値までイージングを行います.
| UIScrollController | ||
![]() |
UI のプロパティ同士の同期を解除します.
| UIController | |
![]() |
unlock():void
更新処理のロックを解除し, ロック中に更新されたプロパティがある場合は更新処理を行います.
| UIController | |
![]() |
update():void
各プロパティの情報を元に UI のエリア領域などを更新します.
| UIController | |
| Method | Defined by | ||
|---|---|---|---|
|
_updateBoundsFromView():void
つまみとレールの矩形情報をビューレイアウトのサイズを元に更新します.
| UIScrollController | ||
| direction | property |
direction:String [read-write]この UI が示す数値が増加する方向です. Direction クラスによって有効な方向が定義されています.
The default value is "up".
public function get direction():String
public function set direction(value:String):void
— 無効な方向を指定した場合.
|
See also
| ease | property |
ease:Ease [read-write]イージングを制御するオブジェクトです. Ease クラスによって使用できるイージングオブジェクトが提供されています. null を指定することによりイージングを解除できます.
The default value is null.
public function get ease():Ease
public function set ease(value:Ease):void
See also
| isScrolling | property |
isScrolling:Boolean [read-only]この UI が現在スクロール中か否かです.
The default value is false;.
public function get isScrolling():Boolean
| knobBounds | property |
knobBounds:Rectangle [read-only]各パラメータの計算結果が反映されたつまみのエリア領域です.
Implementation public function get knobBounds():Rectangle
| knobIncluded | property |
knobIncluded:Boolean [read-write]つまみの幅・高さのサイズを含めて計算を行うか否かです.
The default value is true.
public function get knobIncluded():Boolean
public function set knobIncluded(value:Boolean):void
| railBounds | property |
railBounds:Rectangle [read-only]各パラメータの計算結果が反映されたレールのエリア領域です.
Implementation public function get railBounds():Rectangle
| railEnabled | property |
railEnabled:Boolean [read-write]レールに対してマウスが有効か否かです.
The default value is true.
public function get railEnabled():Boolean
public function set railEnabled(value:Boolean):void
| scrollEnabled | property |
scrollEnabled:Boolean [read-only]この UI が今現在スクロールが可能か否かです.
governed プロパティが true の時に, value, min, max 各プロパティが同値の場合は false になります.
The default value is true.
public function get scrollEnabled():Boolean
| sync | property |
sync:Boolean [read-write]この UI が示す数値とつまみの位置を同期するか否かです. ease プロパティが設定されている場合に true に設定すると, つまみにもイージングが掛かります.
The default value is false.
public function get sync():Boolean
public function set sync(value:Boolean):void
See also
| value | property |
value:Number [read-write]この UI が示す数値です. governed プロパティが true に設定されている場合は, 自動的に最小値と最大値の範囲内に丸め込まれます.
The default value is 0.0.
public function get value():Number
public function set value(value:Number):void
| UIScrollController | () | constructor |
public function UIScrollController(view:DisplayObjectContainer, direction:String = "up", value:Number = 0.0, min:Number = 0.0, max:Number = 0.0, pixelSnapped:Boolean = true, autoRendering:Boolean = true)新しい UIScrollController インスタンスを作成します.
Parametersview:DisplayObjectContainer — この UI に使用するビューです.
|
|
direction:String (default = "up") — この UI が示す数値が増加する方向です.
|
|
value:Number (default = 0.0) — この UI が示す数値です.
|
|
min:Number (default = 0.0) — この UI が示す数値の最小値です.
|
|
max:Number (default = 0.0) — この UI が示す数値の最大値です.
|
|
pixelSnapped:Boolean (default = true) — 自動レンダリングの時に各パーツをピクセルに吸着して配置するか否かです.
|
|
autoRendering:Boolean (default = true) — この UI のレンダリングを自動的に行うか否かです.
|
— ビューにつまみ (knob) もしくはレール (rail) が配置されていない場合.
|
| _updateBoundsFromView | () | method |
protected function _updateBoundsFromView():voidつまみとレールの矩形情報をビューレイアウトのサイズを元に更新します.
| dispose | () | method |
public override function dispose():voidこのオブジェクト内で使用されている全てのオブジェクトを開放します.
| render | () | method |
public override function render():voidレンダリング (パーツの再配置など) を行います.
本来はこのメソッドを明示的に呼び出す必要はありませんが, プロパティを操作しても表示がおかしい場合は明示的に呼び出します.
プロパティを操作しても表示がおかしいのは以下のような場合です.
| scroll | () | method |
public function scroll(value:Number):voidイージングが設定されている場合は対象の値までイージングを行います.
Parametersvalue:Number |