scrollview-base-debug.js revision 6e2ec7ffae3abc29274a143e4dba51bbd349c58d
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav GlassYUI.add('scrollview-base', function(Y) {
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass/**
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * The scrollview-base module provides a basic ScrollView Widget, without scrollbar indicators
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass *
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * @module scrollview-base
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass */
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glassvar getClassName = Y.ClassNameManager.getClassName,
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass SCROLLVIEW = 'scrollview',
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass CLASS_NAMES = {
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass vertical: getClassName(SCROLLVIEW, 'vert'),
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass horizontal: getClassName(SCROLLVIEW, 'horiz')
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass },
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass EV_SCROLL_END = 'scrollEnd',
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass EV_SCROLL_FLICK = 'flick',
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass FLICK = EV_SCROLL_FLICK,
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass UI = 'ui',
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass LEFT = "left",
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass TOP = "top",
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass PX = "px",
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass SCROLL_Y = "scrollY",
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass SCROLL_X = "scrollX",
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass BOUNCE = "bounce",
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass DIM_X = "x",
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass DIM_Y = "y",
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass BOUNDING_BOX = "boundingBox",
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass CONTENT_BOX = "contentBox",
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass NATIVE_TRANSITIONS = Y.Transition.useNative;
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav GlassY.Node.DOM_EVENTS.DOMSubtreeModified = true;
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass/**
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * ScrollView provides a scrollable widget, supporting flick gestures, across both touch and mouse based devices.
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass *
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * @class ScrollView
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * @namespace
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * @param config {Object} Object literal with initial attribute values
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * @extends Widget
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * @constructor
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass */
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glassfunction ScrollView() {
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass ScrollView.superclass.constructor.apply(this, arguments);
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass}
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav GlassY.ScrollView = Y.extend(ScrollView, Y.Widget, {
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass // Y.ScrollView prototype
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass /**
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * Designated initializer
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass *
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * @method initializer
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass */
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass initializer: function() {
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass this._createEvents();
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass // Cache - they're write once, and not going to change
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass this._cb = this.get(CONTENT_BOX);
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass this._bb = this.get(BOUNDING_BOX);
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass },
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass /**
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * Publishes events which occur during the scroll lifecycle
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass *
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * @method _createEvents
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * @private
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass */
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass _createEvents: function() {
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass /**
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * Notification event fired at the end of a scroll transition
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass *
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * @event scrollEnd
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * @param e {EventFacade} The default event facade.
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass */
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass this.publish(EV_SCROLL_END);
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass /**
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * Notification event fired at the end of a flick gesture (the flick animation may still be in progress)
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass *
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * @event flick
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * @param e {EventFacade} The default event facade.
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass */
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass this.publish(EV_SCROLL_FLICK);
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass },
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass /**
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * Override the contentBox sizing method, since the contentBox height
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * should not be that of the boundingBox.
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass *
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * @method _uiSizeCB
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * @protected
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass */
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass _uiSizeCB: function() {},
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass /**
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * TranstionEnd event handler
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass *
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * @method _transitionEnded
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * @param {Event.Facade} e The event facade
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * @private
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass */
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass _transitionEnded: function(e) {
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass this.fire(EV_SCROLL_END);
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass },
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass /**
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * bindUI implementation
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass *
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * Hooks up events for the widget
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass * @method bindUI
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass */
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass bindUI: function() {
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass var cb = this._cb,
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass flick = this.get(FLICK);
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass this._bb.on('gesturemovestart', Y.bind(this._onGestureMoveStart, this));
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass cb.on('transition:end', Y.bind(this._transitionEnded, this), false);
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass // TODO: Fires way to often when using non-native transitions, due to property change
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass if (NATIVE_TRANSITIONS) {
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass cb.on('DOMSubtreeModified', Y.bind(this._uiDimensionsChange, this));
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass }
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass if (flick) {
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass cb.on("flick", Y.bind(this._flick, this), flick);
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass }
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass this.after({
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass 'scrollYChange' : this._afterScrollYChange,
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass 'scrollXChange' : this._afterScrollXChange,
ae3b364068d9a32a9c7a81fd9530d90496943d45Dav Glass 'heightChange' : this._afterHeightChange,
'widthChange' : this._afterWidthChange,
'renderedChange': function() { Y.later(0, this, '_uiDimensionsChange'); }
});
},
/**
* syncUI implementation
*
* Update the scroll position, based on the current value of scrollY
* @method bindUI
*/
syncUI: function() {
this.scrollTo(this.get(SCROLL_X), this.get(SCROLL_Y));
},
/**
* Scroll the element to a given y coordinate
*
* @method scrollTo
* @param x {Number} The x-position to scroll to
* @param y {Number} The y-position to scroll to
* @param duration {Number} Duration, in ms, of the scroll animation (default is 0)
* @param easing {String} An easing equation if duration is set
*/
scrollTo: function(x, y, duration, easing) {
var cb = this._cb,
xSet = (x !== null),
ySet = (y !== null),
xMove = (xSet) ? x * -1 : 0,
yMove = (ySet) ? y * -1 : 0,
transition;
duration = duration || 0;
easing = easing || ScrollView.EASING;
if (xSet) {
this.set(SCROLL_X, x, { src: UI });
}
if (ySet) {
this.set(SCROLL_Y, y, { src: UI });
}
if (duration !== 0) {
transition = {
easing : easing,
duration : duration/1000
};
if (NATIVE_TRANSITIONS) {
transition.transform = 'translate('+ xMove +'px,'+ yMove +'px)';
} else {
if (xSet) { transition.left = xMove + PX; }
if (ySet) { transition.top = yMove + PX; }
}
Y.log("Transition: duration, easing:" + [transition.duration, transition.easing], "scrollview");
cb.transition(transition);
} else {
if (NATIVE_TRANSITIONS) {
cb.setStyle('transform', 'translate3D('+ xMove +'px,'+ yMove +'px, 0px)');
} else {
if (xSet) { cb.setStyle(LEFT, xMove + PX); }
if (ySet) { cb.setStyle(TOP, yMove + PX); }
}
}
},
/**
* gesturemovestart event handler
*
* @method _onGestureMoveStart
* @param e {Event.Facade} The gesturemovestart event facade
* @private
*/
_onGestureMoveStart: function(e) {
e.preventDefault();
this._killTimer();
var bb = this._bb;
this._moveEvt = bb.on('gesturemove', Y.bind(this._onGestureMove, this));
this._moveEndEvt = bb.on('gesturemoveend', Y.bind(this._onGestureMoveEnd, this));
this._moveStartY = e.clientY + this.get(SCROLL_Y);
this._moveStartX = e.clientX + this.get(SCROLL_X);
this._moveStartTime = (new Date()).getTime();
this._moveStartClientY = e.clientY;
this._moveStartClientX = e.clientX;
this._isDragging = false;
this._flicking = false;
this._snapToEdge = false;
},
/**
* gesturemove event handler
*
* @method _onGestureMove
* @param e {Event.Facade} The gesturemove event facade
* @private
*/
_onGestureMove: function(e) {
e.preventDefault();
this._isDragging = true;
this._moveEndClientY = e.clientY;
this._moveEndClientX = e.clientX;
this._lastMoved = (new Date()).getTime();
if(this._scrollsVertical) {
this.set(SCROLL_Y, -(e.clientY - this._moveStartY));
}
if(this._scrollsHorizontal) {
this.set(SCROLL_X, -(e.clientX - this._moveStartX));
}
},
/**
* gestureend event handler
*
* @method _onGestureMoveEnd
* @param e {Event.Facade} The gesturemoveend event facade
* @private
*/
_onGestureMoveEnd: function(e) {
e.preventDefault();
var minY = this._minScrollY,
maxY = this._maxScrollY,
minX = this._minScrollX,
maxX = this._maxScrollX,
startPoint = this._scrollsVertical ? this._moveStartClientY : this._moveStartClientX,
endPoint = this._scrollsVertical ? this._moveEndClientY : this._moveEndClientX,
distance = startPoint - endPoint;
this._moveEvt.detach();
this._moveEndEvt.detach();
this._scrolledHalfway = false;
this._snapToEdge = false;
this._isDragging = false;
if(this._scrollsHorizontal && Math.abs(distance) > (this.get('width')/2)) {
this._scrolledHalfway = true;
this._scrolledForward = distance > 0;
}
if(this._scrollsVertical && Math.abs(distance) > (this.get('height')/2)) {
this._scrolledHalfway = true;
this._scrolledForward = distance > 0;
}
// Check for minY
if(this._scrollsVertical && this.get(SCROLL_Y) < minY) {
this._snapToEdge = true;
this.set(SCROLL_Y, minY);
}
// Check for minX
if(this._scrollsHorizontal && this.get(SCROLL_X) < minX) {
this._snapToEdge = true;
this.set(SCROLL_X, minX);
}
// Check for maxY
if(this.get(SCROLL_Y) > maxY) {
this._snapToEdge = true;
this.set(SCROLL_Y, maxY);
}
// Check for maxX
if(this.get(SCROLL_X) > maxX) {
this._snapToEdge = true;
this.set(SCROLL_X, maxX);
}
Y.log("half:" + this._scrolledHalfway + ", fwd:" + this._scrolledForward, "scrollview");
if(this._snapToEdge) {
return;
}
this.fire(EV_SCROLL_END, {
onGestureMoveEnd: true
});
return;
},
/**
* after listener for changes to the scrollY attr
*
* @method _afterScrollYChange
* @param e {Event.Facade} The event
* @protected
*/
_afterScrollYChange : function(e) {
if(e.src !== UI) {
this._uiScrollY(e.newVal, e.duration, e.easing);
}
},
/**
* Update the UI when the scrollY attr changes
*
* @method _uiScrollY
* @param val {Number} The scrollY value
* @param duration {Number} The length (in ms) of the scroll animation
* @param easing {String} An easing equation, if duration is defined
* @protected
*/
_uiScrollY : function(val, duration, easing) {
duration = duration || this._snapToEdge ? 400 : 0;
easing = easing || this._snapToEdge ? ScrollView.SNAP_EASING : null;
this.scrollTo(null, val, duration, easing);
},
/**
* after listener for changes to the scrollX attr
*
* @method _afterScrollXChange
* @param e {Event.Facade} The event
* @protected
*/
_afterScrollXChange : function(e) {
if(e.src !== UI) {
this._uiScrollX(e.newVal, e.duration, e.easing);
}
},
/**
* Update the UI when the scrollX attr changes
*
* @method _uiScrollX
* @param val {Number} The scrollX value
* @param duration {Number} The length (in ms) of the scroll animation
* @param easing {String} An easing equation, if duration is defined
* @protected
*/
_uiScrollX : function(val, duration, easing) {
duration = duration || this._snapToEdge ? 400 : 0;
easing = easing || this._snapToEdge ? ScrollView.SNAP_EASING : null;
this.scrollTo(val, null, duration, easing);
},
/**
* after listener for the height attribute
*
* @method _afterHeightChange
* @param e {Event.Facade} The event
* @protected
*/
_afterHeightChange: function() {
this._uiDimensionsChange();
},
/**
* after listener for the width attribute
*
* @method _afterHeightChange
* @param e {Event.Facade} The event
* @protected
*/
_afterWidthChange: function() {
this._uiDimensionsChange();
},
/**
* This method gets invoked whenever the height or width attrs change,
* allowing us to determine which scrolling axes need to be enabled.
*
* @method _uiDimensionsChange
* @protected
*/
_uiDimensionsChange: function() {
var bb = this._bb,
height = this.get('height'),
width = this.get('width'),
// Use bb instead of cb. cb doesn't gives us the right results
// in FF (due to overflow:hidden)
scrollHeight = bb.get('scrollHeight'),
scrollWidth = bb.get('scrollWidth');
if(height && scrollHeight > height) {
this._scrollsVertical = true;
this._maxScrollY = scrollHeight - height;
this._minScrollY = 0;
this._scrollHeight = scrollHeight;
bb.addClass(ScrollView.CLASS_NAMES.vertical);
}
if(width && scrollWidth > width) {
this._scrollsHorizontal = true;
this._maxScrollX = scrollWidth - width;
this._minScrollX = 0;
this._scrollWidth = scrollWidth;
bb.addClass(ScrollView.CLASS_NAMES.horizontal);
}
},
/**
* Execute a flick at the end of a scroll action
*
* @method _flick
* @param distance {Number} The distance (in px) the user scrolled before the flick
* @param time {Number} The number of ms the scroll event lasted before the flick
* @protected
*/
_flick: function(e) {
var flick = e.flick;
this._currentVelocity = flick.velocity;
this._flicking = true;
this._decelCached = this.get('deceleration');
this._bounceCached = this.get('bounce');
this._pastYEdge = false;
this._pastXEdge = false;
this._flickFrame();
this.fire(EV_SCROLL_FLICK);
},
/**
* Execute a single frame in the flick animation
*
* @method _flickFrame
* @protected
*/
_flickFrame: function() {
var newY,
maxY,
minY,
newX,
maxX,
minX,
scrollsVertical = this._scrollsVertical,
scrollsHorizontal = this._scrollsHorizontal,
deceleration = this._decelCached,
bounce = this._bounceCached,
step = ScrollView.FRAME_STEP;
if(scrollsVertical) {
maxY = this._maxScrollY;
minY = this._minScrollY;
newY = this.get(SCROLL_Y) - (this._currentVelocity * step);
}
if(scrollsHorizontal) {
maxX = this._maxScrollX;
minX = this._minScrollX;
newX = this.get(SCROLL_X) - (this._currentVelocity * step);
}
this._currentVelocity = (this._currentVelocity * deceleration);
if(Math.abs(this._currentVelocity).toFixed(4) <= 0.015) {
this._flicking = false;
this._killTimer(!(this._pastYEdge || this._pastXEdge));
if(scrollsVertical) {
if(newY < minY) {
this._snapToEdge = true;
this.set(SCROLL_Y, minY);
} else if(newY > maxY) {
this._snapToEdge = true;
this.set(SCROLL_Y, maxY);
}
}
if(scrollsHorizontal) {
if(newX < minX) {
this._snapToEdge = true;
this.set(SCROLL_X, minX);
} else if(newX > maxX) {
this._snapToEdge = true;
this.set(SCROLL_X, maxX);
}
}
return;
}
if (scrollsVertical) {
if (newY < minY || newY > maxY) {
this._pastYEdge = true;
this._currentVelocity *= bounce;
}
this.set(SCROLL_Y, newY);
}
if (scrollsHorizontal) {
if (newX < minX || newX > maxX) {
this._pastXEdge = true;
this._currentVelocity *= bounce;
}
this.set(SCROLL_X, newX);
}
if (!this._flickTimer) {
this._flickTimer = Y.later(step, this, '_flickFrame', null, true);
}
},
/**
* Stop the animation timer
*
* @method _killTimer
* @param fireEvent {Boolean} If true, fire the scrollEnd event
* @private
*/
_killTimer: function(fireEvent) {
if(this._flickTimer) {
this._flickTimer.cancel();
this._flickTimer = null;
}
if(fireEvent) {
this.fire(EV_SCROLL_END);
}
},
/**
* @method _setScroll
* @private
* @param {Number} val
* @param {String} dim
*/
_setScroll : function(val, dim) {
var bouncing = this._cachedBounce || this.get(BOUNCE),
range = ScrollView.BOUNCE_RANGE,
maxScroll = (dim == DIM_X) ? this._maxScrollX : this._maxScrollY,
min = bouncing ? -range : 0,
max = bouncing ? maxScroll + range : maxScroll;
if(!bouncing || !this._isDragging) {
if(val < min) {
val = min;
} else if(val > max) {
val = max;
}
}
return val;
},
/**
* Setter for the scrollX ATTR
*
* @method _setScrollX
* @param val {Number} The new scrollX value
* @protected
*/
_setScrollX: function(val) {
return this._setScroll(val, DIM_X);
},
/**
* Setter for the scrollY ATTR
*
* @method _setScrollY
* @param val {Number} The new scrollY value
* @protected
*/
_setScrollY: function(val) {
return this._setScroll(val, DIM_Y);
}
}, {
// Y.ScrollView static properties
/**
* The identity of the widget.
*
* @property ScrollView.NAME
* @type String
* @default 'scrollview'
* @readOnly
* @protected
* @static
*/
NAME: 'scrollview',
/**
* Static property used to define the default attribute configuration of
* the Widget.
*
* @property ScrollView.ATTRS
* @type {Object}
* @protected
* @static
*/
ATTRS: {
/**
* The scroll position in the y-axis
*
* @attribute scrollY
* @type Number
* @default 0
*/
scrollY: {
value: 0,
setter: '_setScrollY'
},
/**
* The scroll position in the x-axis
*
* @attribute scrollX
* @type Number
* @default 0
*/
scrollX: {
value: 0,
setter: '_setScrollX'
},
/**
* Drag coefficent for inertial scrolling. The closer to 1 this
* value is, the less friction during scrolling.
*
* @attribute deceleration
* @default 0.93
*/
deceleration: {
value: 0.93
},
/**
* Drag coefficient for intertial scrolling at the upper
* and lower boundaries of the scrollview. Set to 0 to
* disable "rubber-banding".
*
* @attribute bounce
* @type Number
* @default 0.1
*/
bounce: {
value: 0.1
},
/**
* The minimum distance and/or velocity which define a flick
*
* @attribute flick
* @type Object
* @default Object with properties minDistance = 10, minVelocity = 0.3.
*/
flick: {
value: {
minDistance: 10,
minVelocity: 0.3
}
}
},
/**
* List of class names used in the scrollview's DOM
*
* @property ScrollView.CLASS_NAMES
* @type Object
* @static
*/
CLASS_NAMES: CLASS_NAMES,
/**
* Flag used to source property changes initiated from the DOM
*
* @property ScrollView.UI_SRC
* @type String
* @static
* @default "ui"
*/
UI_SRC: UI,
/**
* The default bounce distance in pixels
*
* @property ScrollView.BOUNCE_RANGE
* @type Number
* @static
* @default 150
*/
BOUNCE_RANGE : 150,
/**
* The step amount used when animating the flick
*
* @property ScrollView.FRAME_STEP
* @type Number
* @static
* @default 30
*/
FRAME_STEP : 30,
/**
* The default easing used when animating the flick
*
* @property ScrollView.EASING
* @type String
* @static
* @default 'cubic-bezier(0, 0.1, 0, 1.0)'
*/
EASING : 'cubic-bezier(0, 0.1, 0, 1.0)',
/**
* The default easing to use when animatiing the bounce snap back.
*
* @property ScrollView.SNAP_EASING
* @type String
* @static
* @default 'ease-out'
*/
SNAP_EASING : 'ease-out'
});
}, '@VERSION@' ,{skinnable:true, requires:['widget', 'event-gestures', 'transition']});