ScrollBar 组件是一个滚动条组件。
* 当数据太多以至于显示区域无法容纳时，最终用户可以使用 ScrollBar 组件控制所显示的数据部分。
滚动条由四部分组成：两个箭头按钮、一个轨道和一个滑块。
* * * @see laya.ui.VScrollBar * @see laya.ui.HScrollBar */ public class ScrollBar extends Component { /**滚动变化时回调，回传value参数。*/ public var changeHandler:Handler; /**是否缩放滑动条，默认值为true。 */ public var scaleBar:Boolean = true; /**一个布尔值，指定是否自动隐藏滚动条(无需滚动时)，默认值为false。*/ public var autoHide:Boolean = false; /**橡皮筋效果极限距离，0为没有橡皮筋效果。*/ public var elasticDistance:Number = 0; /**橡皮筋回弹时间，单位为毫秒。*/ public var elasticBackTime:Number = 500; /**@private */ protected var _showButtons:Boolean = UIConfig.showButtons; /**@private */ protected var _scrollSize:Number = 1; /**@private */ protected var _skin:String; /**@private */ protected var _upButton:Button; /**@private */ protected var _downButton:Button; /**@private */ protected var _slider:Slider; /**@private */ protected var _thumbPercent:Number = 1; /**@private */ protected var _target:Sprite; /**@private */ protected var _lastPoint:Point; /**@private */ protected var _lastOffset:Number = 0; /**@private */ protected var _checkElastic:Boolean = false; /**@private */ protected var _isElastic:Boolean = false; /**@private */ protected var _value:Number; /**@private */ protected var _hide:Boolean = false; /**@private */ protected var _clickOnly:Boolean = true; /**@private */ protected var _offsets:Array; /**@private */ protected var _touchScrollEnable:Boolean = UIConfig.touchScrollEnable; /**@private */ protected var _mouseWheelEnable:Boolean = UIConfig.mouseWheelEnable; /** * 创建一个新的ScrollBar 实例。
* @param skin 皮肤资源地址。
*/
public function ScrollBar(skin:String = null):void {
this.skin = skin;
this.max = 1;
}
/**@inheritDoc */
override public function destroy(destroyChild:Boolean = true):void {
super.destroy(destroyChild);
_upButton && _upButton.destroy(destroyChild);
_downButton && _downButton.destroy(destroyChild);
_slider && _slider.destroy(destroyChild);
_upButton = _downButton = null;
_slider = null;
changeHandler = null;
_offsets = null;
}
/**@inheritDoc */
override protected function createChildren():void {
addChild(_slider = new Slider());
//TODO:
addChild(_upButton = new Button());
addChild(_downButton = new Button());
}
/**@inheritDoc */
override protected function initialize():void {
_slider.showLabel = false;
_slider.on(Event.CHANGE, this, onSliderChange);
_slider.setSlider(0, 0, 0);
_upButton.on(Event.MOUSE_DOWN, this, onButtonMouseDown);
_downButton.on(Event.MOUSE_DOWN, this, onButtonMouseDown);
}
/**
* @private
* 滑块位置发生改变的处理函数。
*/
protected function onSliderChange(e:Event):void {
value = _slider.value;
}
/**
* @private
* 向上和向下按钮的 Event.MOUSE_DOWN 事件侦听处理函数。
*/
protected function onButtonMouseDown(e:Event):void {
var isUp:Boolean = e.currentTarget === _upButton;
slide(isUp);
Laya.timer.once(Styles.scrollBarDelayTime, this, startLoop, [isUp]);
Laya.stage.once(Event.MOUSE_UP, this, onStageMouseUp);
}
/**@private */
protected function startLoop(isUp:Boolean):void {
Laya.timer.frameLoop(1, this, slide, [isUp]);
}
/**@private */
protected function slide(isUp:Boolean):void {
if (isUp) value -= _scrollSize;
else value += _scrollSize;
}
/**
* @private
* 舞台的 Event.MOUSE_DOWN 事件侦听处理函数。
*/
protected function onStageMouseUp(e:Event):void {
Laya.timer.clear(this, startLoop);
Laya.timer.clear(this, slide);
}
/**
* @copy laya.ui.Image#skin
*/
public function get skin():String {
return _skin;
}
public function set skin(value:String):void {
if (_skin != value) {
_skin = value;
_slider.skin = _skin;
callLater(changeScrollBar);
}
}
/**
* @private
* 更改对象的皮肤及位置。
*/
protected function changeScrollBar():void {
_upButton.visible = _showButtons;
_downButton.visible = _showButtons;
if (_showButtons) {
_upButton.skin = _skin.replace(".png", "$up.png");
_downButton.skin = _skin.replace(".png", "$down.png");
}
if (_slider.isVertical) _slider.y = _showButtons ? _upButton.height : 0;
else _slider.x = _showButtons ? _upButton.width : 0;
resetPositions();
}
/**@inheritDoc */
override protected function changeSize():void {
super.changeSize();
resetPositions();
event(Event.CHANGE);
changeHandler && changeHandler.runWith(value);
}
/**@private */
private function resetPositions():void {
if (_slider.isVertical) _slider.height = height - (_showButtons ? (_upButton.height + _downButton.height) : 0);
else _slider.width = width - (_showButtons ? (_upButton.width + _downButton.width) : 0);
resetButtonPosition();
}
/**@private */
protected function resetButtonPosition():void {
if (_slider.isVertical) _downButton.y = _slider.y + _slider.height;
else _downButton.x = _slider.x + _slider.width;
}
/**@inheritDoc */
override protected function get measureWidth():Number {
if (_slider.isVertical) return _slider.width;
return 100;
}
/**@inheritDoc */
override protected function get measureHeight():Number {
if (_slider.isVertical) return 100;
return _slider.height;
}
/**
* 设置滚动条信息。
* @param min 滚动条最小位置值。
* @param max 滚动条最大位置值。
* @param value 滚动条当前位置值。
*/
public function setScroll(min:Number, max:Number, value:Number):void {
runCallLater(changeSize);
_slider.setSlider(min, max, value);
//_upButton.disabled = max <= 0;
//_downButton.disabled = max <= 0;
_slider.bar.visible = max > 0;
if (!_hide && autoHide) visible = false;
}
/**
* 获取或设置表示最高滚动位置的数字。
*/
public function get max():Number {
return _slider.max;
}
public function set max(value:Number):void {
_slider.max = value;
}
/**
* 获取或设置表示最低滚动位置的数字。
*/
public function get min():Number {
return _slider.min;
}
public function set min(value:Number):void {
_slider.min = value;
}
/**
* 获取或设置表示当前滚动位置的数字。
*/
public function get value():Number {
return _value;
}
public function set value(v:Number):void {
if (v !== _value) {
if (_isElastic) _value = v;
else {
_slider.value = v;
_value = _slider.value;
}
event(Event.CHANGE);
changeHandler && changeHandler.runWith(value);
}
}
/**
* 一个布尔值，指示滚动条是否为垂直滚动。如果值为true，则为垂直滚动，否则为水平滚动。
* 默认值为：true。
*/ public function get isVertical():Boolean { return _slider.isVertical; } public function set isVertical(value:Boolean):void { _slider.isVertical = value; } /** *当前实例的 Slider 实例的有效缩放网格数据。
数据格式："上边距,右边距,下边距,左边距,是否重复填充(值为0：不重复填充，1：重复填充)"，以逗号分隔。 *