dojox
Version:
Dojo eXtensions, a rollup of many useful sub-projects and varying states of maturity – from very stable and robust, to alpha and experimental. See individual projects contain README files for details.
1,420 lines (1,314 loc) • 52.8 kB
JavaScript
define([
"dojo/_base/kernel",
"dojo/_base/connect",
"dojo/_base/event",
"dojo/_base/lang",
"dojo/_base/window",
"dojo/dom-class",
"dojo/dom-construct",
"dojo/dom-style",
"dojo/dom-geometry",
"dojo/touch",
"dijit/registry",
"dijit/form/_TextBoxMixin",
"./sniff",
"./_css3",
"./_maskUtils",
"./common",
"dojo/_base/declare",
"dojo/has!dojo-bidi?dojox/mobile/bidi/Scrollable"
], function(dojo, connect, event, lang, win, domClass, domConstruct, domStyle,
domGeom, touch, registry, TextBoxMixin, has, css3, maskUtils, common, declare, BidiScrollable){
// module:
// dojox/mobile/scrollable
// TODO: rename to Scrollable.js (capital S) for 2.0
// TODO: shouldn't be referencing this dojox/mobile variable, would be better to require the mobile.js module
var dm = lang.getObject("dojox.mobile", true);
// feature detection
has.add("translate3d", function(){
if(has("css3-animations")){
var elem = win.doc.createElement("div");
elem.style[css3.name("transform")] = "translate3d(0px,1px,0px)";
win.doc.documentElement.appendChild(elem);
var v = win.doc.defaultView.getComputedStyle(elem, '')[css3.name("transform", true)];
var hasTranslate3d = v && v.indexOf("matrix") === 0;
win.doc.documentElement.removeChild(elem);
return hasTranslate3d;
}
});
var Scrollable = function(){
// summary:
// Mixin for enabling touch scrolling capability.
// description:
// Mixin for enabling touch scrolling capability.
// Mobile WebKit browsers do not allow scrolling inner DIVs. (For instance,
// on iOS you need the two-finger operation to scroll them.)
// That means you cannot have fixed-positioned header/footer bars.
// To solve this issue, this module disables the browsers default scrolling
// behavior, and rebuilds its own scrolling machinery by handling touch
// events. In this module, this.domNode has height "100%" and is fixed to
// the window, and this.containerNode scrolls. If you place a bar outside
// of this.containerNode, then it will be fixed-positioned while
// this.containerNode is scrollable.
//
// This module has the following features:
//
// - Scrolls inner DIVs vertically, horizontally, or both.
// - Vertical and horizontal scroll bars.
// - Flashes the scroll bars when a view is shown.
// - Simulates the flick operation using animation.
// - Respects header/footer bars if any.
};
lang.extend(Scrollable, {
// fixedHeaderHeight: Number
// height of a fixed header
fixedHeaderHeight: 0,
// fixedFooterHeight: Number
// height of a fixed footer
fixedFooterHeight: 0,
// isLocalFooter: Boolean
// footer is view-local (as opposed to application-wide)
isLocalFooter: false,
// scrollBar: Boolean
// show scroll bar or not
scrollBar: true,
// scrollDir: String
// v: vertical, h: horizontal, vh: both, f: flip
scrollDir: "v",
// weight: Number
// frictional drag
weight: 0.6,
// fadeScrollBar: Boolean
fadeScrollBar: true,
// disableFlashScrollBar: Boolean
disableFlashScrollBar: false,
// threshold: Number
// drag threshold value in pixels
threshold: 4,
// constraint: Boolean
// bounce back to the content area
constraint: true,
// touchNode: DOMNode
// a node that will have touch event handlers
touchNode: null,
// propagatable: Boolean
// let touchstart event propagate up
propagatable: true,
// dirLock: Boolean
// disable the move handler if scroll starts in the unexpected direction
dirLock: false,
// height: String
// explicitly specified height of this widget (ex. "300px")
height: "",
// scrollType: Number
// - 1: use (-webkit-)transform:translate3d(x,y,z) style, use (-webkit-)animation for slide animation
// - 2: use top/left style,
// - 3: use (-webkit-)transform:translate3d(x,y,z) style, use (-webkit-)transition for slide animation
// - 0: use default value (3 for Android, iOS6+, and BlackBerry; otherwise 1)
scrollType: 0,
// _parentPadBorderExtentsBottom: [private] Number
// For Tooltip.js.
_parentPadBorderExtentsBottom: 0,
// _moved: [private] Boolean
// Flag that signals if the user have moved in (one of) the scroll
// direction(s) since touch start (a move under the threshold is ignored).
_moved: false,
init: function(/*Object?*/params){
// summary:
// Initialize according to the given params.
// description:
// Mixes in the given params into this instance. At least domNode
// and containerNode have to be given.
// Starts listening to the touchstart events.
// Calls resize(), if this widget is a top level widget.
if(params){
for(var p in params){
if(params.hasOwnProperty(p)){
this[p] = ((p == "domNode" || p == "containerNode") && typeof params[p] == "string") ?
win.doc.getElementById(params[p]) : params[p]; // mix-in params
}
}
}
// prevent browser scrolling on IE10 (evt.preventDefault() is not enough)
common._setTouchAction(this.domNode, "none");
this.touchNode = this.touchNode || this.containerNode;
this._v = (this.scrollDir.indexOf("v") != -1); // vertical scrolling
this._h = (this.scrollDir.indexOf("h") != -1); // horizontal scrolling
this._f = (this.scrollDir == "f"); // flipping views
this._ch = []; // connect handlers
this._ch.push(connect.connect(this.touchNode, touch.press, this, "onTouchStart"));
if(has("css3-animations")){
// flag for whether to use -webkit-transform:translate3d(x,y,z) or top/left style.
// top/left style works fine as a workaround for input fields auto-scrolling issue,
// so use top/left in case of Android by default.
this._useTopLeft = this.scrollType ? this.scrollType === 2 : false;
// Flag for using webkit transition on transform, instead of animation + keyframes.
// (keyframes create a slight delay before the slide animation...)
if(!this._useTopLeft){
this._useTransformTransition =
this.scrollType ? this.scrollType === 3 : has("ios") >= 6 || has("android") || has("bb");
}
if(!this._useTopLeft){
if(this._useTransformTransition){
this._ch.push(connect.connect(this.containerNode, css3.name("transitionEnd"), this, "onFlickAnimationEnd"));
// Note that there is no transitionstart event (#17822).
}else{
this._ch.push(connect.connect(this.containerNode, css3.name("animationEnd"), this, "onFlickAnimationEnd"));
this._ch.push(connect.connect(this.containerNode, css3.name("animationStart"), this, "onFlickAnimationStart"));
// Creation of keyframes takes a little time. If they are created
// in a lazy manner, a slight delay is noticeable when you start
// scrolling for the first time. This is to create keyframes up front.
for(var i = 0; i < 3; i++){
this.setKeyframes(null, null, i);
}
}
if(has("translate3d")){ // workaround for flicker issue on iPhone and Android 3.x/4.0
domStyle.set(this.containerNode, css3.name("transform"), "translate3d(0,0,0)");
}
}else{
this._ch.push(connect.connect(this.containerNode, css3.name("transitionEnd"), this, "onFlickAnimationEnd"));
// Note that there is no transitionstart event (#17822).
}
}
this._speed = {x:0, y:0};
this._appFooterHeight = 0;
if(this.isTopLevel() && !this.noResize){
this.resize();
}
var _this = this;
setTimeout(function(){
// Why not using widget.defer() instead of setTimeout()? Because this module
// is not always mixed into a widget (ex. dojox/mobile/_ComboBoxMenu), and adding
// a check to call either defer or setTimeout has been considered overkill.
_this.flashScrollBar();
}, 600);
// #16363: while navigating among input field using TAB (desktop keyboard) or
// NEXT (mobile soft keyboard), domNode.scrollTop gets modified (this holds even
// if the text widget has selectOnFocus at false, that is even if dijit's _FormWidgetMixin._onFocus
// does not trigger a global scrollIntoView). This messes up ScrollableView's own
// scrolling machinery. To avoid this misbehavior:
if(win.global.addEventListener){ // all supported browsers but IE8
// (for IE8, using attachEvent is not a solution, because it only works in bubbling phase)
this._onScroll = function(e){
if(!_this.domNode || _this.domNode.style.display === 'none'){ return; }
var scrollTop = _this.domNode.scrollTop;
var scrollLeft = _this.domNode.scrollLeft;
var pos;
if(scrollTop > 0 || scrollLeft > 0){
pos = _this.getPos();
// Reset to zero while compensating using our own scroll:
_this.domNode.scrollLeft = 0;
_this.domNode.scrollTop = 0;
_this.scrollTo({x: pos.x - scrollLeft, y: pos.y - scrollTop}); // no animation
}
};
win.global.addEventListener("scroll", this._onScroll, true);
}
// #17062: Ensure auto-scroll when navigating focusable fields
if(!this.disableTouchScroll && this.domNode.addEventListener){
this._onFocusScroll = function(e){
if(!_this.domNode || _this.domNode.style.display === 'none'){ return; }
var node = win.doc.activeElement;
var nodeRect, scrollableRect;
if(node){
nodeRect = node.getBoundingClientRect();
scrollableRect = _this.domNode.getBoundingClientRect();
if(nodeRect.height < _this.getDim().d.h){
// do not call scrollIntoView for elements with a height
// larger than the height of scrollable's content display
// area (it would be ergonomically harmful).
if(nodeRect.top < (scrollableRect.top + _this.fixedHeaderHeight)){
// scrolling towards top (to bring into the visible area an element
// located above it).
_this.scrollIntoView(node, true);
}else if((nodeRect.top + nodeRect.height) >
(scrollableRect.top + scrollableRect.height - _this.fixedFooterHeight)){
// scrolling towards bottom (to bring into the visible area an element
// located below it).
_this.scrollIntoView(node, false);
} // else do nothing (the focused node is already visible)
}
}
};
this.domNode.addEventListener("focus", this._onFocusScroll, true);
}
},
isTopLevel: function(){
// summary:
// Returns true if this is a top-level widget.
// description:
// Subclass may want to override.
return true;
},
cleanup: function(){
// summary:
// Uninitialize the module.
if(this._ch){
for(var i = 0; i < this._ch.length; i++){
connect.disconnect(this._ch[i]);
}
this._ch = null;
}
if(this._onScroll && win.global.removeEventListener){ // all supported browsers but IE8
win.global.removeEventListener("scroll", this._onScroll, true);
this._onScroll = null;
}
if(this._onFocusScroll && this.domNode.removeEventListener){
this.domNode.removeEventListener("focus", this._onFocusScroll, true);
this._onFocusScroll = null;
}
},
findDisp: function(/*DomNode*/node){
// summary:
// Finds the currently displayed view node from my sibling nodes.
if(!node.parentNode){ return null; }
// the given node is the first candidate
if(node.nodeType === 1 && domClass.contains(node, "mblSwapView") && node.style.display !== "none"){
return node;
}
var nodes = node.parentNode.childNodes;
for(var i = 0; i < nodes.length; i++){
var n = nodes[i];
if(n.nodeType === 1 && domClass.contains(n, "mblView") && n.style.display !== "none"){
return n;
}
}
return node;
},
getScreenSize: function(){
// summary:
// Returns the dimensions of the browser window.
return {
h: win.global.innerHeight||win.doc.documentElement.clientHeight||win.doc.documentElement.offsetHeight,
w: win.global.innerWidth||win.doc.documentElement.clientWidth||win.doc.documentElement.offsetWidth
};
},
resize: function(e){
// summary:
// Adjusts the height of the widget.
// description:
// If the height property is 'inherit', the height is inherited
// from its offset parent. If 'auto', the content height, which
// could be smaller than the entire screen height, is used. If an
// explicit height value (ex. "300px"), it is used as the new
// height. If nothing is specified as the height property, from the
// current top position of the widget to the bottom of the screen
// will be the new height.
// moved from init() to support dynamically added fixed bars
this._appFooterHeight = (this._fixedAppFooter) ? this._fixedAppFooter.offsetHeight : 0;
if(this.isLocalHeader){
this.containerNode.style.marginTop = this.fixedHeaderHeight + "px";
}
// Get the top position. Same as dojo.position(node, true).y
var top = 0;
for(var n = this.domNode; n && n.tagName != "BODY"; n = n.offsetParent){
n = this.findDisp(n); // find the first displayed view node
if(!n){ break; }
top += n.offsetTop + domGeom.getBorderExtents(n).h;
}
// adjust the height of this view
var h,
screenHeight = this.getScreenSize().h,
dh = screenHeight - top - this._appFooterHeight; // default height
if(this.height === "inherit"){
if(this.domNode.offsetParent){
h = domGeom.getContentBox(this.domNode.offsetParent).h - domGeom.getBorderExtents(this.domNode).h + "px";
}
}else if(this.height === "auto"){
var parent = this.domNode.offsetParent;
if(parent){
this.domNode.style.height = "0px";
var parentRect = parent.getBoundingClientRect(),
scrollableRect = this.domNode.getBoundingClientRect(),
contentBottom = parentRect.bottom - this._appFooterHeight - this._parentPadBorderExtentsBottom;
if(scrollableRect.bottom >= contentBottom){ // use entire screen
dh = screenHeight - (scrollableRect.top - parentRect.top) - this._appFooterHeight - this._parentPadBorderExtentsBottom;
}else{ // stretch to fill predefined area
dh = contentBottom - scrollableRect.bottom;
}
}
// content could be smaller than entire screen height
var contentHeight = Math.max(this.domNode.scrollHeight, this.containerNode.scrollHeight);
h = (contentHeight ? Math.min(contentHeight, dh) : dh) + "px";
}else if(this.height){
h = this.height;
}
if(!h){
h = dh + "px";
}
if(h.charAt(0) !== "-" && // to ensure that h is not negative (e.g. "-10px")
h !== "default"){
this.domNode.style.height = h;
}
if(!this._conn){
// to ensure that the view is within a scrolling area when resized.
this.onTouchEnd();
}
},
onFlickAnimationStart: function(e){
if(e){
event.stop(e);
}
},
onFlickAnimationEnd: function(e){
if(has("ios")){
this._keepInputCaretInActiveElement();
}
if(e){
var an = e.animationName;
if(an && an.indexOf("scrollableViewScroll2") === -1){
if(an.indexOf("scrollableViewScroll0") !== -1){ // scrollBarV
if(this._scrollBarNodeV){ domClass.remove(this._scrollBarNodeV, "mblScrollableScrollTo0"); }
}else if(an.indexOf("scrollableViewScroll1") !== -1){ // scrollBarH
if(this._scrollBarNodeH){ domClass.remove(this._scrollBarNodeH, "mblScrollableScrollTo1"); }
}else{ // fade or others
if(this._scrollBarNodeV){ this._scrollBarNodeV.className = ""; }
if(this._scrollBarNodeH){ this._scrollBarNodeH.className = ""; }
}
return;
}
if(this._useTransformTransition || this._useTopLeft){
var n = e.target;
if(n === this._scrollBarV || n === this._scrollBarH){
var cls = "mblScrollableScrollTo" + (n === this._scrollBarV ? "0" : "1");
if(domClass.contains(n, cls)){
domClass.remove(n, cls);
}else{
n.className = "";
}
return;
}
}
if(e.srcElement){
event.stop(e);
}
}
this.stopAnimation();
if(this._bounce){
var _this = this;
var bounce = _this._bounce;
setTimeout(function(){
_this.slideTo(bounce, 0.3, "ease-out");
}, 0);
_this._bounce = undefined;
}else{
this.hideScrollBar();
this.removeCover();
}
},
isFormElement: function(/*DOMNode*/node){
// summary:
// Returns true if the given node is a form control.
if(node && node.nodeType !== 1){ node = node.parentNode; }
if(!node || node.nodeType !== 1){ return false; }
var t = node.tagName;
return (t === "SELECT" || t === "INPUT" || t === "TEXTAREA" || t === "BUTTON");
},
onTouchStart: function(e){
// summary:
// User-defined function to handle touchStart events.
if(this.disableTouchScroll){ return; }
if(this._conn && (new Date()).getTime() - this.startTime < 500){
return; // ignore successive onTouchStart calls
}
if(!this._conn){
this._conn = [];
this._conn.push(connect.connect(win.doc, touch.move, this, "onTouchMove"));
this._conn.push(connect.connect(win.doc, touch.release, this, "onTouchEnd"));
}
this._aborted = false;
if(domClass.contains(this.containerNode, "mblScrollableScrollTo2")){
this.abort();
}else{ // reset scrollbar class especially for reseting fade-out animation
if(this._scrollBarNodeV){ this._scrollBarNodeV.className = ""; }
if(this._scrollBarNodeH){ this._scrollBarNodeH.className = ""; }
}
this.touchStartX = e.touches ? e.touches[0].pageX : e.clientX;
this.touchStartY = e.touches ? e.touches[0].pageY : e.clientY;
this.startTime = (new Date()).getTime();
this.startPos = this.getPos();
this._dim = this.getDim();
this._time = [0];
this._posX = [this.touchStartX];
this._posY = [this.touchStartY];
this._locked = false;
this._moved = false;
this._preventDefaultInNextTouchMove = true; // #17502
if(!this.isFormElement(e.target)){
// Call preventDefault to avoid browser scroll, except for form elements
// for which doing it in touch.press would forbid the virtual keyboard
// from showing up (for form elements which are text widgets, preventDefault
// is called in touch.move).
this.propagatable ? e.preventDefault() : event.stop(e);
this._preventDefaultInNextTouchMove = false;
}
},
onTouchMove: function(e){
// summary:
// User-defined function to handle touchMove events.
if(this._locked){ return; }
if(this._preventDefaultInNextTouchMove){ // #17502
this._preventDefaultInNextTouchMove = false; // only in the first touch.move
var enclosingWidget = registry.getEnclosingWidget(
// On touch-enabled devices, e.target can be different in touch.move than in
// touch.start. Hence:
((e.targetTouches && e.targetTouches.length === 1) ? e.targetTouches[0] : e).target);
if(enclosingWidget && enclosingWidget.isInstanceOf(TextBoxMixin)){
// For touches on text widgets for which e.preventDefault() has not been
// called in onTouchStart, call it in onTouchMove() to avoid browser scroll.
// Not done on other elements such that for instance a native slider
// can still handle touchmove events.
this.propagatable ? e.preventDefault() : event.stop(e);
}
}
var x = e.touches ? e.touches[0].pageX : e.clientX;
var y = e.touches ? e.touches[0].pageY : e.clientY;
var dx = x - this.touchStartX;
var dy = y - this.touchStartY;
var to = {x:this.startPos.x + dx, y:this.startPos.y + dy};
var dim = this._dim;
dx = Math.abs(dx);
dy = Math.abs(dy);
if(this._time.length == 1){ // the first TouchMove after TouchStart
if(this.dirLock){
if(this._v && !this._h && dx >= this.threshold && dx >= dy ||
(this._h || this._f) && !this._v && dy >= this.threshold && dy >= dx){
this._locked = true;
return;
}
}
if(this._v && this._h){ // scrollDir="hv"
if(dy < this.threshold &&
dx < this.threshold){
return;
}
}else{
if(this._v && dy < this.threshold ||
(this._h || this._f) && dx < this.threshold){
return;
}
}
this._moved = true;
this.addCover();
this.showScrollBar();
}
var weight = this.weight;
if(this._v && this.constraint){
if(to.y > 0){ // content is below the screen area
to.y = Math.round(to.y * weight);
}else if(to.y < -dim.o.h){ // content is above the screen area
if(dim.c.h < dim.d.h){ // content is shorter than display
to.y = Math.round(to.y * weight);
}else{
to.y = -dim.o.h - Math.round((-dim.o.h - to.y) * weight);
}
}
}
if((this._h || this._f) && this.constraint){
if(to.x > 0){
to.x = Math.round(to.x * weight);
}else if(to.x < -dim.o.w){
if(dim.c.w < dim.d.w){
to.x = Math.round(to.x * weight);
}else{
to.x = -dim.o.w - Math.round((-dim.o.w - to.x) * weight);
}
}
}
this.scrollTo(to);
var max = 10;
var n = this._time.length; // # of samples
if(n >= 2){
this._moved = true;
// Check the direction of the finger move.
// If the direction has been changed, discard the old data.
var d0, d1;
if(this._v && !this._h){
d0 = this._posY[n - 1] - this._posY[n - 2];
d1 = y - this._posY[n - 1];
}else if(!this._v && this._h){
d0 = this._posX[n - 1] - this._posX[n - 2];
d1 = x - this._posX[n - 1];
}
if(d0 * d1 < 0){ // direction changed
// leave only the latest data
this._time = [this._time[n - 1]];
this._posX = [this._posX[n - 1]];
this._posY = [this._posY[n - 1]];
n = 1;
}
}
if(n == max){
this._time.shift();
this._posX.shift();
this._posY.shift();
}
this._time.push((new Date()).getTime() - this.startTime);
this._posX.push(x);
this._posY.push(y);
},
_keepInputCaretInActiveElement: function(){
var activeElement = win.doc.activeElement;
var initialValue;
if(activeElement && (activeElement.tagName == "INPUT" || activeElement.tagName == "TEXTAREA")){
initialValue = activeElement.value;
if(activeElement.type == "number" || activeElement.type == "week"){
if(initialValue){
activeElement.value = activeElement.value + 1;
}else{
activeElement.value = (activeElement.type == "week") ? "2013-W10" : 1;
}
activeElement.value = initialValue;
}else{
activeElement.value = activeElement.value + " ";
activeElement.value = initialValue;
}
}
},
onTouchEnd: function(/*Event*/e){
// summary:
// User-defined function to handle touchEnd events.
if(this._locked){ return; }
var speed = this._speed = {x:0, y:0};
var dim = this._dim;
var pos = this.getPos();
var to = {}; // destination
if(e){
if(!this._conn){ return; } // if we get onTouchEnd without onTouchStart, ignore it.
for(var i = 0; i < this._conn.length; i++){
connect.disconnect(this._conn[i]);
}
this._conn = null;
var clicked = false;
if(!this._aborted && !this._moved){
clicked = true;
}
if(clicked){ // clicked, not dragged or flicked
this.hideScrollBar();
this.removeCover();
// need to send a synthetic click?
if(has("touch") && has("clicks-prevented") && !this.isFormElement(e.target)){
var elem = e.target;
if(elem.nodeType != 1){
elem = elem.parentNode;
}
setTimeout(function(){
dm._sendClick(elem, e);
});
}
return;
}
speed = this._speed = this.getSpeed();
}else{
if(pos.x == 0 && pos.y == 0){ return; } // initializing
dim = this.getDim();
}
if(this._v){
to.y = pos.y + speed.y;
}
if(this._h || this._f){
to.x = pos.x + speed.x;
}
if(this.adjustDestination(to, pos, dim) === false){ return; }
if(this.constraint){
if(this.scrollDir == "v" && dim.c.h < dim.d.h){ // content is shorter than display
this.slideTo({y:0}, 0.3, "ease-out"); // go back to the top
return;
}else if(this.scrollDir == "h" && dim.c.w < dim.d.w){ // content is narrower than display
this.slideTo({x:0}, 0.3, "ease-out"); // go back to the left
return;
}else if(this._v && this._h && dim.c.h < dim.d.h && dim.c.w < dim.d.w){
this.slideTo({x:0, y:0}, 0.3, "ease-out"); // go back to the top-left
return;
}
}
var duration, easing = "ease-out";
var bounce = {};
if(this._v && this.constraint){
if(to.y > 0){ // going down. bounce back to the top.
if(pos.y > 0){ // started from below the screen area. return quickly.
duration = 0.3;
to.y = 0;
}else{
to.y = Math.min(to.y, 20);
easing = "linear";
bounce.y = 0;
}
}else if(-speed.y > dim.o.h - (-pos.y)){ // going up. bounce back to the bottom.
if(pos.y < -dim.o.h){ // started from above the screen top. return quickly.
duration = 0.3;
to.y = dim.c.h <= dim.d.h ? 0 : -dim.o.h; // if shorter, move to 0
}else{
to.y = Math.max(to.y, -dim.o.h - 20);
easing = "linear";
bounce.y = -dim.o.h;
}
}
}
if((this._h || this._f) && this.constraint){
if(to.x > 0){ // going right. bounce back to the left.
if(pos.x > 0){ // started from right of the screen area. return quickly.
duration = 0.3;
to.x = 0;
}else{
to.x = Math.min(to.x, 20);
easing = "linear";
bounce.x = 0;
}
}else if(-speed.x > dim.o.w - (-pos.x)){ // going left. bounce back to the right.
if(pos.x < -dim.o.w){ // started from left of the screen top. return quickly.
duration = 0.3;
to.x = dim.c.w <= dim.d.w ? 0 : -dim.o.w; // if narrower, move to 0
}else{
to.x = Math.max(to.x, -dim.o.w - 20);
easing = "linear";
bounce.x = -dim.o.w;
}
}
}
this._bounce = (bounce.x !== undefined || bounce.y !== undefined) ? bounce : undefined;
if(duration === undefined){
var distance, velocity;
if(this._v && this._h){
velocity = Math.sqrt(speed.x*speed.x + speed.y*speed.y);
distance = Math.sqrt(Math.pow(to.y - pos.y, 2) + Math.pow(to.x - pos.x, 2));
}else if(this._v){
velocity = speed.y;
distance = to.y - pos.y;
}else if(this._h){
velocity = speed.x;
distance = to.x - pos.x;
}
if(distance === 0 && !e){ return; } // #13154
duration = velocity !== 0 ? Math.abs(distance / velocity) : 0.01; // time = distance / velocity
}
this.slideTo(to, duration, easing);
},
adjustDestination: function(/*Object*/to, /*Object*/pos, /*Object*/dim){
// summary:
// A stub function to be overridden by subclasses.
// description:
// This function is called from onTouchEnd(). The purpose is to give its
// subclasses a chance to adjust the destination position. If this
// function returns false, onTouchEnd() returns immediately without
// performing scroll.
// to:
// The destination position. An object with x and y.
// pos:
// The current position. An object with x and y.
// dim:
// Dimension information returned by getDim().
// subclass may want to implement
return true; // Boolean
},
abort: function(){
// summary:
// Aborts scrolling.
// description:
// This function stops the scrolling animation that is currently
// running. It is called when the user touches the screen while
// scrolling.
this._aborted = true;
this.scrollTo(this.getPos());
this.stopAnimation();
},
stopAnimation: function(){
// summary:
// Stops the currently running animation.
domClass.remove(this.containerNode, "mblScrollableScrollTo2");
this.containerNode.className = this.containerNode.className
.replace(/mblScrollableScrollTo2-[^ ]+/, ""); // TODO: remove supports regexp?
// TODO: there must be a better way than hardcoding this class name in
// 20 different places and 2 files
if(this._scrollBarV){
this._scrollBarV.className = "";
}
if(this._scrollBarH){
this._scrollBarH.className = "";
}
if(this._useTransformTransition || this._useTopLeft){
this.containerNode.style[css3.name("transition")] = "";
if(this._scrollBarV) { this._scrollBarV.style[css3.name("transition")] = ""; }
if(this._scrollBarH) { this._scrollBarH.style[css3.name("transition")] = ""; }
}
},
scrollIntoView: function(/*DOMNode*/node, /*Boolean?*/alignWithTop, /*Number?*/duration){
// summary:
// Scrolls the pane until the searching node is in the view.
// node:
// A DOM node to be searched for view.
// alignWithTop:
// If true, aligns the node at the top of the pane.
// If false, aligns the node at the bottom of the pane.
// duration:
// Duration of scrolling in seconds. (ex. 0.3)
// If not specified, scrolls without animation.
// description:
// Just like the scrollIntoView method of DOM elements, this
// function causes the given node to scroll into view, aligning it
// either at the top or bottom of the pane.
if(!this._v){ return; } // cannot scroll vertically
var c = this.containerNode,
h = this.getDim().d.h, // the height of ScrollableView's content display area
top = 0;
// Get the top position of node relative to containerNode
for(var n = node; n !== c; n = n.offsetParent){
if(!n || n.tagName === "BODY"){ return; } // exit if node is not a child of scrollableView
top += n.offsetTop;
}
// Calculate scroll destination position
var y = alignWithTop ? Math.max(h - c.offsetHeight, -top) : Math.min(0, h - top - node.offsetHeight);
// Scroll to destination position
(duration && typeof duration === "number") ?
this.slideTo({y: y}, duration, "ease-out") : this.scrollTo({y: y});
},
getSpeed: function(){
// summary:
// Returns an object that indicates the scrolling speed.
// description:
// From the position and elapsed time information, calculates the
// scrolling speed, and returns an object with x and y.
var x = 0, y = 0, n = this._time.length;
// if the user holds the mouse or finger more than 0.5 sec, do not move.
if(n >= 2 && (new Date()).getTime() - this.startTime - this._time[n - 1] < 500){
var dy = this._posY[n - (n > 3 ? 2 : 1)] - this._posY[(n - 6) >= 0 ? n - 6 : 0];
var dx = this._posX[n - (n > 3 ? 2 : 1)] - this._posX[(n - 6) >= 0 ? n - 6 : 0];
var dt = this._time[n - (n > 3 ? 2 : 1)] - this._time[(n - 6) >= 0 ? n - 6 : 0];
y = this.calcSpeed(dy, dt);
x = this.calcSpeed(dx, dt);
}
return {x:x, y:y};
},
calcSpeed: function(/*Number*/distance, /*Number*/time){
// summary:
// Calculate the speed given the distance and time.
return Math.round(distance / time * 100) * 4;
},
scrollTo: function(/*Object*/to, /*Boolean?*/doNotMoveScrollBar, /*DomNode?*/node){
// summary:
// Scrolls to the given position immediately without animation.
// to:
// The destination position. An object with x and y.
// ex. {x:0, y:-5}
// doNotMoveScrollBar:
// If true, the scroll bar will not be updated. If not specified,
// it will be updated.
// node:
// A DOM node to scroll. If not specified, defaults to
// this.containerNode.
// scroll events
var scrollEvent, beforeTopHeight, afterBottomHeight;
var doScroll = true;
if(!this._aborted && this._conn){ // No scroll event if the call to scrollTo comes from abort or onTouchEnd
if(!this._dim){
this._dim = this.getDim();
}
beforeTopHeight = (to.y > 0)?to.y:0;
afterBottomHeight = (this._dim.o.h + to.y < 0)?-1 * (this._dim.o.h + to.y):0;
scrollEvent = {bubbles: false,
cancelable: false,
x: to.x,
y: to.y,
beforeTop: beforeTopHeight > 0,
beforeTopHeight: beforeTopHeight,
afterBottom: afterBottomHeight > 0,
afterBottomHeight: afterBottomHeight};
// before scroll event
doScroll = this.onBeforeScroll(scrollEvent);
}
if(doScroll){
var s = (node || this.containerNode).style;
if(has("css3-animations")){
if(!this._useTopLeft){
if(this._useTransformTransition){
s[css3.name("transition")] = "";
}
s[css3.name("transform")] = this.makeTranslateStr(to);
}else{
s[css3.name("transition")] = "";
if(this._v){
s.top = to.y + "px";
}
if(this._h || this._f){
s.left = to.x + "px";
}
}
}else{
if(this._v){
s.top = to.y + "px";
}
if(this._h || this._f){
s.left = to.x + "px";
}
}
if(has("ios")){
this._keepInputCaretInActiveElement();
}
if(!doNotMoveScrollBar){
this.scrollScrollBarTo(this.calcScrollBarPos(to));
}
if(scrollEvent){
// After scroll event
this.onAfterScroll(scrollEvent);
}
}
},
onBeforeScroll: function(/*Event*/e){
// e: Event
// the scroll event, that contains the following attributes:
// x (x coordinate of the scroll destination),
// y (y coordinate of the scroll destination),
// beforeTop (a boolean that is true if the scroll detination is before the top of the scrollable),
// beforeTopHeight (the number of pixels before the top of the scrollable for the scroll destination),
// afterBottom (a boolean that is true if the scroll destination is after the bottom of the scrollable),
// afterBottomHeight (the number of pixels after the bottom of the scrollable for the scroll destination)
// summary:
// called before a scroll is initiated. If this method returns false,
// the scroll is canceled.
// tags:
// callback
return true;
},
onAfterScroll: function(/*Event*/e){
// e: Event
// the scroll event, that contains the following attributes:
// x (x coordinate of the scroll destination),
// y (y coordinate of the scroll destination),
// beforeTop (a boolean that is true if the scroll detination is before the top of the scrollable),
// beforeTopHeight (the number of pixels before the top of the scrollable for the scroll destination),
// afterBottom (a boolean that is true if the scroll destination is after the bottom of the scrollable),
// afterBottomHeight (the number of pixels after the bottom of the scrollable for the scroll destination)
// summary:
// called after a scroll has been performed.
// tags:
// callback
},
slideTo: function(/*Object*/to, /*Number*/duration, /*String*/easing){
// summary:
// Scrolls to the given position with the slide animation.
// to:
// The scroll destination position. An object with x and/or y.
// ex. {x:0, y:-5}, {y:-29}, etc.
// duration:
// Duration of scrolling in seconds. (ex. 0.3)
// easing:
// The name of easing effect which webkit supports.
// "ease", "linear", "ease-in", "ease-out", etc.
this._runSlideAnimation(this.getPos(), to, duration, easing, this.containerNode, 2);
this.slideScrollBarTo(to, duration, easing);
},
makeTranslateStr: function(/*Object*/to){
// summary:
// Constructs a string value that is passed to the -webkit-transform property.
// to:
// The destination position. An object with x and/or y.
// description:
// Return value example: "translate3d(0px,-8px,0px)"
var y = this._v && typeof to.y == "number" ? to.y+"px" : "0px";
var x = (this._h||this._f) && typeof to.x == "number" ? to.x+"px" : "0px";
return has("translate3d") ?
"translate3d("+x+","+y+",0px)" : "translate("+x+","+y+")";
},
getPos: function(){
// summary:
// Gets the top position in the midst of animation.
if(has("css3-animations")){
var s = win.doc.defaultView.getComputedStyle(this.containerNode, '');
if(!this._useTopLeft){
var m = s[css3.name("transform")];
if(m && m.indexOf("matrix") === 0){
var arr = m.split(/[,\s\)]+/);
// IE10 returns a matrix3d
var i = m.indexOf("matrix3d") === 0 ? 12 : 4;
return {y:arr[i+1] - 0, x:arr[i] - 0};
}
return {x:0, y:0};
}else{
return {x:parseInt(s.left) || 0, y:parseInt(s.top) || 0};
}
}else{
// this.containerNode.offsetTop does not work here,
// because it adds the height of the top margin.
var y = parseInt(this.containerNode.style.top) || 0;
return {y:y, x:this.containerNode.offsetLeft};
}
},
getDim: function(){
// summary:
// Returns various internal dimensional information needed for calculation.
var d = {};
// content width/height
d.c = {h:this.containerNode.offsetHeight, w:this.containerNode.offsetWidth};
// view width/height
d.v = {h:this.domNode.offsetHeight + this._appFooterHeight, w:this.domNode.offsetWidth};
// display width/height
d.d = {h:d.v.h - this.fixedHeaderHeight - this.fixedFooterHeight - this._appFooterHeight, w:d.v.w};
// overflowed width/height
d.o = {h:d.c.h - d.v.h + this.fixedHeaderHeight + this.fixedFooterHeight + this._appFooterHeight, w:d.c.w - d.v.w};
return d;
},
showScrollBar: function(){
// summary:
// Shows the scroll bar.
// description:
// This function creates the scroll bar instance if it does not
// exist yet, and calls resetScrollBar() to reset its length and
// position.
if(!this.scrollBar){ return; }
var dim = this._dim;
if(this.scrollDir == "v" && dim.c.h <= dim.d.h){ return; }
if(this.scrollDir == "h" && dim.c.w <= dim.d.w){ return; }
if(this._v && this._h && dim.c.h <= dim.d.h && dim.c.w <= dim.d.w){ return; }
var createBar = function(self, dir){
var bar = self["_scrollBarNode" + dir];
if(!bar){
var wrapper = domConstruct.create("div", null, self.domNode);
var props = { position: "absolute", overflow: "hidden" };
if(dir == "V"){
props.right = "2px";
props.width = "5px";
}else{
props.bottom = (self.isLocalFooter ? self.fixedFooterHeight : 0) + 2 + "px";
props.height = "5px";
}
domStyle.set(wrapper, props);
wrapper.className = "mblScrollBarWrapper";
self["_scrollBarWrapper"+dir] = wrapper;
bar = domConstruct.create("div", null, wrapper);
domStyle.set(bar, css3.add({
opacity: 0.6,
position: "absolute",
backgroundColor: "#606060",
fontSize: "1px",
MozBorderRadius: "2px",
zIndex: 2147483647 // max of signed 32-bit integer
}, {
borderRadius: "2px",
transformOrigin: "0 0"
}));
domStyle.set(bar, dir == "V" ? {width: "5px"} : {height: "5px"});
self["_scrollBarNode" + dir] = bar;
}
return bar;
};
if(this._v && !this._scrollBarV){
this._scrollBarV = createBar(this, "V");
}
if(this._h && !this._scrollBarH){
this._scrollBarH = createBar(this, "H");
}
this.resetScrollBar();
},
hideScrollBar: function(){
// summary:
// Hides the scroll bar.
// description:
// If the fadeScrollBar property is true, hides the scroll bar with
// the fade animation.
if(this.fadeScrollBar && has("css3-animations")){
if(!dm._fadeRule){
var node = domConstruct.create("style", null, win.doc.getElementsByTagName("head")[0]);
node.textContent =
".mblScrollableFadeScrollBar{"+
" " + css3.name("animation-duration", true) + ": 1s;"+
" " + css3.name("animation-name", true) + ": scrollableViewFadeScrollBar;}"+
"@" + css3.name("keyframes", true) + " scrollableViewFadeScrollBar{"+
" from { opacity: 0.6; }"+
" to { opacity: 0; }}";
dm._fadeRule = node.sheet.cssRules[1];
}
}
if(!this.scrollBar){ return; }
var f = function(bar, self){
domStyle.set(bar, css3.add({
opacity: 0
}, {
animationDuration: ""
}));
// do not use fade animation in case of using top/left on Android
// since it causes screen flicker during adress bar's fading out
if(!(self._useTopLeft && has('android'))){
bar.className = "mblScrollableFadeScrollBar";
}
};
if(this._scrollBarV){
f(this._scrollBarV, this);
this._scrollBarV = null;
}
if(this._scrollBarH){
f(this._scrollBarH, this);
this._scrollBarH = null;
}
},
calcScrollBarPos: function(/*Object*/to){
// summary:
// Calculates the scroll bar position.
// description:
// Given the scroll destination position, calculates the top and/or
// the left of the scroll bar(s). Returns an object with x and y.
// to:
// The scroll destination position. An object with x and y.
// ex. {x:0, y:-5}
var pos = {};
var dim = this._dim;
var f = function(wrapperH, barH, t, d, c){
var y = Math.round((d - barH - 8) / (d - c) * t);
if(y < -barH + 5){
y = -barH + 5;
}
if(y > wrapperH - 5){
y = wrapperH - 5;
}
return y;
};
if(typeof to.y == "number" && this._scrollBarV){
pos.y = f(this._scrollBarWrapperV.offsetHeight, this._scrollBarV.offsetHeight, to.y, dim.d.h, dim.c.h);
}
if(typeof to.x == "number" && this._scrollBarH){
pos.x = f(this._scrollBarWrapperH.offsetWidth, this._scrollBarH.offsetWidth, to.x, dim.d.w, dim.c.w);
}
return pos;
},
scrollScrollBarTo: function(/*Object*/to){
// summary:
// Moves the scroll bar(s) to the given position without animation.
// to:
// The destination position. An object with x and/or y.
// ex. {x:2, y:5}, {y:20}, etc.
if(!this.scrollBar){ return; }
if(this._v && this._scrollBarV && typeof to.y == "number"){
if(has("css3-animations")){
if(!this._useTopLeft){
if(this._useTransformTransition){
this._scrollBarV.style[css3.name("transition")] = "";
}
this._scrollBarV.style[css3.name("transform")] = this.makeTranslateStr({y:to.y});
}else{
domStyle.set(this._scrollBarV, css3.add({
top: to.y + "px"
}, {
transition: ""
}));
}
}else{
this._scrollBarV.style.top = to.y + "px";
}
}
if(this._h && this._scrollBarH && typeof to.x == "number"){
if(has("css3-animations")){
if(!this._useTopLeft){
if(this._useTransformTransition){
this._scrollBarH.style[css3.name("transition")] = "";
}
this._scrollBarH.style[css3.name("transform")] = this.makeTranslateStr({x:to.x});
}else{
domStyle.set(this._scrollBarH, css3.add({
left: to.x + "px"
}, {
transition: ""
}));
}
}else{
this._scrollBarH.style.left = to.x + "px";
}
}
},
slideScrollBarTo: function(/*Object*/to, /*Number*/duration, /*String*/easing){
// summary:
// Moves the scroll bar(s) to the given position with the slide animation.
// to:
// The destination position. An object with x and y.
// ex. {x:0, y:-5}
// duration:
// Duration of the animation in seconds. (ex. 0.3)
// easing:
// The name of easing effect which webkit supports.
// "ease", "linear", "ease-in", "ease-out", etc.
if(!this.scrollBar){ return; }
var fromPos = this.calcScrollBarPos(this.getPos());
var toPos = this.calcScrollBarPos(to);
if(this._v && this._scrollBarV){
this._runSlideAnimation({y:fromPos.y}, {y:toPos.y}, duration, easing, this._scrollBarV, 0);
}
if(this._h && this._scrollBarH){
this._runSlideAnimation({x:fromPos.x}, {x:toPos.x}, duration, easing, this._scrollBarH, 1);
}
},
_runSlideAnimation: function(/*Object*/from, /*Object*/to, /*Number*/duration, /*String*/easing, /*DomNode*/node, /*Number*/idx){
// tags:
// private
// idx: 0:scrollbarV, 1:scrollbarH, 2:content
if(has("css3-animations")){
if(!this._useTopLeft){
if(this._useTransformTransition){
// for iOS6 (maybe others?): use -webkit-transform + -webkit-transition
if(to.x === undefined){ to.x = from.x; }
if(to.y === undefined){ to.y = from.y; }
// make sure we actually change the transform, otherwise no webkitTransitionEnd is fired.
if(to.x !== from.x || to.y !== from.y){
this.onFlickAnimationStart(); // needed because there is no transitionstart event.
domStyle.set(node, css3.add({}, {
transitionProperty: css3.name("transform"),
transitionDuration: duration + "s",
transitionTimingFunction: easing
}));
var t = this.makeTranslateStr(to);
setTimeout(function(){ // setTimeout is needed to prevent webkitTransitionEnd not fired
domStyle.set(node, css3.add({}, {
transform: t
}));
}, 0);
domClass.add(node, "mblScrollableScrollTo"+idx);
} else {
// transform not changed, just hide the scrollbar
this.hideScrollBar();
this.removeCover();
}
}else{
// use -webkit-transform + -webkit-animation
var entering = this.findDisp(this.domNode) === this.domNode;
var className = this.setKeyframes(from, to, idx, entering);
domStyle.set(node, css3.add({}, {
animationDuration: duration + "s",
animationTimingFunction: easing
}));
domClass.add(node, className);
domClass.add(node, "mblScrollableScrollTo"+idx);
if(idx == 2){
this.scrollTo(to, true, node);
}else{
this.scrollScrollBarTo(to);
}
}
}else if(to.x !== undefined || to.y !== undefined){
this.onFlickAnimationStart(); // #17822: needed because there is no transitionstart event.
domStyle.set(node, css3.add({}, {
// #17822 when scrolling on one direction, avoid unnecessarily animating
// both top and left, because this leads to two transitionend events fired
// instead of one in some browsers (Safari/iOS7 at least).
transitionProperty: (to.x !== undefined && to.y !== undefined) ?
"top, left" :
to.y !== undefined ? "top" : "left",
transitionDuration: duration + "s",
transitionTimingFunction: easing
}));
setTimeout(function(){ // setTimeout is needed to prevent webkitTransitionEnd not fired
var style = {};
if(to.x !== undefined){
style.left = to.x + "px";
}
if(to.y !== undefined){
style.top = to.y + "px";
}
domStyle.set(node, style);
}, 0);
domClass.add(node, "mblScrollableScrollTo"+idx);
}
}else if(dojo.fx && dojo.fx.easing && duration){
// If you want to support non-webkit browsers,
// your application needs to load necessary modules as follows:
//
// | dojo.require("dojo.fx");
// | dojo.require("dojo.fx.easing");
//
// This module itself does not make dependency on them.
// TODO: for 2.0 the dojo global is going away. Use require("dojo/fx") and require("dojo/fx/easing") instead.
var self = this;
var s = dojo.fx.slideTo({
node: node,
duration: duration*1000,
left: to.x,
top: to.y,
easing: (easing == "ease-out") ? dojo.fx.easing.quadOut : dojo.fx.easing.linear,
onBegin: function(){ // #17822
if(idx == 2){
self.onFlickAnimationStart();
}
},
onEnd: function(){
if(idx == 2){
self.onFlickAnimationEnd();
}
}
}).play();
}else{
// directly jump to the destination without animation
if(idx == 2){
this.onFlickAnimationStart(); // #17822
this.scrollTo(to, false, node);
this.onFlickAnimationEnd();
}else{
this.scrollScrollBarTo(to);
}
}
},
resetScrollBar: function(){
// summary:
// Resets the scroll bar length, position, etc.
var f = function(wrapper, bar, d, c, hd, v){
if(!bar){ return; }
var props = {};
props[v ? "top" : "left"] = hd + 4 + "px"; // +4 is for top or left margin
var t = (d - 8) <= 0 ? 1 : d - 8;
props[v ? "height" : "width"] = t + "px";
domStyle.set(wrapper, props);
var l = Math.round(d * d / c); // scroll bar length
l = Math.min(Math.max(l - 8, 5), t); // -8 is for margin for both ends
bar.style[v ? "height" : "width"] = l + "px";
domStyle.set(bar, {"opacity": 0.6});
};
var dim = this.getDim();
f(this._scrollBarWrapperV, this._scrollBarV, dim.d.h, dim.c.h, this.fixedHeaderHeight, true);
f(this._scrollBarWrapperH, this._scrollBarH, dim.d.w, dim.c.w, 0);
this.createMask();
},
createMask: function(){
// summary:
// Creates a mask for a scroll bar edge.
// description:
// This function creates a mask that hides corners of one scroll
// bar edge to make it round edge. The other side of the edge is
// always visible and round shaped with the border-radius style.
if(!(has("mask-image"))){ return; }
if(this._scrollBarWrapperV){
var h = this._scrollBarWrapperV.offsetHeight;
maskUtils.createRoundMask(this._scrollBarWrapperV, 0, 0, 0, 0, 5, h, 2, 2, 0.5);
}
if(this._scrollBarWrapperH){
var w = this._scrollBarWrapperH.offsetWidth;
maskUtils.createRoundMask(this._scrollBarWrapperH, 0, 0, 0, 0, w, 5, 2, 2, 0.5);
}
},
flashScrollBar: function(){
// summary:
// Shows the scroll bar instantly.
// description:
// This function shows the scroll bar, and then hides it 300ms
// later. This is used to show the scroll bar to the user for a
// short period of time when a hidden view is revealed.
if(this.disableFlashScrollBar || !this.domNode){ return; }
this._dim = this.getDim();
if(this._dim.d.h <= 0){ return; } // dom is not ready
this.showScrollBar();
var _this = this;
setTimeout(function(){
_this.hideScrollBar();
}, 300);
},
addCover: function(){
// summary:
// Adds the transparent DIV cover.
// description:
// The cover is to prevent DOM events from affecting the child
// widgets such as a list widget. Without the cover, for example,
// child widgets may receive a click event and respond to it
// unexpectedly when the user flicks the screen to scroll.
// Note that only the desktop browsers need the cover.
if(!has("touch") && !(has("pointer-events") || has("MSPointer")) && !this.noCover){
if(!dm._cover){
dm._cover = domConstruct.create("div", null, win.doc.body);
dm._cover.className = "mblScrollableCover";
domStyle.set(dm._cover, {
backgroundColor: "#ffff00",
opacity: 0,
position: "ab