3 * Copyright(c) 2006-2010 Ext JS, Inc.
5 * http://www.extjs.com/license
10 * @class Ext.slider.Thumb
12 * Represents a single thumb element on a Slider. This would not usually be created manually and would instead
13 * be created internally by an {@link Ext.slider.MultiSlider Ext.Slider}.
15 Ext.slider.Thumb = Ext.extend(Object, {
19 * @cfg {Ext.slider.MultiSlider} slider The Slider to render to (required)
21 constructor: function(config) {
24 * @type Ext.slider.MultiSlider
25 * The slider this thumb is contained within
27 Ext.apply(this, config || {}, {
28 cls: 'x-slider-thumb',
31 * @cfg {Boolean} constrain True to constrain the thumb so that it cannot overlap its siblings
36 Ext.slider.Thumb.superclass.constructor.call(this, config);
38 if (this.slider.vertical) {
39 Ext.apply(this, Ext.slider.Thumb.Vertical);
44 * Renders the thumb into a slider
47 this.el = this.slider.innerEl.insertFirst({cls: this.cls});
53 * Enables the thumb if it is currently disabled
56 this.disabled = false;
57 this.el.removeClass(this.slider.disabledClass);
61 * Disables the thumb if it is currently enabled
65 this.el.addClass(this.slider.disabledClass);
69 * Sets up an Ext.dd.DragTracker for this thumb
71 initEvents: function() {
74 el.addClassOnOver('x-slider-thumb-over');
76 this.tracker = new Ext.dd.DragTracker({
77 onBeforeStart: this.onBeforeDragStart.createDelegate(this),
78 onStart : this.onDragStart.createDelegate(this),
79 onDrag : this.onDrag.createDelegate(this),
80 onEnd : this.onDragEnd.createDelegate(this),
85 this.tracker.initEl(el);
90 * This is tied into the internal Ext.dd.DragTracker. If the slider is currently disabled,
91 * this returns false to disable the DragTracker too.
92 * @return {Boolean} False if the slider is currently disabled
94 onBeforeDragStart : function(e) {
98 this.slider.promoteThumb(this);
105 * This is tied into the internal Ext.dd.DragTracker's onStart template method. Adds the drag CSS class
106 * to the thumb and fires the 'dragstart' event
108 onDragStart: function(e){
109 this.el.addClass('x-slider-thumb-drag');
110 this.dragging = true;
111 this.dragStartValue = this.value;
113 this.slider.fireEvent('dragstart', this.slider, e, this);
118 * This is tied into the internal Ext.dd.DragTracker's onDrag template method. This is called every time
119 * the DragTracker detects a drag movement. It updates the Slider's value using the position of the drag
121 onDrag: function(e) {
122 var slider = this.slider,
124 newValue = this.getNewValue();
126 if (this.constrain) {
127 var above = slider.thumbs[index + 1],
128 below = slider.thumbs[index - 1];
130 if (below != undefined && newValue <= below.value) newValue = below.value;
131 if (above != undefined && newValue >= above.value) newValue = above.value;
134 slider.setValue(index, newValue, false);
135 slider.fireEvent('drag', slider, e, this);
138 getNewValue: function() {
139 var slider = this.slider,
140 pos = slider.innerEl.translatePoints(this.tracker.getXY());
142 return Ext.util.Format.round(slider.reverseValue(pos.left), slider.decimalPrecision);
147 * This is tied to the internal Ext.dd.DragTracker's onEnd template method. Removes the drag CSS class and
148 * fires the 'changecomplete' event with the new value
150 onDragEnd: function(e) {
151 var slider = this.slider,
154 this.el.removeClass('x-slider-thumb-drag');
156 this.dragging = false;
157 slider.fireEvent('dragend', slider, e);
159 if (this.dragStartValue != value) {
160 slider.fireEvent('changecomplete', slider, value, this);
166 * @class Ext.slider.MultiSlider
167 * @extends Ext.BoxComponent
168 * Slider which supports vertical or horizontal orientation, keyboard adjustments, configurable snapping, axis clicking and animation. Can be added as an item to any container. Example usage:
171 renderTo: Ext.getBody(),
179 * Sliders can be created with more than one thumb handle by passing an array of values instead of a single one:
182 renderTo: Ext.getBody(),
184 values: [25, 50, 75],
188 //this defaults to true, setting to false allows the thumbs to pass each other
189 {@link #constrainThumbs}: false
193 Ext.slider.MultiSlider = Ext.extend(Ext.BoxComponent, {
195 * @cfg {Number} value The value to initialize the slider with. Defaults to minValue.
198 * @cfg {Boolean} vertical Orient the Slider vertically rather than horizontally, defaults to false.
202 * @cfg {Number} minValue The minimum value for the Slider. Defaults to 0.
206 * @cfg {Number} maxValue The maximum value for the Slider. Defaults to 100.
210 * @cfg {Number/Boolean} decimalPrecision.
211 * <p>The number of decimal places to which to round the Slider's value. Defaults to 0.</p>
212 * <p>To disable rounding, configure as <tt><b>false</b></tt>.</p>
216 * @cfg {Number} keyIncrement How many units to change the Slider when adjusting with keyboard navigation. Defaults to 1. If the increment config is larger, it will be used instead.
220 * @cfg {Number} increment How many units to change the slider when adjusting by drag and drop. Use this option to enable 'snapping'.
226 * @property clickRange
228 * Determines whether or not a click to the slider component is considered to be a user request to change the value. Specified as an array of [top, bottom],
229 * the click event's 'top' property is compared to these numbers and the click only considered a change request if it falls within them. e.g. if the 'top'
230 * value of the click event is 4 or 16, the click is not considered a change request as it falls outside of the [5, 15] range
235 * @cfg {Boolean} clickToChange Determines whether or not clicking on the Slider axis will change the slider. Defaults to true
237 clickToChange : true,
239 * @cfg {Boolean} animate Turn on or off animation. Defaults to true
244 * True while the thumb is in a drag operation
250 * @cfg {Boolean} constrainThumbs True to disallow thumbs from overlapping one another. Defaults to true
252 constrainThumbs: true,
256 * @property topThumbZIndex
258 * The number used internally to set the z index of the top thumb (see promoteThumb for details)
260 topThumbZIndex: 10000,
263 initComponent : function(){
264 if(!Ext.isDefined(this.value)){
265 this.value = this.minValue;
271 * Array containing references to each thumb
275 Ext.slider.MultiSlider.superclass.initComponent.call(this);
277 this.keyIncrement = Math.max(this.increment, this.keyIncrement);
280 * @event beforechange
281 * Fires before the slider value is changed. By returning false from an event handler,
282 * you can cancel the event and prevent the slider from changing.
283 * @param {Ext.Slider} slider The slider
284 * @param {Number} newValue The new value which the slider is being changed to.
285 * @param {Number} oldValue The old value which the slider was previously.
291 * Fires when the slider value is changed.
292 * @param {Ext.Slider} slider The slider
293 * @param {Number} newValue The new value which the slider has been changed to.
294 * @param {Ext.slider.Thumb} thumb The thumb that was changed
299 * @event changecomplete
300 * Fires when the slider value is changed by the user and any drag operations have completed.
301 * @param {Ext.Slider} slider The slider
302 * @param {Number} newValue The new value which the slider has been changed to.
303 * @param {Ext.slider.Thumb} thumb The thumb that was changed
309 * Fires after a drag operation has started.
310 * @param {Ext.Slider} slider The slider
311 * @param {Ext.EventObject} e The event fired from Ext.dd.DragTracker
317 * Fires continuously during the drag operation while the mouse is moving.
318 * @param {Ext.Slider} slider The slider
319 * @param {Ext.EventObject} e The event fired from Ext.dd.DragTracker
325 * Fires after the drag operation has completed.
326 * @param {Ext.Slider} slider The slider
327 * @param {Ext.EventObject} e The event fired from Ext.dd.DragTracker
335 * Array of values to initalize the thumbs with
337 if (this.values == undefined || Ext.isEmpty(this.values)) this.values = [0];
339 var values = this.values;
341 for (var i=0; i < values.length; i++) {
342 this.addThumb(values[i]);
346 Ext.apply(this, Ext.slider.Vertical);
351 * Creates a new thumb and adds it to the slider
352 * @param {Number} value The initial value to set on the thumb. Defaults to 0
354 addThumb: function(value) {
355 var thumb = new Ext.slider.Thumb({
358 index : this.thumbs.length,
359 constrain: this.constrainThumbs
361 this.thumbs.push(thumb);
363 //render the thumb now if needed
364 if (this.rendered) thumb.render();
369 * Moves the given thumb above all other by increasing its z-index. This is called when as drag
370 * any thumb, so that the thumb that was just dragged is always at the highest z-index. This is
371 * required when the thumbs are stacked on top of each other at one of the ends of the slider's
372 * range, which can result in the user not being able to move any of them.
373 * @param {Ext.slider.Thumb} topThumb The thumb to move to the top
375 promoteThumb: function(topThumb) {
376 var thumbs = this.thumbs,
379 for (var i = 0, j = thumbs.length; i < j; i++) {
382 if (thumb == topThumb) {
383 zIndex = this.topThumbZIndex;
388 thumb.el.setStyle('zIndex', zIndex);
393 onRender : function() {
395 cls: 'x-slider ' + (this.vertical ? 'x-slider-vert' : 'x-slider-horz'),
399 cls:'x-slider-inner',
400 cn : [{tag:'a', cls:'x-slider-focus', href:"#", tabIndex: '-1', hidefocus:'on'}]
405 Ext.slider.MultiSlider.superclass.onRender.apply(this, arguments);
407 this.endEl = this.el.first();
408 this.innerEl = this.endEl.first();
409 this.focusEl = this.innerEl.child('.x-slider-focus');
412 for (var i=0; i < this.thumbs.length; i++) {
413 this.thumbs[i].render();
416 //calculate the size of half a thumb
417 var thumb = this.innerEl.child('.x-slider-thumb');
418 this.halfThumb = (this.vertical ? thumb.getHeight() : thumb.getWidth()) / 2;
425 * Adds keyboard and mouse listeners on this.el. Ignores click events on the internal focus element.
426 * Creates a new DragTracker which is used to control what happens when the user drags the thumb around.
428 initEvents : function(){
431 mousedown: this.onMouseDown,
432 keydown : this.onKeyDown
435 this.focusEl.swallowEvent("click", true);
440 * Mousedown handler for the slider. If the clickToChange is enabled and the click was not on the draggable 'thumb',
441 * this calculates the new value of the slider and tells the implementation (Horizontal or Vertical) to move the thumb
442 * @param {Ext.EventObject} e The click event
444 onMouseDown : function(e){
449 //see if the click was on any of the thumbs
450 var thumbClicked = false;
451 for (var i=0; i < this.thumbs.length; i++) {
452 thumbClicked = thumbClicked || e.target == this.thumbs[i].el.dom;
455 if (this.clickToChange && !thumbClicked) {
456 var local = this.innerEl.translatePoints(e.getXY());
457 this.onClickChange(local);
464 * Moves the thumb to the indicated position. Note that a Vertical implementation is provided in Ext.slider.Vertical.
465 * Only changes the value if the click was within this.clickRange.
466 * @param {Object} local Object containing top and left values for the click event.
468 onClickChange : function(local) {
469 if (local.top > this.clickRange[0] && local.top < this.clickRange[1]) {
470 //find the nearest thumb to the click event
471 var thumb = this.getNearest(local, 'left'),
474 this.setValue(index, Ext.util.Format.round(this.reverseValue(local.left), this.decimalPrecision), undefined, true);
480 * Returns the nearest thumb to a click event, along with its distance
481 * @param {Object} local Object containing top and left values from a click event
482 * @param {String} prop The property of local to compare on. Use 'left' for horizontal sliders, 'top' for vertical ones
483 * @return {Object} The closest thumb object and its distance from the click event
485 getNearest: function(local, prop) {
486 var localValue = prop == 'top' ? this.innerEl.getHeight() - local[prop] : local[prop],
487 clickValue = this.reverseValue(localValue),
488 nearestDistance = (this.maxValue - this.minValue) + 5, //add a small fudge for the end of the slider
492 for (var i=0; i < this.thumbs.length; i++) {
493 var thumb = this.thumbs[i],
495 dist = Math.abs(value - clickValue);
497 if (Math.abs(dist <= nearestDistance)) {
500 nearestDistance = dist;
508 * Handler for any keypresses captured by the slider. If the key is UP or RIGHT, the thumb is moved along to the right
509 * by this.keyIncrement. If DOWN or LEFT it is moved left. Pressing CTRL moves the slider to the end in either direction
510 * @param {Ext.EventObject} e The Event object
512 onKeyDown : function(e){
514 * The behaviour for keyboard handling with multiple thumbs is currently undefined.
515 * There's no real sane default for it, so leave it like this until we come up
516 * with a better way of doing it.
518 if(this.disabled || this.thumbs.length !== 1){
528 val = e.ctrlKey ? this.maxValue : this.getValue(0) + this.keyIncrement;
529 this.setValue(0, val, undefined, true);
534 val = e.ctrlKey ? this.minValue : this.getValue(0) - this.keyIncrement;
535 this.setValue(0, val, undefined, true);
544 * If using snapping, this takes a desired new value and returns the closest snapped
546 * @param {Number} value The unsnapped value
547 * @return {Number} The value of the nearest snap target
549 doSnap : function(value){
550 if (!(this.increment && value)) {
553 var newValue = value,
554 inc = this.increment,
560 } else if (m * 2 < -inc) {
564 return newValue.constrain(this.minValue, this.maxValue);
568 afterRender : function(){
569 Ext.slider.MultiSlider.superclass.afterRender.apply(this, arguments);
571 for (var i=0; i < this.thumbs.length; i++) {
572 var thumb = this.thumbs[i];
574 if (thumb.value !== undefined) {
575 var v = this.normalizeValue(thumb.value);
577 if (v !== thumb.value) {
578 // delete this.value;
579 this.setValue(i, v, false);
581 this.moveThumb(i, this.translateValue(v), false);
589 * Returns the ratio of pixels to mapped values. e.g. if the slider is 200px wide and maxValue - minValue is 100,
591 * @return {Number} The ratio of pixels to mapped values
593 getRatio : function(){
594 var w = this.innerEl.getWidth(),
595 v = this.maxValue - this.minValue;
596 return v == 0 ? w : (w/v);
601 * Returns a snapped, constrained value when given a desired value
602 * @param {Number} value Raw number value
603 * @return {Number} The raw value rounded to the correct d.p. and constrained within the set max and min values
605 normalizeValue : function(v){
607 v = Ext.util.Format.round(v, this.decimalPrecision);
608 v = v.constrain(this.minValue, this.maxValue);
613 * Sets the minimum value for the slider instance. If the current value is less than the
614 * minimum value, the current value will be changed.
615 * @param {Number} val The new minimum value
617 setMinValue : function(val){
620 thumbs = this.thumbs,
626 t.value = t.value < val ? val : t.value;
632 * Sets the maximum value for the slider instance. If the current value is more than the
633 * maximum value, the current value will be changed.
634 * @param {Number} val The new maximum value
636 setMaxValue : function(val){
639 thumbs = this.thumbs,
645 t.value = t.value > val ? val : t.value;
651 * Programmatically sets the value of the Slider. Ensures that the value is constrained within
652 * the minValue and maxValue.
653 * @param {Number} index Index of the thumb to move
654 * @param {Number} value The value to set the slider to. (This will be constrained within minValue and maxValue)
655 * @param {Boolean} animate Turn on or off animation, defaults to true
657 setValue : function(index, v, animate, changeComplete) {
658 var thumb = this.thumbs[index],
661 v = this.normalizeValue(v);
663 if (v !== thumb.value && this.fireEvent('beforechange', this, v, thumb.value, thumb) !== false) {
666 this.moveThumb(index, this.translateValue(v), animate !== false);
667 this.fireEvent('change', this, v, thumb);
669 this.fireEvent('changecomplete', this, v, thumb);
678 translateValue : function(v) {
679 var ratio = this.getRatio();
680 return (v * ratio) - (this.minValue * ratio) - this.halfThumb;
685 * Given a pixel location along the slider, returns the mapped slider value for that pixel.
686 * E.g. if we have a slider 200px wide with minValue = 100 and maxValue = 500, reverseValue(50)
688 * @param {Number} pos The position along the slider to return a mapped value for
689 * @return {Number} The mapped value for the given position
691 reverseValue : function(pos){
692 var ratio = this.getRatio();
693 return (pos + (this.minValue * ratio)) / ratio;
698 * @param {Number} index Index of the thumb to move
700 moveThumb: function(index, v, animate){
701 var thumb = this.thumbs[index].el;
703 if(!animate || this.animate === false){
706 thumb.shift({left: v, stopFx: true, duration:.35});
712 this.focusEl.focus(10);
716 onResize : function(w, h){
717 var thumbs = this.thumbs,
722 * If we happen to be animating during a resize, the position of the thumb will likely be off
723 * when the animation stops. As such, just stop any animations before syncing the thumbs.
726 thumbs[i].el.stopFx();
728 this.innerEl.setWidth(w - (this.el.getPadding('l') + this.endEl.getPadding('r')));
730 Ext.slider.MultiSlider.superclass.onResize.apply(this, arguments);
734 onDisable: function(){
735 Ext.slider.MultiSlider.superclass.onDisable.call(this);
737 for (var i=0; i < this.thumbs.length; i++) {
738 var thumb = this.thumbs[i],
744 //IE breaks when using overflow visible and opacity other than 1.
745 //Create a place holder for the thumb and display it.
749 this.innerEl.addClass(this.disabledClass).dom.disabled = true;
751 if (!this.thumbHolder) {
752 this.thumbHolder = this.endEl.createChild({cls: 'x-slider-thumb ' + this.disabledClass});
755 this.thumbHolder.show().setXY(xy);
761 onEnable: function(){
762 Ext.slider.MultiSlider.superclass.onEnable.call(this);
764 for (var i=0; i < this.thumbs.length; i++) {
765 var thumb = this.thumbs[i],
771 this.innerEl.removeClass(this.disabledClass).dom.disabled = false;
773 if (this.thumbHolder) this.thumbHolder.hide();
782 * Synchronizes the thumb position to the proper proportion of the total component width based
783 * on the current slider {@link #value}. This will be called automatically when the Slider
784 * is resized by a layout, but if it is rendered auto width, this method can be called from
785 * another resize handler to sync the Slider if necessary.
787 syncThumb : function() {
789 for (var i=0; i < this.thumbs.length; i++) {
790 this.moveThumb(i, this.translateValue(this.thumbs[i].value));
796 * Returns the current value of the slider
797 * @param {Number} index The index of the thumb to return a value for
798 * @return {Number} The current value of the slider
800 getValue : function(index) {
801 return this.thumbs[index].value;
805 * Returns an array of values - one for the location of each thumb
806 * @return {Array} The set of thumb values
808 getValues: function() {
811 for (var i=0; i < this.thumbs.length; i++) {
812 values.push(this.thumbs[i].value);
819 beforeDestroy : function(){
820 Ext.destroyMembers(this, 'endEl', 'innerEl', 'thumb', 'halfThumb', 'focusEl', 'tracker', 'thumbHolder');
821 Ext.slider.MultiSlider.superclass.beforeDestroy.call(this);
825 Ext.reg('multislider', Ext.slider.MultiSlider);
828 * @class Ext.slider.SingleSlider
829 * @extends Ext.slider.MultiSlider
830 * Slider which supports vertical or horizontal orientation, keyboard adjustments,
831 * configurable snapping, axis clicking and animation. Can be added as an item to
832 * any container. Example usage:
834 new Ext.slider.SingleSlider({
835 renderTo: Ext.getBody(),
843 * The class Ext.slider.SingleSlider is aliased to Ext.Slider for backwards compatibility.
845 Ext.slider.SingleSlider = Ext.extend(Ext.slider.MultiSlider, {
846 constructor: function(config) {
847 config = config || {};
849 Ext.applyIf(config, {
850 values: [config.value || 0]
853 Ext.slider.SingleSlider.superclass.constructor.call(this, config);
857 * Returns the current value of the slider
858 * @return {Number} The current value of the slider
860 getValue: function() {
861 //just returns the value of the first thumb, which should be the only one in a single slider
862 return Ext.slider.SingleSlider.superclass.getValue.call(this, 0);
866 * Programmatically sets the value of the Slider. Ensures that the value is constrained within
867 * the minValue and maxValue.
868 * @param {Number} value The value to set the slider to. (This will be constrained within minValue and maxValue)
869 * @param {Boolean} animate Turn on or off animation, defaults to true
871 setValue: function(value, animate) {
872 var args = Ext.toArray(arguments),
875 //this is to maintain backwards compatiblity for sliders with only one thunb. Usually you must pass the thumb
876 //index to setValue, but if we only have one thumb we inject the index here first if given the multi-slider
877 //signature without the required index. The index will always be 0 for a single slider
878 if (len == 1 || (len <= 3 && typeof arguments[1] != 'number')) {
882 return Ext.slider.SingleSlider.superclass.setValue.apply(this, args);
886 * Synchronizes the thumb position to the proper proportion of the total component width based
887 * on the current slider {@link #value}. This will be called automatically when the Slider
888 * is resized by a layout, but if it is rendered auto width, this method can be called from
889 * another resize handler to sync the Slider if necessary.
891 syncThumb : function() {
892 return Ext.slider.SingleSlider.superclass.syncThumb.apply(this, [0].concat(arguments));
896 getNearest : function(){
897 // Since there's only 1 thumb, it's always the nearest
898 return this.thumbs[0];
902 //backwards compatibility
903 Ext.Slider = Ext.slider.SingleSlider;
905 Ext.reg('slider', Ext.slider.SingleSlider);
907 // private class to support vertical sliders
908 Ext.slider.Vertical = {
909 onResize : function(w, h){
910 this.innerEl.setHeight(h - (this.el.getPadding('t') + this.endEl.getPadding('b')));
914 getRatio : function(){
915 var h = this.innerEl.getHeight(),
916 v = this.maxValue - this.minValue;
920 moveThumb: function(index, v, animate) {
921 var thumb = this.thumbs[index],
924 if (!animate || this.animate === false) {
927 el.shift({bottom: v, stopFx: true, duration:.35});
931 onClickChange : function(local) {
932 if (local.left > this.clickRange[0] && local.left < this.clickRange[1]) {
933 var thumb = this.getNearest(local, 'top'),
935 value = this.minValue + this.reverseValue(this.innerEl.getHeight() - local.top);
937 this.setValue(index, Ext.util.Format.round(value, this.decimalPrecision), undefined, true);
942 //private class to support vertical dragging of thumbs within a slider
943 Ext.slider.Thumb.Vertical = {
944 getNewValue: function() {
945 var slider = this.slider,
946 innerEl = slider.innerEl,
947 pos = innerEl.translatePoints(this.tracker.getXY()),
948 bottom = innerEl.getHeight() - pos.top;
950 return slider.minValue + Ext.util.Format.round(bottom / slider.getRatio(), slider.decimalPrecision);