/**
* @license
* Copyright The Closure Library Authors.
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @fileoverview Implementation of a basic slider control.
*
* Models a control that allows to select a sub-range within a given
* range of values using two thumbs. The underlying range is modeled
* as a range model, where the min thumb points to value of the
* rangemodel, and the max thumb points to value + extent of the range
* model.
*
* The currently selected range is exposed through methods
* getValue() and getExtent().
*
* The reason for modelling the basic slider state as value + extent is
* to be able to capture both, a two-thumb slider to select a range, and
* a single-thumb slider to just select a value (in the latter case, extent
* is always zero). We provide subclasses (twothumbslider.js and slider.js)
* that model those special cases of this control.
*
* All rendering logic is left out, so that the subclasses can define
* their own rendering. To do so, the subclasses overwrite:
* - createDom
* - decorateInternal
* - getCssClass
*/
goog.provide('goog.ui.SliderBase');
goog.provide('goog.ui.SliderBase.AnimationFactory');
goog.provide('goog.ui.SliderBase.Orientation');
goog.require('goog.Timer');
goog.require('goog.a11y.aria');
goog.require('goog.a11y.aria.Role');
goog.require('goog.a11y.aria.State');
goog.require('goog.asserts');
goog.require('goog.disposeAll');
goog.require('goog.dom');
goog.require('goog.dom.TagName');
goog.require('goog.dom.classlist');
goog.require('goog.events');
goog.require('goog.events.EventType');
goog.require('goog.events.KeyCodes');
goog.require('goog.events.KeyHandler');
goog.require('goog.events.MouseWheelHandler');
goog.require('goog.functions');
goog.require('goog.fx.AnimationParallelQueue');
goog.require('goog.fx.Dragger');
goog.require('goog.fx.Transition');
goog.require('goog.fx.dom.ResizeHeight');
goog.require('goog.fx.dom.ResizeWidth');
goog.require('goog.fx.dom.Slide');
goog.require('goog.math');
goog.require('goog.math.Coordinate');
goog.require('goog.style');
goog.require('goog.style.bidi');
goog.require('goog.ui.Component');
goog.require('goog.ui.RangeModel');
goog.requireType('goog.events.Event');
goog.requireType('goog.events.KeyEvent');
goog.requireType('goog.events.MouseWheelEvent');
goog.requireType('goog.fx.AnimationEvent');
goog.requireType('goog.fx.DragEvent');
goog.requireType('goog.fx.TransitionBase');
/**
* This creates a SliderBase object.
* @param {goog.dom.DomHelper=} opt_domHelper Optional DOM helper.
* @param {(function(number):?string)=} opt_labelFn An optional function mapping
* slider values to a description of the value.
* @constructor
* @extends {goog.ui.Component}
*/
goog.ui.SliderBase = function(opt_domHelper, opt_labelFn) {
'use strict';
goog.ui.Component.call(this, opt_domHelper);
/**
* The factory to use to generate additional animations when animating to a
* new value.
* @type {?goog.ui.SliderBase.AnimationFactory}
* @private
*/
this.additionalAnimations_ = null;
/**
* The model for the range of the slider.
* @protected {!goog.ui.RangeModel}
*/
this.rangeModel = new goog.ui.RangeModel();
/**
* A function mapping slider values to text description.
* @private {function(number):?string}
*/
this.labelFn_ = opt_labelFn || goog.functions.NULL;
/**
* Whether to move the focus to the top level element when dragging the
* slider, default true.
* @private {boolean}
*/
this.focusElementOnSliderDrag_ = true;
// Don't use getHandler because it gets cleared in exitDocument.
goog.events.listen(
this.rangeModel, goog.ui.Component.EventType.CHANGE,
this.handleRangeModelChange, false, this);
};
goog.inherits(goog.ui.SliderBase, goog.ui.Component);
/**
* Event types used to listen for dragging events. Note that extent drag events
* are also sent for single-thumb sliders, since the one thumb controls both
* value and extent together; in this case, they can simply be ignored.
* @enum {string}
*/
goog.ui.SliderBase.EventType = {
/** User started dragging the value thumb */
DRAG_VALUE_START: goog.events.getUniqueId('dragvaluestart'),
/** User is done dragging the value thumb */
DRAG_VALUE_END: goog.events.getUniqueId('dragvalueend'),
/** User started dragging the extent thumb */
DRAG_EXTENT_START: goog.events.getUniqueId('dragextentstart'),
/** User is done dragging the extent thumb */
DRAG_EXTENT_END: goog.events.getUniqueId('dragextentend'),
// Note that the following two events are sent twice, once for the value
// dragger, and once of the extent dragger. If you need to differentiate
// between the two, or if your code relies on receiving a single event per
// START/END event, it should listen to one of the VALUE/EXTENT-specific
// events.
/** User started dragging a thumb */
DRAG_START: goog.events.getUniqueId('dragstart'),
/** User is done dragging a thumb */
DRAG_END: goog.events.getUniqueId('dragend'),
/** Animation on the value thumb ends */
ANIMATION_END: goog.events.getUniqueId('animationend')
};
/**
* Enum for representing the orientation of the slider.
*
* @enum {string}
*/
goog.ui.SliderBase.Orientation = {
VERTICAL: 'vertical',
HORIZONTAL: 'horizontal'
};
/**
* Orientation of the slider.
* @type {goog.ui.SliderBase.Orientation}
* @private
*/
goog.ui.SliderBase.prototype.orientation_ =
goog.ui.SliderBase.Orientation.HORIZONTAL;
/** @private {goog.fx.AnimationParallelQueue} */
goog.ui.SliderBase.prototype.currentAnimation_;
/** @private {!goog.Timer} */
goog.ui.SliderBase.prototype.incTimer_;
/** @private {boolean} */
goog.ui.SliderBase.prototype.incrementing_;
/** @private {number} */
goog.ui.SliderBase.prototype.lastMousePosition_;
/**
* When the user holds down the mouse on the slider background, the closest
* thumb will move in "lock-step" towards the mouse. This number indicates how
* long each step should take (in milliseconds).
* @type {number}
* @private
*/
goog.ui.SliderBase.MOUSE_DOWN_INCREMENT_INTERVAL_ = 200;
/**
* How long the animations should take (in milliseconds).
* @type {number}
* @private
*/
goog.ui.SliderBase.ANIMATION_INTERVAL_ = 100;
/**
* The minThumb dom-element, pointing to the start of the selected range.
* @type {HTMLDivElement}
* @protected
*/
goog.ui.SliderBase.prototype.valueThumb;
/**
* The maxThumb dom-element, pointing to the end of the selected range.
* @type {HTMLDivElement}
* @protected
*/
goog.ui.SliderBase.prototype.extentThumb;
/**
* The dom-element highlighting the selected range.
* @type {HTMLDivElement}
* @protected
*/
goog.ui.SliderBase.prototype.rangeHighlight;
/**
* The thumb that we should be moving (only relevant when timed move is active).
* @type {HTMLDivElement}
* @private
*/
goog.ui.SliderBase.prototype.thumbToMove_;
/**
* The object handling keyboard events.
* @type {goog.events.KeyHandler}
* @private
*/
goog.ui.SliderBase.prototype.keyHandler_;
/**
* The object handling mouse wheel events.
* @type {goog.events.MouseWheelHandler}
* @private
*/
goog.ui.SliderBase.prototype.mouseWheelHandler_;
/**
* The Dragger for dragging the valueThumb.
* @type {goog.fx.Dragger}
* @private
*/
goog.ui.SliderBase.prototype.valueDragger_;
/**
* The Dragger for dragging the extentThumb.
* @type {goog.fx.Dragger}
* @private
*/
goog.ui.SliderBase.prototype.extentDragger_;
/**
* If we are currently animating the thumb.
* @private
* @type {boolean}
*/
goog.ui.SliderBase.prototype.isAnimating_ = false;
/**
* Whether clicking on the backgtround should move directly to that point.
* @private
* @type {boolean}
*/
goog.ui.SliderBase.prototype.moveToPointEnabled_ = false;
/**
* The amount to increment/decrement for page up/down as well as when holding
* down the mouse button on the background.
* @private
* @type {number}
*/
goog.ui.SliderBase.prototype.blockIncrement_ = 10;
/**
* The minimal extent. The class will ensure that the extent cannot shrink
* to a value smaller than minExtent.
* @private
* @type {number}
*/
goog.ui.SliderBase.prototype.minExtent_ = 0;
/**
* Whether the slider should handle mouse wheel events.
* @private
* @type {boolean}
*/
goog.ui.SliderBase.prototype.isHandleMouseWheel_ = true;
/**
* The time the last mousedown event was received.
* @private
* @type {number}
*/
goog.ui.SliderBase.prototype.mouseDownTime_ = 0;
/**
* The delay after mouseDownTime_ during which a click event is ignored.
* @private
* @type {number}
* @const
*/
goog.ui.SliderBase.prototype.MOUSE_DOWN_DELAY_ = 1000;
/**
* Whether the slider is enabled or not.
* @private
* @type {boolean}
*/
goog.ui.SliderBase.prototype.enabled_ = true;
/**
* Whether the slider implements the changes described in http://b/6324964,
* making it truly RTL. This is a temporary flag to allow clients to transition
* to the new behavior at their convenience. At some point it will be the
* default.
* @type {boolean}
* @private
*/
goog.ui.SliderBase.prototype.flipForRtl_ = false;
/**
* Enables/disables true RTL behavior. This should be called immediately after
* construction. This is a temporary flag to allow clients to transition
* to the new behavior at their convenience. At some point it will be the
* default.
* @param {boolean} flipForRtl True if the slider should be flipped for RTL,
* false otherwise.
*/
goog.ui.SliderBase.prototype.enableFlipForRtl = function(flipForRtl) {
'use strict';
this.flipForRtl_ = flipForRtl;
};
// TODO: Make this return a base CSS class (without orientation), in subclasses.
/**
* Returns the CSS class applied to the slider element for the given
* orientation. Subclasses must override this method.
* @param {goog.ui.SliderBase.Orientation} orient The orientation.
* @return {string} The CSS class applied to slider elements.
* @protected
*/
goog.ui.SliderBase.prototype.getCssClass = goog.abstractMethod;
/** @override */
goog.ui.SliderBase.prototype.createDom = function() {
'use strict';
goog.ui.SliderBase.superClass_.createDom.call(this);
var element = this.getDomHelper().createDom(
goog.dom.TagName.DIV, this.getCssClass(this.orientation_));
this.decorateInternal(element);
};
/**
* Subclasses must implement this method and set the valueThumb and
* extentThumb to non-null values. They can also set the rangeHighlight
* element if a range highlight is desired.
* @type {function() : void}
* @protected
*/
goog.ui.SliderBase.prototype.createThumbs = goog.abstractMethod;
/**
* CSS class name applied to the slider while its thumbs are being dragged.
* @type {string}
* @private
*/
goog.ui.SliderBase.SLIDER_DRAGGING_CSS_CLASS_ =
goog.getCssName('goog-slider-dragging');
/**
* CSS class name applied to a thumb while it's being dragged.
* @type {string}
* @private
*/
goog.ui.SliderBase.THUMB_DRAGGING_CSS_CLASS_ =
goog.getCssName('goog-slider-thumb-dragging');
/**
* CSS class name applied when the slider is disabled.
* @type {string}
* @private
*/
goog.ui.SliderBase.DISABLED_CSS_CLASS_ =
goog.getCssName('goog-slider-disabled');
/** @override */
goog.ui.SliderBase.prototype.decorateInternal = function(element) {
'use strict';
goog.ui.SliderBase.superClass_.decorateInternal.call(this, element);
goog.asserts.assert(element);
goog.dom.classlist.add(element, this.getCssClass(this.orientation_));
this.createThumbs();
this.setAriaRoles();
};
/**
* Called when the DOM for the component is for sure in the document.
* Subclasses should override this method to set this element's role.
* @override
* @suppress {strictMissingProperties} Part of the go/strict_warnings_migration
*/
goog.ui.SliderBase.prototype.enterDocument = function() {
'use strict';
goog.ui.SliderBase.superClass_.enterDocument.call(this);
// Attach the events
this.valueDragger_ = new goog.fx.Dragger(this.valueThumb);
this.extentDragger_ = new goog.fx.Dragger(this.extentThumb);
this.valueDragger_.enableRightPositioningForRtl(this.flipForRtl_);
this.extentDragger_.enableRightPositioningForRtl(this.flipForRtl_);
// The slider is handling the positioning so make the defaultActions empty.
this.valueDragger_.defaultAction = this.extentDragger_.defaultAction =
goog.nullFunction;
this.keyHandler_ = new goog.events.KeyHandler(this.getElement());
this.enableEventHandlers_(true);
this.getElement().tabIndex = 0;
this.updateUi_();
};
/**
* Attaches/Detaches the event handlers on the slider.
* @param {boolean} enable Whether to attach or detach the event handlers.
* @private
*/
goog.ui.SliderBase.prototype.enableEventHandlers_ = function(enable) {
'use strict';
if (enable) {
this.getHandler()
.listen(
this.valueDragger_, goog.fx.Dragger.EventType.BEFOREDRAG,
this.handleBeforeDrag_)
.listen(
this.extentDragger_, goog.fx.Dragger.EventType.BEFOREDRAG,
this.handleBeforeDrag_)
.listen(
this.valueDragger_,
[goog.fx.Dragger.EventType.START, goog.fx.Dragger.EventType.END],
this.handleThumbDragStartEnd_)
.listen(
this.extentDragger_,
[goog.fx.Dragger.EventType.START, goog.fx.Dragger.EventType.END],
this.handleThumbDragStartEnd_)
.listen(
this.keyHandler_, goog.events.KeyHandler.EventType.KEY,
this.handleKeyDown_)
.listen(
this.getElement(), goog.events.EventType.CLICK,
this.handleMouseDownAndClick_)
.listen(
this.getElement(), goog.events.EventType.MOUSEDOWN,
this.handleMouseDownAndClick_);
if (this.isHandleMouseWheel()) {
this.enableMouseWheelHandling_(true);
}
} else {
this.getHandler()
.unlisten(
this.valueDragger_, goog.fx.Dragger.EventType.BEFOREDRAG,
this.handleBeforeDrag_)
.unlisten(
this.extentDragger_, goog.fx.Dragger.EventType.BEFOREDRAG,
this.handleBeforeDrag_)
.unlisten(
this.valueDragger_,
[goog.fx.Dragger.EventType.START, goog.fx.Dragger.EventType.END],
this.handleThumbDragStartEnd_)
.unlisten(
this.extentDragger_,
[goog.fx.Dragger.EventType.START, goog.fx.Dragger.EventType.END],
this.handleThumbDragStartEnd_)
.unlisten(
this.keyHandler_, goog.events.KeyHandler.EventType.KEY,
this.handleKeyDown_)
.unlisten(
this.getElement(), goog.events.EventType.CLICK,
this.handleMouseDownAndClick_)
.unlisten(
this.getElement(), goog.events.EventType.MOUSEDOWN,
this.handleMouseDownAndClick_);
if (this.isHandleMouseWheel()) {
this.enableMouseWheelHandling_(false);
}
}
};
/** @override */
goog.ui.SliderBase.prototype.exitDocument = function() {
'use strict';
goog.ui.SliderBase.base(this, 'exitDocument');
goog.disposeAll(
this.valueDragger_, this.extentDragger_, this.keyHandler_,
this.mouseWheelHandler_);
};
/**
* Handler for the before drag event. We use the event properties to determine
* the new value.
* @param {goog.fx.DragEvent} e The drag event used to drag the thumb.
* @private
*/
goog.ui.SliderBase.prototype.handleBeforeDrag_ = function(e) {
'use strict';
var thumbToDrag =
e.dragger == this.valueDragger_ ? this.valueThumb : this.extentThumb;
var value;
if (this.orientation_ == goog.ui.SliderBase.Orientation.VERTICAL) {
var availHeight = this.getElement().clientHeight - thumbToDrag.offsetHeight;
value = (availHeight - e.top) / availHeight *
(this.getMaximum() - this.getMinimum()) +
this.getMinimum();
} else {
var availWidth = this.getElement().clientWidth - thumbToDrag.offsetWidth;
value = (e.left / availWidth) * (this.getMaximum() - this.getMinimum()) +
this.getMinimum();
}
// Bind the value within valid range before calling setThumbPosition_.
// This is necessary because setThumbPosition_ is a no-op for values outside
// of the legal range. For drag operations, we want the handle to snap to the
// last valid value instead of remaining at the previous position.
if (e.dragger == this.valueDragger_) {
value = Math.min(
Math.max(value, this.getMinimum()), this.getValue() + this.getExtent());
} else {
value = Math.min(Math.max(value, this.getValue()), this.getMaximum());
}
this.setThumbPosition_(thumbToDrag, value);
};
/**
* Handler for the start/end drag event on the thumbs. Adds/removes
* the "-dragging" CSS classes on the slider and thumb.
* @param {goog.fx.DragEvent} e The drag event used to drag the thumb.
* @private
* @suppress {strictMissingProperties} Part of the go/strict_warnings_migration
*/
goog.ui.SliderBase.prototype.handleThumbDragStartEnd_ = function(e) {
'use strict';
var isDragStart = e.type == goog.fx.Dragger.EventType.START;
goog.dom.classlist.enable(
goog.asserts.assertElement(this.getElement()),
goog.ui.SliderBase.SLIDER_DRAGGING_CSS_CLASS_, isDragStart);
goog.dom.classlist.enable(
goog.asserts.assertElement(e.target.handle),
goog.ui.SliderBase.THUMB_DRAGGING_CSS_CLASS_, isDragStart);
var isValueDragger = e.dragger == this.valueDragger_;
if (isDragStart) {
this.dispatchEvent(goog.ui.SliderBase.EventType.DRAG_START);
this.dispatchEvent(
isValueDragger ? goog.ui.SliderBase.EventType.DRAG_VALUE_START :
goog.ui.SliderBase.EventType.DRAG_EXTENT_START);
} else {
this.dispatchEvent(goog.ui.SliderBase.EventType.DRAG_END);
this.dispatchEvent(
isValueDragger ? goog.ui.SliderBase.EventType.DRAG_VALUE_END :
goog.ui.SliderBase.EventType.DRAG_EXTENT_END);
}
};
/**
* Event handler for the key down event. This is used to update the value
* based on the key pressed.
* @param {goog.events.KeyEvent} e The keyboard event object.
* @private
*/
goog.ui.SliderBase.prototype.handleKeyDown_ = function(e) {
'use strict';
var handled = true;
switch (e.keyCode) {
case goog.events.KeyCodes.HOME:
this.animatedSetValue(this.getMinimum());
break;
case goog.events.KeyCodes.END:
this.animatedSetValue(this.getMaximum());
break;
case goog.events.KeyCodes.PAGE_UP:
this.moveThumbs(this.getBlockIncrement());
break;
case goog.events.KeyCodes.PAGE_DOWN:
this.moveThumbs(-this.getBlockIncrement());
break;
case goog.events.KeyCodes.LEFT:
var sign = this.flipForRtl_ && this.isRightToLeft() ? 1 : -1;
this.moveThumbs(
e.shiftKey ? sign * this.getBlockIncrement() :
sign * this.getUnitIncrement());
break;
case goog.events.KeyCodes.DOWN:
this.moveThumbs(
e.shiftKey ? -this.getBlockIncrement() : -this.getUnitIncrement());
break;
case goog.events.KeyCodes.RIGHT:
var sign = this.flipForRtl_ && this.isRightToLeft() ? -1 : 1;
this.moveThumbs(
e.shiftKey ? sign * this.getBlockIncrement() :
sign * this.getUnitIncrement());
break;
case goog.events.KeyCodes.UP:
this.moveThumbs(
e.shiftKey ? this.getBlockIncrement() : this.getUnitIncrement());
break;
default:
handled = false;
}
if (handled) {
e.preventDefault();
}
};
/**
* Handler for the mouse down event and click event.
* @param {goog.events.Event} e The mouse event object.
* @private
*/
goog.ui.SliderBase.prototype.handleMouseDownAndClick_ = function(e) {
'use strict';
if (this.focusElementOnSliderDrag_ && this.getElement().focus) {
this.getElement().focus();
}
// Known Element.
var target = /** @type {Element} */ (e.target);
if (!goog.dom.contains(this.valueThumb, target) &&
!goog.dom.contains(this.extentThumb, target)) {
var isClick = e.type == goog.events.EventType.CLICK;
if (isClick && Date.now() < this.mouseDownTime_ + this.MOUSE_DOWN_DELAY_) {
// Ignore a click event that comes a short moment after a mousedown
// event. This happens for desktop. For devices with both a touch
// screen and a mouse pad we do not get a mousedown event from the mouse
// pad and do get a click event.
return;
}
if (!isClick) {
this.mouseDownTime_ = Date.now();
}
if (this.moveToPointEnabled_) {
// just set the value directly based on the position of the click
this.animatedSetValue(this.getValueFromMousePosition(e));
} else {
// start a timer that incrementally moves the handle
this.startBlockIncrementing_(e);
}
}
};
/**
* Handler for the mouse wheel event.
* @param {goog.events.MouseWheelEvent} e The mouse wheel event object.
* @private
*/
goog.ui.SliderBase.prototype.handleMouseWheel_ = function(e) {
'use strict';
// Just move one unit increment per mouse wheel event
var direction = e.detail > 0 ? -1 : 1;
this.moveThumbs(direction * this.getUnitIncrement());
e.preventDefault();
};
/**
* Starts the animation that causes the thumb to increment/decrement by the
* block increment when the user presses down on the background.
* @param {goog.events.Event} e The mouse event object.
* @private
*/
goog.ui.SliderBase.prototype.startBlockIncrementing_ = function(e) {
'use strict';
this.storeMousePos_(e);
this.thumbToMove_ = this.getClosestThumb_(this.getValueFromMousePosition(e));
if (this.orientation_ == goog.ui.SliderBase.Orientation.VERTICAL) {
this.incrementing_ = this.lastMousePosition_ < this.thumbToMove_.offsetTop;
} else {
this.incrementing_ = this.lastMousePosition_ >
this.getOffsetStart_(this.thumbToMove_) + this.thumbToMove_.offsetWidth;
}
var doc = goog.dom.getOwnerDocument(this.getElement());
this.getHandler()
.listen(
doc, goog.events.EventType.MOUSEUP, this.stopBlockIncrementing_, true)
.listen(
this.getElement(), goog.events.EventType.MOUSEMOVE,
this.storeMousePos_);
if (!this.incTimer_) {
this.incTimer_ =
new goog.Timer(goog.ui.SliderBase.MOUSE_DOWN_INCREMENT_INTERVAL_);
this.getHandler().listen(
this.incTimer_, goog.Timer.TICK, this.handleTimerTick_);
}
this.handleTimerTick_();
this.incTimer_.start();
};
/**
* Handler for the tick event dispatched by the timer used to update the value
* in a block increment. This is also called directly from
* startBlockIncrementing_.
* @private
*/
goog.ui.SliderBase.prototype.handleTimerTick_ = function() {
'use strict';
var value;
if (this.orientation_ == goog.ui.SliderBase.Orientation.VERTICAL) {
var mouseY = this.lastMousePosition_;
var thumbY = this.thumbToMove_.offsetTop;
if (this.incrementing_) {
if (mouseY < thumbY) {
value = this.getThumbPosition_(this.thumbToMove_) +
this.getBlockIncrement();
}
} else {
var thumbH = this.thumbToMove_.offsetHeight;
if (mouseY > thumbY + thumbH) {
value = this.getThumbPosition_(this.thumbToMove_) -
this.getBlockIncrement();
}
}
} else {
var mouseX = this.lastMousePosition_;
var thumbX = this.getOffsetStart_(this.thumbToMove_);
if (this.incrementing_) {
var thumbW = this.thumbToMove_.offsetWidth;
if (mouseX > thumbX + thumbW) {
value = this.getThumbPosition_(this.thumbToMove_) +
this.getBlockIncrement();
}
} else {
if (mouseX < thumbX) {
value = this.getThumbPosition_(this.thumbToMove_) -
this.getBlockIncrement();
}
}
}
if (value !== undefined) { // not all code paths sets the value variable
this.setThumbPosition_(this.thumbToMove_, value);
}
};
/**
* Stops the block incrementing animation and unlistens the necessary
* event handlers.
* @private
*/
goog.ui.SliderBase.prototype.stopBlockIncrementing_ = function() {
'use strict';
if (this.incTimer_) {
this.incTimer_.stop();
}
var doc = goog.dom.getOwnerDocument(this.getElement());
this.getHandler()
.unlisten(
doc, goog.events.EventType.MOUSEUP, this.stopBlockIncrementing_, true)
.unlisten(
this.getElement(), goog.events.EventType.MOUSEMOVE,
this.storeMousePos_);
};
/**
* Returns the relative mouse position to the slider.
* @param {goog.events.Event} e The mouse event object.
* @return {number} The relative mouse position to the slider.
* @private
*/
goog.ui.SliderBase.prototype.getRelativeMousePos_ = function(e) {
'use strict';
var coord = goog.style.getRelativePosition(e, this.getElement());
if (this.orientation_ == goog.ui.SliderBase.Orientation.VERTICAL) {
return coord.y;
} else {
if (this.flipForRtl_ && this.isRightToLeft()) {
return this.getElement().clientWidth - coord.x;
} else {
return coord.x;
}
}
};
/**
* Stores the current mouse position so that it can be used in the timer.
* @param {goog.events.Event} e The mouse event object.
* @private
*/
goog.ui.SliderBase.prototype.storeMousePos_ = function(e) {
'use strict';
this.lastMousePosition_ = this.getRelativeMousePos_(e);
};
/**
* Returns the value to use for the current mouse position
* @param {goog.events.Event} e The mouse event object.
* @return {number} The value that this mouse position represents.
*/
goog.ui.SliderBase.prototype.getValueFromMousePosition = function(e) {
'use strict';
var min = this.getMinimum();
var max = this.getMaximum();
if (this.orientation_ == goog.ui.SliderBase.Orientation.VERTICAL) {
var thumbH = this.valueThumb.offsetHeight;
var availH = this.getElement().clientHeight - thumbH;
var y = this.getRelativeMousePos_(e) - thumbH / 2;
return (max - min) * (availH - y) / availH + min;
} else {
var thumbW = this.valueThumb.offsetWidth;
var availW = this.getElement().clientWidth - thumbW;
var x = this.getRelativeMousePos_(e) - thumbW / 2;
return (max - min) * x / availW + min;
}
};
/**
* @param {HTMLDivElement} thumb The thumb object.
* @return {number} The position of the specified thumb.
* @private
*/
goog.ui.SliderBase.prototype.getThumbPosition_ = function(thumb) {
'use strict';
if (thumb == this.valueThumb) {
return this.rangeModel.getValue();
} else if (thumb == this.extentThumb) {
return this.rangeModel.getValue() + this.rangeModel.getExtent();
} else {
throw new Error('Illegal thumb element. Neither minThumb nor maxThumb');
}
};
/**
* Returns whether a thumb is currently being dragged with the mouse (or via
* touch). Note that changing the value with keyboard, mouswheel, or via
* move-to-point click immediately sends a CHANGE event without going through a
* dragged state.
* @return {boolean} Whether a dragger is currently being dragged.
*/
goog.ui.SliderBase.prototype.isDragging = function() {
'use strict';
return this.valueDragger_.isDragging() || this.extentDragger_.isDragging();
};
/**
* Moves the thumbs by the specified delta as follows
* - as long as both thumbs stay within [min,max], both thumbs are moved
* - once a thumb reaches or exceeds min (or max, respectively), it stays
* - at min (or max, respectively).
* In case both thumbs have reached min (or max), no change event will fire.
* If the specified delta is smaller than the step size, it will be rounded
* to the step size.
* @param {number} delta The delta by which to move the selected range.
* @suppress {strictPrimitiveOperators} Part of the go/strict_warnings_migration
*/
goog.ui.SliderBase.prototype.moveThumbs = function(delta) {
'use strict';
// Assume that a small delta is supposed to be at least a step.
if (Math.abs(delta) < this.getStep()) {
delta = goog.math.sign(delta) * this.getStep();
}
var newMinPos = this.getThumbPosition_(this.valueThumb) + delta;
var newMaxPos = this.getThumbPosition_(this.extentThumb) + delta;
// correct min / max positions to be within bounds
newMinPos = goog.math.clamp(
newMinPos, this.getMinimum(), this.getMaximum() - this.minExtent_);
newMaxPos = goog.math.clamp(
newMaxPos, this.getMinimum() + this.minExtent_, this.getMaximum());
// Set value and extent atomically
this.setValueAndExtent(newMinPos, newMaxPos - newMinPos);
};
/**
* Sets the position of the given thumb. The set is ignored and no CHANGE event
* fires if it violates the constraint minimum <= value (valueThumb position) <=
* value + extent (extentThumb position) <= maximum.
*
* Note: To keep things simple, the setThumbPosition_ function does not have the
* side-effect of "correcting" value or extent to fit the above constraint as it
* is the case in the underlying range model. Instead, we simply ignore the
* call. Callers must make these adjustements explicitly if they wish.
* @param {Element} thumb The thumb whose position to set.
* @param {number} position The position to move the thumb to.
* @private
*/
goog.ui.SliderBase.prototype.setThumbPosition_ = function(thumb, position) {
'use strict';
// Round first so that all computations and checks are consistent.
var roundedPosition = this.rangeModel.roundToStepWithMin(position);
var value =
thumb == this.valueThumb ? roundedPosition : this.rangeModel.getValue();
var end = thumb == this.extentThumb ?
roundedPosition :
this.rangeModel.getValue() + this.rangeModel.getExtent();
if (value >= this.getMinimum() && end >= value + this.minExtent_ &&
this.getMaximum() >= end) {
this.setValueAndExtent(value, end - value);
}
};
/**
* Sets the value and extent of the underlying range model. We enforce that
* getMinimum() <= value <= getMaximum() - extent and
* getMinExtent <= extent <= getMaximum() - getValue()
* If this is not satisfied for the given extent, the call is ignored and no
* CHANGE event fires. This is a utility method to allow setting the thumbs
* simultaneously and ensuring that only one event fires.
* @param {number} value The value to which to set the value.
* @param {number} extent The value to which to set the extent.
*/
goog.ui.SliderBase.prototype.setValueAndExtent = function(value, extent) {
'use strict';
if (this.getMinimum() <= value && value <= this.getMaximum() - extent &&
this.minExtent_ <= extent && extent <= this.getMaximum() - value) {
if (value == this.getValue() && extent == this.getExtent()) {
return;
}
// because the underlying range model applies adjustements of value
// and extent to fit within bounds, we need to reset the extent
// first so these adjustements don't kick in.
this.rangeModel.setMute(true);
this.rangeModel.setExtent(0);
this.rangeModel.setValue(value);
this.rangeModel.setExtent(extent);
this.rangeModel.setMute(false);
this.handleRangeModelChange(null);
}
};
/**
* @return {number} The minimum value.
*/
goog.ui.SliderBase.prototype.getMinimum = function() {
'use strict';
return this.rangeModel.getMinimum();
};
/**
* Sets the minimum number.
* @param {number} min The minimum value.
*/
goog.ui.SliderBase.prototype.setMinimum = function(min) {
'use strict';
this.rangeModel.setMinimum(min);
};
/**
* @return {number} The maximum value.
*/
goog.ui.SliderBase.prototype.getMaximum = function() {
'use strict';
return this.rangeModel.getMaximum();
};
/**
* Sets the maximum number.
* @param {number} max The maximum value.
*/
goog.ui.SliderBase.prototype.setMaximum = function(max) {
'use strict';
this.rangeModel.setMaximum(max);
};
/**
* @return {HTMLDivElement} The value thumb element.
*/
goog.ui.SliderBase.prototype.getValueThumb = function() {
'use strict';
return this.valueThumb;
};
/**
* @return {HTMLDivElement} The extent thumb element.
*/
goog.ui.SliderBase.prototype.getExtentThumb = function() {
'use strict';
return this.extentThumb;
};
/**
* @param {number} position The position to get the closest thumb to.
* @return {HTMLDivElement} The thumb that is closest to the given position.
* @private
*/
goog.ui.SliderBase.prototype.getClosestThumb_ = function(position) {
'use strict';
if (position <=
(this.rangeModel.getValue() + this.rangeModel.getExtent() / 2)) {
return this.valueThumb;
} else {
return this.extentThumb;
}
};
/**
* Call back when the internal range model changes. Sub-classes may override
* and re-enter this method to update a11y state. Consider protected.
* @param {goog.events.Event} e The event object.
* @protected
*/
goog.ui.SliderBase.prototype.handleRangeModelChange = function(e) {
'use strict';
this.updateUi_();
this.updateAriaStates();
this.dispatchEvent(goog.ui.Component.EventType.CHANGE);
};
/**
* This is called when we need to update the size of the thumb. This happens
* when first created as well as when the value and the orientation changes.
* @private
*/
goog.ui.SliderBase.prototype.updateUi_ = function() {
'use strict';
if (this.valueThumb && !this.isAnimating_) {
var minCoord = this.getThumbCoordinateForValue(
this.getThumbPosition_(this.valueThumb));
var maxCoord = this.getThumbCoordinateForValue(
this.getThumbPosition_(this.extentThumb));
if (this.orientation_ == goog.ui.SliderBase.Orientation.VERTICAL) {
this.valueThumb.style.top = minCoord.y + 'px';
this.extentThumb.style.top = maxCoord.y + 'px';
if (this.rangeHighlight) {
var highlightPositioning = this.calculateRangeHighlightPositioning_(
maxCoord.y, minCoord.y, this.valueThumb.offsetHeight);
this.rangeHighlight.style.top = highlightPositioning.offset + 'px';
this.rangeHighlight.style.height = highlightPositioning.size + 'px';
}
} else {
var pos = (this.flipForRtl_ && this.isRightToLeft()) ? 'right' : 'left';
this.valueThumb.style[pos] = minCoord.x + 'px';
this.extentThumb.style[pos] = maxCoord.x + 'px';
if (this.rangeHighlight) {
var highlightPositioning = this.calculateRangeHighlightPositioning_(
minCoord.x, maxCoord.x, this.valueThumb.offsetWidth);
this.rangeHighlight.style[pos] = highlightPositioning.offset + 'px';
this.rangeHighlight.style.width = highlightPositioning.size + 'px';
}
}
}
};
/**
* Calculates the start position (offset) and size of the range highlight, e.g.
* for a horizontal slider, this will return [left, width] for the highlight.
* @param {number} firstThumbPos The position of the first thumb along the
* slider axis.
* @param {number} secondThumbPos The position of the second thumb along the
* slider axis, must be >= firstThumbPos.
* @param {number} thumbSize The size of the thumb, along the slider axis.
* @return {{offset: number, size: number}} The positioning parameters for the
* range highlight.
* @private
*/
goog.ui.SliderBase.prototype.calculateRangeHighlightPositioning_ = function(
firstThumbPos, secondThumbPos, thumbSize) {
'use strict';
// Highlight is inset by half the thumb size, from the edges of the thumb.
var highlightInset = Math.ceil(thumbSize / 2);
var size = secondThumbPos - firstThumbPos + thumbSize - 2 * highlightInset;
// Don't return negative size since it causes an error. IE sometimes attempts
// to position the thumbs while slider size is 0, resulting in size < 0 here.
return {offset: firstThumbPos + highlightInset, size: Math.max(size, 0)};
};
/**
* Returns the position to move the handle to for a given value
* @param {number} val The value to get the coordinate for.
* @return {!goog.math.Coordinate} Coordinate with either x or y set.
*/
goog.ui.SliderBase.prototype.getThumbCoordinateForValue = function(val) {
'use strict';
var coord = new goog.math.Coordinate;
if (this.valueThumb) {
var min = this.getMinimum();
var max = this.getMaximum();
// This check ensures the ratio never take NaN value, which is possible when
// the slider min & max are same numbers (i.e. 1).
var ratio = (val == min && min == max) ? 0 : (val - min) / (max - min);
if (this.orientation_ == goog.ui.SliderBase.Orientation.VERTICAL) {
var thumbHeight = this.valueThumb.offsetHeight;
var h = this.getElement().clientHeight - thumbHeight;
var bottom = Math.round(ratio * h);
if (this.moveToPointEnabled_) {
coord.x = 0;
} else {
coord.x = this.getOffsetStart_(this.valueThumb); // Keep x the same.
}
coord.y = h - bottom;
} else {
var w = this.getElement().clientWidth - this.valueThumb.offsetWidth;
var left = Math.round(ratio * w);
coord.x = left;
if (this.moveToPointEnabled_) {
coord.y = 0;
} else {
coord.y = this.valueThumb.offsetTop; // Keep y the same.
}
}
}
return coord;
};
/**
* Sets the value and starts animating the handle towards that position.
* @param {number} v Value to set and animate to.
* @suppress {strictPrimitiveOperators} Part of the go/strict_warnings_migration
*/
goog.ui.SliderBase.prototype.animatedSetValue = function(v) {
'use strict';
// the value might be out of bounds
v = goog.math.clamp(v, this.getMinimum(), this.getMaximum());
if (this.isAnimating_) {
this.currentAnimation_.stop(true);
this.currentAnimation_.dispose();
}
var animations = new goog.fx.AnimationParallelQueue();
var end;
var thumb = this.getClosestThumb_(v);
var previousValue = this.getValue();
var previousExtent = this.getExtent();
var previousThumbValue = this.getThumbPosition_(thumb);
var previousCoord = this.getThumbCoordinateForValue(previousThumbValue);
var stepSize = this.getStep();
// If the delta is less than a single step, increase it to a step, else the
// range model will reduce it to zero.
if (Math.abs(v - previousThumbValue) < stepSize) {
var delta = v > previousThumbValue ? stepSize : -stepSize;
v = previousThumbValue + delta;
// The resulting value may be out of bounds, sanitize.
v = goog.math.clamp(v, this.getMinimum(), this.getMaximum());
}
this.setThumbPosition_(thumb, v);
var coord = this.getThumbCoordinateForValue(this.getThumbPosition_(thumb));
if (this.orientation_ == goog.ui.SliderBase.Orientation.VERTICAL) {
end = [this.getOffsetStart_(thumb), coord.y];
} else {
end = [coord.x, thumb.offsetTop];
}
var slide = new goog.fx.dom.Slide(
thumb, [previousCoord.x, previousCoord.y], end,
goog.ui.SliderBase.ANIMATION_INTERVAL_);
slide.enableRightPositioningForRtl(this.flipForRtl_);
animations.add(slide);
if (this.rangeHighlight) {
this.addRangeHighlightAnimations_(
thumb, previousValue, previousExtent, coord, animations);
}
// Create additional animations to play if a factory has been set.
if (this.additionalAnimations_) {
var additionalAnimations = this.additionalAnimations_.createAnimations(
previousValue, v, goog.ui.SliderBase.ANIMATION_INTERVAL_);
additionalAnimations.forEach(function(animation) {
'use strict';
animations.add(animation);
});
}
this.currentAnimation_ = animations;
this.getHandler().listen(
animations, goog.fx.Transition.EventType.END, this.endAnimation_);
this.isAnimating_ = true;
animations.play(false);
};
/**
* @return {boolean} True if the slider is animating, false otherwise.
*/
goog.ui.SliderBase.prototype.isAnimating = function() {
'use strict';
return this.isAnimating_;
};
/**
* Sets the factory that will be used to create additional animations to be
* played when animating to a new value. These animations can be for any
* element and the animations will be played in addition to the default
* animation(s). The animations will also be played in the same parallel queue
* ensuring that all animations are played at the same time.
* @see #animatedSetValue
*
* @param {goog.ui.SliderBase.AnimationFactory} factory The animation factory to
* use. This will not change the default animations played by the slider.
* It will only allow for additional animations.
*/
goog.ui.SliderBase.prototype.setAdditionalAnimations = function(factory) {
'use strict';
this.additionalAnimations_ = factory;
};
/**
* Adds animations for the range highlight element to the animation queue.
*
* @param {Element} thumb The thumb that's moving, must be
* either valueThumb or extentThumb.
* @param {number} previousValue The previous value of the slider.
* @param {number} previousExtent The previous extent of the
* slider.
* @param {goog.math.Coordinate} newCoord The new pixel coordinate of the
* thumb that's moving.
* @param {goog.fx.AnimationParallelQueue} animations The animation queue.
* @private
*/
goog.ui.SliderBase.prototype.addRangeHighlightAnimations_ = function(
thumb, previousValue, previousExtent, newCoord, animations) {
'use strict';
var previousMinCoord = this.getThumbCoordinateForValue(previousValue);
var previousMaxCoord =
this.getThumbCoordinateForValue(previousValue + previousExtent);
var minCoord = previousMinCoord;
var maxCoord = previousMaxCoord;
if (thumb == this.valueThumb) {
minCoord = newCoord;
} else {
maxCoord = newCoord;
}
if (this.orientation_ == goog.ui.SliderBase.Orientation.VERTICAL) {
var previousHighlightPositioning = this.calculateRangeHighlightPositioning_(
previousMaxCoord.y, previousMinCoord.y, this.valueThumb.offsetHeight);
var highlightPositioning = this.calculateRangeHighlightPositioning_(
maxCoord.y, minCoord.y, this.valueThumb.offsetHeight);
var slide = new goog.fx.dom.Slide(
this.rangeHighlight,
[
this.getOffsetStart_(this.rangeHighlight),
previousHighlightPositioning.offset
],
[
this.getOffsetStart_(this.rangeHighlight), highlightPositioning.offset
],
goog.ui.SliderBase.ANIMATION_INTERVAL_);
var resizeHeight = new goog.fx.dom.ResizeHeight(
this.rangeHighlight, previousHighlightPositioning.size,
highlightPositioning.size, goog.ui.SliderBase.ANIMATION_INTERVAL_);
slide.enableRightPositioningForRtl(this.flipForRtl_);
resizeHeight.enableRightPositioningForRtl(this.flipForRtl_);
animations.add(slide);
animations.add(resizeHeight);
} else {
var previousHighlightPositioning = this.calculateRangeHighlightPositioning_(
previousMinCoord.x, previousMaxCoord.x, this.valueThumb.offsetWidth);
var highlightPositioning = this.calculateRangeHighlightPositioning_(
minCoord.x, maxCoord.x, this.valueThumb.offsetWidth);
var slide = new goog.fx.dom.Slide(
this.rangeHighlight,
[previousHighlightPositioning.offset, this.rangeHighlight.offsetTop],
[highlightPositioning.offset, this.rangeHighlight.offsetTop],
goog.ui.SliderBase.ANIMATION_INTERVAL_);
var resizeWidth = new goog.fx.dom.ResizeWidth(
this.rangeHighlight, previousHighlightPositioning.size,
highlightPositioning.size, goog.ui.SliderBase.ANIMATION_INTERVAL_);
slide.enableRightPositioningForRtl(this.flipForRtl_);
resizeWidth.enableRightPositioningForRtl(this.flipForRtl_);
animations.add(slide);
animations.add(resizeWidth);
}
};
/**
* Sets the isAnimating_ field to false once the animation is done.
* @param {goog.fx.AnimationEvent} e Event object passed by the animation
* object.
* @private
*/
goog.ui.SliderBase.prototype.endAnimation_ = function(e) {
'use strict';
this.isAnimating_ = false;
this.dispatchEvent(goog.ui.SliderBase.EventType.ANIMATION_END);
};
/**
* Changes the orientation.
* @param {goog.ui.SliderBase.Orientation} orient The orientation.
*/
goog.ui.SliderBase.prototype.setOrientation = function(orient) {
'use strict';
if (this.orientation_ != orient) {
var oldCss = this.getCssClass(this.orientation_);
var newCss = this.getCssClass(orient);
this.orientation_ = orient;
// Update the DOM
if (this.getElement()) {
goog.dom.classlist.swap(
goog.asserts.assert(this.getElement()), oldCss, newCss);
// we need to reset the left and top, plus range highlight
var pos = (this.flipForRtl_ && this.isRightToLeft()) ? 'right' : 'left';
this.valueThumb.style[pos] = this.valueThumb.style.top = '';
this.extentThumb.style[pos] = this.extentThumb.style.top = '';
if (this.rangeHighlight) {
this.rangeHighlight.style[pos] = this.rangeHighlight.style.top = '';
this.rangeHighlight.style.width = this.rangeHighlight.style.height = '';
}
this.updateUi_();
}
}
};
/**
* @return {goog.ui.SliderBase.Orientation} the orientation of the slider.
*/
goog.ui.SliderBase.prototype.getOrientation = function() {
'use strict';
return this.orientation_;
};
/** @override */
goog.ui.SliderBase.prototype.disposeInternal = function() {
'use strict';
goog.ui.SliderBase.superClass_.disposeInternal.call(this);
if (this.incTimer_) {
this.incTimer_.dispose();
}
delete this.incTimer_;
if (this.currentAnimation_) {
this.currentAnimation_.dispose();
}
delete this.currentAnimation_;
delete this.valueThumb;
delete this.extentThumb;
if (this.rangeHighlight) {
delete this.rangeHighlight;
}
this.rangeModel.dispose();
delete this.rangeModel;
if (this.keyHandler_) {
this.keyHandler_.dispose();
delete this.keyHandler_;
}
if (this.mouseWheelHandler_) {
this.mouseWheelHandler_.dispose();
delete this.mouseWheelHandler_;
}
if (this.valueDragger_) {
this.valueDragger_.dispose();
delete this.valueDragger_;
}
if (this.extentDragger_) {
this.extentDragger_.dispose();
delete this.extentDragger_;
}
};
/**
* @return {number} The amount to increment/decrement for page up/down as well
* as when holding down the mouse button on the background.
*/
goog.ui.SliderBase.prototype.getBlockIncrement = function() {
'use strict';
return this.blockIncrement_;
};
/**
* Sets the amount to increment/decrement for page up/down as well as when
* holding down the mouse button on the background.
*
* @param {number} value The value to set the block increment to.
*/
goog.ui.SliderBase.prototype.setBlockIncrement = function(value) {
'use strict';
this.blockIncrement_ = value;
};
/**
* Sets the minimal value that the extent may have.
*
* @param {number} value The minimal value for the extent.
*/
goog.ui.SliderBase.prototype.setMinExtent = function(value) {
'use strict';
this.minExtent_ = value;
};
/**
* The amount to increment/decrement for up, down, left and right arrow keys
* and mouse wheel events.
* @private
* @type {number}
*/
goog.ui.SliderBase.prototype.unitIncrement_ = 1;
/**
* @return {number} The amount to increment/decrement for up, down, left and
* right arrow keys and mouse wheel events.
*/
goog.ui.SliderBase.prototype.getUnitIncrement = function() {
'use strict';
return this.unitIncrement_;
};
/**
* Sets the amount to increment/decrement for up, down, left and right arrow
* keys and mouse wheel events.
* @param {number} value The value to set the unit increment to.
*/
goog.ui.SliderBase.prototype.setUnitIncrement = function(value) {
'use strict';
this.unitIncrement_ = value;
};
/**
* @return {?number} The step value used to determine how to round the value.
*/
goog.ui.SliderBase.prototype.getStep = function() {
'use strict';
return this.rangeModel.getStep();
};
/**
* Sets the step value. The step value is used to determine how to round the
* value.
* @param {?number} step The step size.
*/
goog.ui.SliderBase.prototype.setStep = function(step) {
'use strict';
this.rangeModel.setStep(step);
};
/**
* @return {boolean} Whether clicking on the backgtround should move directly to
* that point.
*/
goog.ui.SliderBase.prototype.getMoveToPointEnabled = function() {
'use strict';
return this.moveToPointEnabled_;
};
/**
* Sets whether clicking on the background should move directly to that point.
* @param {boolean} val Whether clicking on the background should move directly
* to that point.
*/
goog.ui.SliderBase.prototype.setMoveToPointEnabled = function(val) {
'use strict';
this.moveToPointEnabled_ = val;
};
/**
* @return {number} The value of the underlying range model.
*/
goog.ui.SliderBase.prototype.getValue = function() {
'use strict';
return this.rangeModel.getValue();
};
/**
* Sets the value of the underlying range model. We enforce that
* getMinimum() <= value <= getMaximum() - getExtent()
* If this is not satisifed for the given value, the call is ignored and no
* CHANGE event fires.
* @param {number} value The value.
*/
goog.ui.SliderBase.prototype.setValue = function(value) {
'use strict';
// Set the position through the thumb method to enforce constraints.
this.setThumbPosition_(this.valueThumb, value);
};
/**
* @return {number} The value of the extent of the underlying range model.
*/
goog.ui.SliderBase.prototype.getExtent = function() {
'use strict';
return this.rangeModel.getExtent();
};
/**
* Sets the extent of the underlying range model. We enforce that
* getMinExtent() <= extent <= getMaximum() - getValue()
* If this is not satisifed for the given extent, the call is ignored and no
* CHANGE event fires.
* @param {number} extent The value to which to set the extent.
*/
goog.ui.SliderBase.prototype.setExtent = function(extent) {
'use strict';
// Set the position through the thumb method to enforce constraints.
this.setThumbPosition_(
this.extentThumb, (this.rangeModel.getValue() + extent));
};
/**
* Change the visibility of the slider.
* You must call this if you had set the slider's value when it was invisible.
* @param {boolean} visible Whether to show the slider.
*/
goog.ui.SliderBase.prototype.setVisible = function(visible) {
'use strict';
goog.style.setElementShown(this.getElement(), visible);
if (visible) {
this.updateUi_();
}
};
/**
* Set a11y roles and state.
* @protected
*/
goog.ui.SliderBase.prototype.setAriaRoles = function() {
'use strict';
var el = this.getElement();
goog.asserts.assert(
el, 'The DOM element for the slider base cannot be null.');
goog.a11y.aria.setRole(el, goog.a11y.aria.Role.SLIDER);
this.updateAriaStates();
};
/**
* Set a11y roles and state when values change.
* @protected
*/
goog.ui.SliderBase.prototype.updateAriaStates = function() {
'use strict';
var element = this.getElement();
if (element) {
goog.a11y.aria.setState(
element, goog.a11y.aria.State.VALUEMIN, this.getMinimum());
goog.a11y.aria.setState(
element, goog.a11y.aria.State.VALUEMAX, this.getMaximum());
goog.a11y.aria.setState(
element, goog.a11y.aria.State.VALUENOW, this.getValue());
// Passing an empty value to setState will restore the default.
goog.a11y.aria.setState(
element, goog.a11y.aria.State.VALUETEXT, this.getTextValue() || '');
}
};
/**
* Enables or disables mouse wheel handling for the slider. The mouse wheel
* handler enables the user to change the value of slider using a mouse wheel.
*
* @param {boolean} enable Whether to enable mouse wheel handling.
*/
goog.ui.SliderBase.prototype.setHandleMouseWheel = function(enable) {
'use strict';
if (this.isInDocument() && enable != this.isHandleMouseWheel()) {
this.enableMouseWheelHandling_(enable);
}
this.isHandleMouseWheel_ = enable;
};
/**
* @return {boolean} Whether the slider handles mousewheel.
*/
goog.ui.SliderBase.prototype.isHandleMouseWheel = function() {
'use strict';
return this.isHandleMouseWheel_;
};
/**
* Enable/Disable mouse wheel handling.
* @param {boolean} enable Whether to enable mouse wheel handling.
* @private
*/
goog.ui.SliderBase.prototype.enableMouseWheelHandling_ = function(enable) {
'use strict';
if (enable) {
if (!this.mouseWheelHandler_) {
this.mouseWheelHandler_ =
new goog.events.MouseWheelHandler(this.getElement());
}
this.getHandler().listen(
this.mouseWheelHandler_,
goog.events.MouseWheelHandler.EventType.MOUSEWHEEL,
this.handleMouseWheel_, {passive: false});
} else {
this.getHandler().unlisten(
this.mouseWheelHandler_,
goog.events.MouseWheelHandler.EventType.MOUSEWHEEL,
this.handleMouseWheel_, {passive: false});
}
};
/**
* Enables or disables the slider. A disabled slider will ignore all
* user-initiated events. Also fires goog.ui.Component.EventType.ENABLE/DISABLE
* event as appropriate.
* @param {boolean} enable Whether to enable the slider or not.
*/
goog.ui.SliderBase.prototype.setEnabled = function(enable) {
'use strict';
if (this.enabled_ == enable) {
return;
}
var eventType = enable ? goog.ui.Component.EventType.ENABLE :
goog.ui.Component.EventType.DISABLE;
if (this.dispatchEvent(eventType)) {
this.enabled_ = enable;
this.enableEventHandlers_(enable);
if (!enable) {
// Disabling a slider is equivalent to a mouse up event when the block
// increment (if happening) should be halted and any possible event
// handlers be appropriately unlistened.
this.stopBlockIncrementing_();
}
goog.dom.classlist.enable(
goog.asserts.assert(this.getElement()),
goog.ui.SliderBase.DISABLED_CSS_CLASS_, !enable);
}
};
/**
* @return {boolean} Whether the slider is enabled or not.
*/
goog.ui.SliderBase.prototype.isEnabled = function() {
'use strict';
return this.enabled_;
};
/**
* @param {Element} element An element for which we want offsetLeft.
* @return {number} Returns the element's offsetLeft, accounting for RTL if
* flipForRtl_ is true.
* @private
* @suppress {strictMissingProperties} Part of the go/strict_warnings_migration
*/
goog.ui.SliderBase.prototype.getOffsetStart_ = function(element) {
'use strict';
return this.flipForRtl_ ? goog.style.bidi.getOffsetStart(element) :
element.offsetLeft;
};
/**
* @return {?string} The text value for the slider's current value, or null if
* unavailable.
*/
goog.ui.SliderBase.prototype.getTextValue = function() {
'use strict';
return this.labelFn_(this.getValue());
};
/**
* Sets whether focus will be moved to the top-level element when the slider is
* dragged.
* @param {boolean} focusElementOnSliderDrag
*/
goog.ui.SliderBase.prototype.setFocusElementOnSliderDrag = function(
focusElementOnSliderDrag) {
'use strict';
this.focusElementOnSliderDrag_ = focusElementOnSliderDrag;
};
/**
* The factory for creating additional animations to be played when animating to
* a new value.
* @interface
*/
goog.ui.SliderBase.AnimationFactory = function() {};
/**
* Creates an additional animation to play when animating to a new value.
*
* @param {number} previousValue The previous value (before animation).
* @param {number} newValue The new value (after animation).
* @param {number} interval The animation interval.
* @return {!Array<!goog.fx.TransitionBase>} The additional animations to play.
*/
goog.ui.SliderBase.AnimationFactory.prototype.createAnimations;
Codebase Browser
chromium