| Package | jp.naggg.controls |
| Class | public dynamic class ScrollBar |
| Inheritance | ScrollBar  flash.display.Sprite |
| Property | Defined By | ||
|---|---|---|---|
| down_mc : Sprite | ScrollBar | ||
| enabled : Boolean
コンポーネントの有効・無効を設定します．
マウス操作全般の有効・無効と同期していますが、value の値の更新は、
たとえ無効であっても反映させることができます．
また、この値を変更することで見栄えは変更しないので、コントローラー側で制御する必要があります．
また、必要のないときは、enabled を false にすることで処理を軽くすることができます．
| ScrollBar | ||
| fixThumbSize : Boolean サムの大きさを変化させるかどうかのフラグ、デフォルトは false でサムの大きさは変化します． | ScrollBar | ||
| mouseWheelFriction : Number = 0.2
マウスホイール時の摩擦
| ScrollBar | ||
| mouseWheelLevel : int = 3
マウスホイールをどこまで監視するかのレベル設定．
デフォルトでは、ScrollBar インスタンスと scrollee の２つを監視します．
| ScrollBar | ||
| scrollable : Boolean [read-only]
スクロールが可能かどうかを返します．
スクロール対象がマスクの大きさよりも小さくスクロールの必要がない場合hあ
false を返します．
| ScrollBar | ||
| scrollee : DisplayObject [read-only]
設定されているスクロール対象です．設定は setScrollee() を使います．
| ScrollBar | ||
| thumb_mc : Sprite | ScrollBar | ||
| track_mc : Sprite | ScrollBar | ||
| up_mc : Sprite | ScrollBar | ||
| value : Number
スクロールバーの値です．
0 ～ 1 までの値で読み書きします．範囲外の数値を代入した場合、自動で丸め込みます．
あくまでも割合を返すのでそこから先はコントローラー側で制御します．
| ScrollBar | ||
| Method | Defined By | ||
|---|---|---|---|
コンストラクタ．
| ScrollBar | ||
hideControls():void
すべてのUIを使用不能状態にします．
イベントを投げるので見ための変更はイベントハンドラで行います．
| ScrollBar | ||
init(scrollee:DisplayObject = null, mask:DisplayObject = null, initValue:Number = 0, scrolleeWidth:Number, scrolleeHeight:Number):void
初期化を行います．このメソッドは必ず呼ぶようにしてください．
| ScrollBar | ||
reset():void
設定した内容をリセットします．
リセットを行うものの、scrollee のデフォルトの高さは scrollRect の都合上、
すぐには取得することができません．
その場合、コントローラー側での変数保存などの処理を行う必要があります．
| ScrollBar | ||
setScrollee(scrollee:DisplayObject, scrolleeWidth:Number, scrolleeHeight:Number):void
スクロール対象を設定します．
scrollRect の描画タイミングの問題で、幅・高さを指定させており、
そのため実装は setter ではなくメソッドでとなりました．
一方で、取得は getter から行うことができます．
| ScrollBar | ||
showControls():void
すべてのUIを使用可能状態にします．
イベントを投げるので見ための変更はイベントハンドラで行います．
| ScrollBar | ||
toString():String [override]
文字列表現を返します．
| ScrollBar | ||
| Constant | Defined By | ||
|---|---|---|---|
| MOUSE_WHEEL_LEVEL_ALL : int = 4 [static] マウスホイールレベル、すべて | ScrollBar | ||
| MOUSE_WHEEL_LEVEL_NONE : int = 0 [static] マウスホイールレベル、監視しない | ScrollBar | ||
| MOUSE_WHEEL_LEVEL_SCROLLEE : int = 2 [static] マウスホイールレベル、コンテンツのみ | ScrollBar | ||
| MOUSE_WHEEL_LEVEL_SCROLLER : int = 1 [static] マウスホイールレベル、スクロールバーのみ | ScrollBar | ||
| down_mc | property |
public var down_mc:Sprite| enabled | property |
enabled:Booleanコンポーネントの有効・無効を設定します． マウス操作全般の有効・無効と同期していますが、value の値の更新は、 たとえ無効であっても反映させることができます． また、この値を変更することで見栄えは変更しないので、コントローラー側で制御する必要があります． また、必要のないときは、enabled を false にすることで処理を軽くすることができます．
public function get enabled():Boolean public function set enabled(value:Boolean):void| fixThumbSize | property |
fixThumbSize:Booleanサムの大きさを変化させるかどうかのフラグ、デフォルトは false でサムの大きさは変化します．
public function get fixThumbSize():Boolean public function set fixThumbSize(value:Boolean):void| mouseWheelFriction | property |
public var mouseWheelFriction:Number = 0.2マウスホイール時の摩擦
| mouseWheelLevel | property |
public var mouseWheelLevel:int = 3マウスホイールをどこまで監視するかのレベル設定． デフォルトでは、ScrollBar インスタンスと scrollee の２つを監視します．
| scrollable | property |
scrollable:Boolean [read-only] スクロールが可能かどうかを返します． スクロール対象がマスクの大きさよりも小さくスクロールの必要がない場合hあ false を返します．
public function get scrollable():Boolean| scrollee | property |
scrollee:DisplayObject [read-only] 設定されているスクロール対象です．設定は setScrollee() を使います．
public function get scrollee():DisplayObject| thumb_mc | property |
public var thumb_mc:Sprite| track_mc | property |
public var track_mc:Sprite| up_mc | property |
public var up_mc:Sprite| value | property |
value:Numberスクロールバーの値です． 0 ～ 1 までの値で読み書きします．範囲外の数値を代入した場合、自動で丸め込みます． あくまでも割合を返すのでそこから先はコントローラー側で制御します．
public function get value():Number public function set value(value:Number):void| ScrollBar | () | Constructor |
public function ScrollBar()コンストラクタ．
| hideControls | () | method |
public function hideControls():voidすべてのUIを使用不能状態にします． イベントを投げるので見ための変更はイベントハンドラで行います．
| init | () | method |
public function init(scrollee:DisplayObject = null, mask:DisplayObject = null, initValue:Number = 0, scrolleeWidth:Number, scrolleeHeight:Number):void初期化を行います．このメソッドは必ず呼ぶようにしてください．
Parameters
scrollee:DisplayObject (default = null) | |
mask:DisplayObject (default = null) | |
initValue:Number (default = 0) | |
scrolleeWidth:Number (default = NaN) | |
scrolleeHeight:Number (default = NaN) |
| reset | () | method |
public function reset():void設定した内容をリセットします． リセットを行うものの、scrollee のデフォルトの高さは scrollRect の都合上、 すぐには取得することができません． その場合、コントローラー側での変数保存などの処理を行う必要があります．
| setScrollee | () | method |
public function setScrollee(scrollee:DisplayObject, scrolleeWidth:Number, scrolleeHeight:Number):voidスクロール対象を設定します． scrollRect の描画タイミングの問題で、幅・高さを指定させており、 そのため実装は setter ではなくメソッドでとなりました． 一方で、取得は getter から行うことができます．
Parameters
scrollee:DisplayObject | |
scrolleeWidth:Number (default = NaN) | |
scrolleeHeight:Number (default = NaN) |
| showControls | () | method |
public function showControls():voidすべてのUIを使用可能状態にします． イベントを投げるので見ための変更はイベントハンドラで行います．
| toString | () | method |
override public function toString():String文字列表現を返します．
ReturnsString |
| MOUSE_WHEEL_LEVEL_ALL | Constant |
public static const MOUSE_WHEEL_LEVEL_ALL:int = 4マウスホイールレベル、すべて
| MOUSE_WHEEL_LEVEL_NONE | Constant |
public static const MOUSE_WHEEL_LEVEL_NONE:int = 0マウスホイールレベル、監視しない
| MOUSE_WHEEL_LEVEL_SCROLLEE | Constant |
public static const MOUSE_WHEEL_LEVEL_SCROLLEE:int = 2マウスホイールレベル、コンテンツのみ
| MOUSE_WHEEL_LEVEL_SCROLLER | Constant |
public static const MOUSE_WHEEL_LEVEL_SCROLLER:int = 1マウスホイールレベル、スクロールバーのみ
// 基本的な設定とトゥイーン
import jp.naggg.controls.ScrollBar;
import fl.transitions.Tween;
import fl.motion.easing.
var mask1_mc:MovieClip;
var content1_mc:MovieClip;
var scroller1_mc:ScrollBar;
scroller1_mc.init(content1_mc, mask1_mc, false, 0);
scroller1_mc.addEventListener(Event.SCROLL, trace);
var tw:Tween = new Tween(scroller1_mc, "value", Bounce.easeOut, 1, 0, 60);
tw.start();