mirror of
https://github.com/cocos/cocos4.git
synced 2026-11-20 23:52:40 +08:00
335 lines
11 KiB
JavaScript
335 lines
11 KiB
JavaScript
/****************************************************************************
|
|
Copyright (c) 2013-2016 Chukong Technologies Inc.
|
|
|
|
http://www.cocos.com
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated engine source code (the "Software"), a limited,
|
|
worldwide, royalty-free, non-assignable, revocable and non-exclusive license
|
|
to use Cocos Creator solely to develop games on your target platforms. You shall
|
|
not use Cocos Creator software for developing other software or tools that's
|
|
used for developing games. You are not granted to publish, distribute,
|
|
sublicense, and/or sell copies of Cocos Creator.
|
|
|
|
The software or tools in this License Agreement are licensed, not sold.
|
|
Chukong Aipu reserves all rights not expressly granted to you.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
THE SOFTWARE.
|
|
****************************************************************************/
|
|
var GETTINGSHORTERFACTOR = 20;
|
|
|
|
/**
|
|
* Enum for Scrollbar direction
|
|
* @enum Scrollbar.Direction
|
|
*/
|
|
var Direction = cc.Enum({
|
|
/**
|
|
* @property {Number} HORIZONTAL
|
|
*/
|
|
HORIZONTAL: 0,
|
|
|
|
/**
|
|
* @property {Number} VERTICAL
|
|
*/
|
|
VERTICAL: 1
|
|
});
|
|
|
|
/**
|
|
* !#en
|
|
* The Scrollbar control allows the user to scroll an image or other view that is too large to see completely
|
|
* !#zh 滚动条组件
|
|
* @class Scrollbar
|
|
* @extends Component
|
|
*/
|
|
var Scrollbar = cc.Class({
|
|
name: 'cc.Scrollbar',
|
|
extends: require('./CCComponent'),
|
|
|
|
editor: CC_EDITOR && {
|
|
menu: 'i18n:MAIN_MENU.component.ui/ScrollBar',
|
|
help: 'i18n:COMPONENT.help_url.scrollbar',
|
|
},
|
|
|
|
properties: {
|
|
_scrollView: null,
|
|
_touching: false,
|
|
_autoHideRemainingTime: {
|
|
default: 0,
|
|
serializable: false
|
|
},
|
|
_opacity: 255,
|
|
|
|
/**
|
|
* !#en The "handle" part of the scrollbar.
|
|
* !#zh 作为当前滚动区域位置显示的滑块 Sprite。
|
|
* @property {cc.Sprite} handle
|
|
*/
|
|
handle: {
|
|
default: null,
|
|
type: cc.Sprite,
|
|
tooltip: 'i18n:COMPONENT.scrollbar.handle',
|
|
notify: function() {
|
|
this._onScroll(cc.p(0, 0));
|
|
},
|
|
animatable: false
|
|
},
|
|
|
|
/**
|
|
* !#en The direction of scrollbar.
|
|
* !#zh ScrollBar 的滚动方向。
|
|
*@property {Scrollbar.Direction} direction
|
|
*/
|
|
direction: {
|
|
default: Direction.HORIZONTAL,
|
|
type: Direction,
|
|
tooltip: 'i18n:COMPONENT.scrollbar.direction',
|
|
notify: function() {
|
|
this._onScroll(cc.p(0, 0));
|
|
},
|
|
animatable: false
|
|
},
|
|
|
|
/**
|
|
* !#en Whehter enable auto hide or not.
|
|
* !#zh 是否在没有滚动动作时自动隐藏 ScrollBar。
|
|
*@property {Boolean} enableAutoHide
|
|
*/
|
|
enableAutoHide: {
|
|
default: true,
|
|
animatable: false,
|
|
tooltip: 'i18n:COMPONENT.scrollbar.auto_hide',
|
|
},
|
|
|
|
/**
|
|
* !#en
|
|
* The time to hide scrollbar when scroll finished.
|
|
* Note: This value is only useful when enableAutoHide is true.
|
|
* !#zh
|
|
* 没有滚动动作后经过多久会自动隐藏。
|
|
* 注意:只要当 “enableAutoHide” 为 true 时,才有效。
|
|
*@property {Number} autoHideTime
|
|
*/
|
|
autoHideTime: {
|
|
default: 1.0,
|
|
animatable: false,
|
|
tooltip: 'i18n:COMPONENT.scrollbar.auto_hide_time',
|
|
}
|
|
},
|
|
|
|
statics: {
|
|
Direction: Direction
|
|
},
|
|
|
|
setTargetScrollView: function(scrollView) {
|
|
this._scrollView = scrollView;
|
|
},
|
|
|
|
_convertToScrollViewSpace: function(content) {
|
|
var worldSpacePos = content.convertToWorldSpace(cc.p(0, 0));
|
|
var scrollViewSpacePos = this._scrollView.node.convertToNodeSpace(worldSpacePos);
|
|
return scrollViewSpacePos;
|
|
},
|
|
|
|
_setOpacity: function(opacity) {
|
|
if (this.handle) {
|
|
this.node.setOpacity(opacity);
|
|
}
|
|
},
|
|
|
|
_onScroll: function(outOfBoundary) {
|
|
if (this._scrollView) {
|
|
|
|
var content = this._scrollView.content;
|
|
if(content){
|
|
var contentSize = content.getContentSize();
|
|
var scrollViewSize = this._scrollView.node.getContentSize();
|
|
|
|
if(this._conditionalDisableScrollBar(contentSize, scrollViewSize)) {
|
|
return;
|
|
}
|
|
|
|
if (this.enableAutoHide) {
|
|
this._autoHideRemainingTime = this.autoHideTime;
|
|
this._setOpacity(this._opacity);
|
|
}
|
|
|
|
var contentMeasure = 0;
|
|
var scrollViewMeasure = 0;
|
|
var outOfBoundaryValue = 0;
|
|
var contentPosition = 0;
|
|
|
|
if (this.direction === Direction.HORIZONTAL) {
|
|
contentMeasure = contentSize.width;
|
|
scrollViewMeasure = scrollViewSize.width;
|
|
outOfBoundaryValue = outOfBoundary.x;
|
|
|
|
contentPosition = -this._convertToScrollViewSpace(content).x;
|
|
} else if (this.direction === Direction.VERTICAL) {
|
|
contentMeasure = contentSize.height;
|
|
scrollViewMeasure = scrollViewSize.height;
|
|
outOfBoundaryValue = outOfBoundary.y;
|
|
|
|
contentPosition = -this._convertToScrollViewSpace(content).y;
|
|
}
|
|
|
|
var length = this._calculateLength(contentMeasure, scrollViewMeasure, outOfBoundaryValue);
|
|
var position = this._calculatePosition(contentMeasure, scrollViewMeasure, contentPosition, outOfBoundaryValue, length);
|
|
this._updateLength(length);
|
|
this._updateHanlderPosition(position);
|
|
}
|
|
}
|
|
},
|
|
|
|
_updateHanlderPosition: function(position) {
|
|
if (this.handle) {
|
|
var oldPosition = this._fixupHandlerPosition();
|
|
|
|
this.handle.node.setPosition(cc.pAdd(position, oldPosition));
|
|
}
|
|
},
|
|
|
|
_fixupHandlerPosition: function() {
|
|
var barSize = this.node.getContentSize();
|
|
var barAnchor = this.node.getAnchorPoint();
|
|
var barPosition = this.node.getPosition();
|
|
|
|
var fixupPosition;
|
|
var handleParent = this.handle.node.parent;
|
|
if (this.direction === Direction.HORIZONTAL) {
|
|
var leftSideWorldPosition = this.node.convertToWorldSpaceAR(cc.p(-barSize.width * barAnchor.x, -barSize.height * barAnchor.y));
|
|
|
|
fixupPosition = handleParent.convertToNodeSpaceAR(leftSideWorldPosition);
|
|
} else if (this.direction === Direction.VERTICAL) {
|
|
var bottomSideWorldPosition = this.node.convertToWorldSpaceAR(cc.p(-barSize.width * barAnchor.x, -barSize.height * barAnchor.y));
|
|
|
|
fixupPosition = handleParent.convertToNodeSpaceAR(bottomSideWorldPosition);
|
|
}
|
|
|
|
this.handle.node.setPosition(fixupPosition);
|
|
return fixupPosition;
|
|
},
|
|
|
|
_onTouchBegan: function() {
|
|
if (!this.enableAutoHide) {
|
|
return;
|
|
}
|
|
this._touching = true;
|
|
},
|
|
|
|
_conditionalDisableScrollBar: function (contentSize, scrollViewSize) {
|
|
if(contentSize.width <= scrollViewSize.width && this.direction === Direction.HORIZONTAL){
|
|
return true;
|
|
}
|
|
|
|
if(contentSize.height <= scrollViewSize.height && this.direction === Direction.VERTICAL){
|
|
return true;
|
|
}
|
|
return false;
|
|
},
|
|
|
|
_onTouchEnded: function() {
|
|
if (!this.enableAutoHide) {
|
|
return;
|
|
}
|
|
|
|
this._touching = false;
|
|
|
|
if (this.autoHideTime <= 0) {
|
|
return;
|
|
}
|
|
|
|
|
|
if (this._scrollView) {
|
|
var content = this._scrollView.content;
|
|
if(content){
|
|
var contentSize = content.getContentSize();
|
|
var scrollViewSize = this._scrollView.node.getContentSize();
|
|
|
|
if(this._conditionalDisableScrollBar(contentSize, scrollViewSize)) {
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
|
|
this._autoHideRemainingTime = this.autoHideTime;
|
|
},
|
|
|
|
_calculateLength: function(contentMeasure, scrollViewMeasure, outOfBoundary) {
|
|
var denominatorValue = contentMeasure;
|
|
if (outOfBoundary) {
|
|
denominatorValue += (outOfBoundary > 0 ? outOfBoundary : -outOfBoundary) * GETTINGSHORTERFACTOR;
|
|
}
|
|
|
|
var lengthRation = scrollViewMeasure / denominatorValue;
|
|
return scrollViewMeasure * lengthRation;
|
|
},
|
|
|
|
_calculatePosition: function(contentMeasure, scrollViewMeasure, contentPosition, outOfBoundary, actualLenth) {
|
|
var denominatorValue = contentMeasure - scrollViewMeasure;
|
|
if (outOfBoundary) {
|
|
denominatorValue += Math.abs(outOfBoundary);
|
|
}
|
|
|
|
var positionRatio = 0;
|
|
if (denominatorValue) {
|
|
positionRatio = contentPosition / denominatorValue;
|
|
positionRatio = cc.clamp01(positionRatio);
|
|
}
|
|
|
|
var position = (scrollViewMeasure - actualLenth) * positionRatio;
|
|
if (this.direction === Direction.VERTICAL) {
|
|
return cc.p(0, position);
|
|
} else {
|
|
return cc.p(position, 0);
|
|
}
|
|
},
|
|
|
|
_updateLength: function(length) {
|
|
if (this.handle) {
|
|
var handleNode = this.handle.node;
|
|
var handleNodeSize = this.node.getContentSize();
|
|
handleNode.setAnchorPoint(cc.p(0, 0));
|
|
if (this.direction === Direction.HORIZONTAL) {
|
|
handleNode.setContentSize(length, handleNodeSize.height);
|
|
} else {
|
|
handleNode.setContentSize(handleNodeSize.width, length);
|
|
}
|
|
}
|
|
},
|
|
|
|
_processAutoHide: function(deltaTime) {
|
|
if (!this.enableAutoHide || this._autoHideRemainingTime <= 0) {
|
|
return;
|
|
} else if (this._touching) {
|
|
return;
|
|
}
|
|
|
|
|
|
this._autoHideRemainingTime -= deltaTime;
|
|
if (this._autoHideRemainingTime <= this.autoHideTime) {
|
|
this._autoHideRemainingTime = Math.max(0, this._autoHideRemainingTime);
|
|
var opacity = this._opacity * (this._autoHideRemainingTime / this.autoHideTime);
|
|
this._setOpacity(opacity);
|
|
}
|
|
},
|
|
|
|
start: function() {
|
|
if (this.enableAutoHide) {
|
|
this._setOpacity(0);
|
|
}
|
|
},
|
|
|
|
update: function(dt) {
|
|
this._processAutoHide(dt);
|
|
}
|
|
});
|
|
|
|
|
|
cc.Scrollbar = module.exports = Scrollbar;
|