jquery-ui/ui/widgets/spinner.js

560 lines
13 KiB
JavaScript
Raw Normal View History

/*!
2010-11-30 12:43:43 +00:00
* jQuery UI Spinner @VERSION
* https://jqueryui.com
2010-11-30 12:43:43 +00:00
*
* Copyright OpenJS Foundation and other contributors
2012-08-09 14:13:24 +00:00
* Released under the MIT license.
* https://jquery.org/license
2010-11-30 12:43:43 +00:00
*/
//>>label: Spinner
//>>group: Widgets
//>>description: Displays buttons to easily input numbers via the keyboard or mouse.
//>>docs: https://api.jqueryui.com/spinner/
//>>demos: https://jqueryui.com/spinner/
//>>css.structure: ../../themes/base/core.css
//>>css.structure: ../../themes/base/spinner.css
//>>css.theme: ../../themes/base/theme.css
( function( factory ) {
"use strict";
if ( typeof define === "function" && define.amd ) {
// AMD. Register as an anonymous module.
define( [
"jquery",
"./button",
"../version",
"../keycode",
"../widget"
], factory );
} else {
// Browser globals
factory( jQuery );
}
} )( function( $ ) {
"use strict";
2010-11-30 12:43:43 +00:00
2016-10-26 14:12:12 +00:00
function spinnerModifier( fn ) {
return function() {
var previous = this.element.val();
fn.apply( this, arguments );
this._refresh();
if ( previous !== this.element.val() ) {
this._trigger( "change" );
}
};
}
$.widget( "ui.spinner", {
version: "@VERSION",
defaultElement: "<input>",
2011-05-18 01:07:44 +00:00
widgetEventPrefix: "spin",
2010-11-30 12:43:43 +00:00
options: {
classes: {
"ui-spinner": "ui-corner-all",
"ui-spinner-down": "ui-corner-br",
"ui-spinner-up": "ui-corner-tr"
},
2011-09-28 22:30:58 +00:00
culture: null,
icons: {
down: "ui-icon-triangle-1-s",
up: "ui-icon-triangle-1-n"
},
2010-11-30 12:43:43 +00:00
incremental: true,
max: null,
min: null,
numberFormat: null,
page: 10,
step: 1,
change: null,
spin: null,
start: null,
stop: null
2010-11-30 12:43:43 +00:00
},
2011-05-18 01:07:44 +00:00
2010-11-30 12:43:43 +00:00
_create: function() {
2015-08-24 12:57:40 +00:00
// handle string values that need to be parsed
this._setOption( "max", this.options.max );
this._setOption( "min", this.options.min );
this._setOption( "step", this.options.step );
// Only format if there is a value, prevents the field from being marked
// as invalid in Firefox, see #9573.
if ( this.value() !== "" ) {
2015-08-24 12:57:40 +00:00
// Format the value, but don't constrain.
this._value( this.element.val(), true );
}
this._draw();
this._on( this._events );
this._refresh();
// Turning off autocomplete prevents the browser from remembering the
// value when navigating through history, so we re-enable autocomplete
// if the page is unloaded before the widget is destroyed. #7790
this._on( this.window, {
beforeunload: function() {
this.element.removeAttr( "autocomplete" );
}
} );
2010-11-30 12:43:43 +00:00
},
2011-05-18 01:07:44 +00:00
_getCreateOptions: function() {
var options = this._super();
var element = this.element;
$.each( [ "min", "max", "step" ], function( i, option ) {
var value = element.attr( option );
if ( value != null && value.length ) {
options[ option ] = value;
2010-11-30 12:43:43 +00:00
}
} );
return options;
2010-11-30 12:43:43 +00:00
},
2011-05-18 01:07:44 +00:00
_events: {
keydown: function( event ) {
if ( this._start( event ) && this._keydown( event ) ) {
event.preventDefault();
}
},
keyup: "_stop",
focus: function() {
this.previous = this.element.val();
},
blur: function( event ) {
this._stop();
this._refresh();
if ( this.previous !== this.element.val() ) {
this._trigger( "change", event );
}
},
mousewheel: function( event, delta ) {
var activeElement = this.document[ 0 ].activeElement;
var isActive = this.element[ 0 ] === activeElement;
if ( !isActive || !delta ) {
return;
}
if ( !this.spinning && !this._start( event ) ) {
return false;
}
this._spin( ( delta > 0 ? 1 : -1 ) * this.options.step, event );
clearTimeout( this.mousewheelTimer );
this.mousewheelTimer = this._delay( function() {
if ( this.spinning ) {
this._stop( event );
}
}, 100 );
event.preventDefault();
},
"mousedown .ui-spinner-button": function( event ) {
var previous;
// We never want the buttons to have focus; whenever the user is
// interacting with the spinner, the focus should be on the input.
// If the input is focused then this.previous is properly set from
// when the input first received focus. If the input is not focused
// then we need to set this.previous based on the value before spinning.
previous = this.element[ 0 ] === this.document[ 0 ].activeElement ?
this.previous : this.element.val();
function checkFocus() {
var isActive = this.element[ 0 ] === this.document[ 0 ].activeElement;
if ( !isActive ) {
this.element.trigger( "focus" );
this.previous = previous;
}
}
// Ensure focus is on (or stays on) the text field
event.preventDefault();
checkFocus.call( this );
if ( this._start( event ) === false ) {
return;
}
this._repeat( null, $( event.currentTarget )
.hasClass( "ui-spinner-up" ) ? 1 : -1, event );
},
"mouseup .ui-spinner-button": "_stop",
"mouseenter .ui-spinner-button": function( event ) {
2015-08-24 12:57:40 +00:00
// button will add ui-state-active if mouse was down while mouseleave and kept down
if ( !$( event.currentTarget ).hasClass( "ui-state-active" ) ) {
return;
}
if ( this._start( event ) === false ) {
return false;
}
this._repeat( null, $( event.currentTarget )
.hasClass( "ui-spinner-up" ) ? 1 : -1, event );
},
2015-08-24 12:57:40 +00:00
// TODO: do we really want to consider this a stop?
// shouldn't we just stop the repeater and wait until mouseup before
// we trigger the stop event?
"mouseleave .ui-spinner-button": "_stop"
},
// Support mobile enhanced option and make backcompat more sane
_enhance: function() {
this.uiSpinner = this.element
2011-05-18 01:07:44 +00:00
.attr( "autocomplete", "off" )
.wrap( "<span>" )
2010-11-30 12:43:43 +00:00
.parent()
// Add buttons
.append(
2015-09-16 05:53:52 +00:00
"<a></a><a></a>"
);
},
_draw: function() {
this._enhance();
2010-11-30 12:43:43 +00:00
this._addClass( this.uiSpinner, "ui-spinner", "ui-widget ui-widget-content" );
this._addClass( "ui-spinner-input" );
this.element.attr( "role", "spinbutton" );
2010-11-30 12:43:43 +00:00
// Button bindings
this.buttons = this.uiSpinner.children( "a" )
2011-05-18 01:07:44 +00:00
.attr( "tabIndex", -1 )
2015-08-14 14:16:05 +00:00
.attr( "aria-hidden", true )
.button( {
classes: {
"ui-button": ""
}
} );
// TODO: Right now button does not support classes this is already updated in button PR
this._removeClass( this.buttons, "ui-corner-all" );
this._addClass( this.buttons.first(), "ui-spinner-button ui-spinner-up" );
this._addClass( this.buttons.last(), "ui-spinner-button ui-spinner-down" );
2015-08-14 14:16:05 +00:00
this.buttons.first().button( {
"icon": this.options.icons.up,
"showLabel": false
} );
2015-09-11 14:49:47 +00:00
this.buttons.last().button( {
2015-08-14 14:16:05 +00:00
"icon": this.options.icons.down,
"showLabel": false
} );
2011-05-18 01:07:44 +00:00
// IE 6 doesn't understand height: 50% for the buttons
// unless the wrapper has an explicit height
if ( this.buttons.height() > Math.ceil( this.uiSpinner.height() * 0.5 ) &&
this.uiSpinner.height() > 0 ) {
this.uiSpinner.height( this.uiSpinner.height() );
}
2010-11-30 12:43:43 +00:00
},
2011-05-18 01:07:44 +00:00
_keydown: function( event ) {
var options = this.options,
keyCode = $.ui.keyCode;
switch ( event.keyCode ) {
case keyCode.UP:
this._repeat( null, 1, event );
return true;
2011-05-18 01:07:44 +00:00
case keyCode.DOWN:
this._repeat( null, -1, event );
return true;
2011-05-18 01:07:44 +00:00
case keyCode.PAGE_UP:
this._repeat( null, options.page, event );
return true;
2011-05-18 01:07:44 +00:00
case keyCode.PAGE_DOWN:
this._repeat( null, -options.page, event );
return true;
2010-11-30 12:43:43 +00:00
}
2011-05-18 01:07:44 +00:00
return false;
2010-11-30 12:43:43 +00:00
},
2011-05-18 01:07:44 +00:00
_start: function( event ) {
if ( !this.spinning && this._trigger( "start", event ) === false ) {
return false;
}
if ( !this.counter ) {
this.counter = 1;
2010-11-30 12:43:43 +00:00
}
2011-05-18 01:07:44 +00:00
this.spinning = true;
return true;
2010-11-30 12:43:43 +00:00
},
2011-05-18 01:07:44 +00:00
_repeat: function( i, steps, event ) {
2010-11-30 12:43:43 +00:00
i = i || 500;
2011-05-18 01:07:44 +00:00
clearTimeout( this.timer );
this.timer = this._delay( function() {
this._repeat( 40, steps, event );
2011-05-18 01:07:44 +00:00
}, i );
this._spin( steps * this.options.step, event );
2010-11-30 12:43:43 +00:00
},
2011-05-18 01:07:44 +00:00
_spin: function( step, event ) {
var value = this.value() || 0;
2011-05-18 01:07:44 +00:00
if ( !this.counter ) {
2010-11-30 12:43:43 +00:00
this.counter = 1;
}
2011-05-18 01:07:44 +00:00
value = this._adjustValue( value + step * this._increment( this.counter ) );
if ( !this.spinning || this._trigger( "spin", event, { value: value } ) !== false ) {
this._value( value );
2011-05-18 01:07:44 +00:00
this.counter++;
2010-11-30 12:43:43 +00:00
}
},
2011-05-18 01:07:44 +00:00
_increment: function( i ) {
var incremental = this.options.incremental;
if ( incremental ) {
return typeof incremental === "function" ?
incremental( i ) :
2013-10-16 18:43:09 +00:00
Math.floor( i * i * i / 50000 - i * i / 500 + 17 * i / 200 + 1 );
}
return 1;
},
_precision: function() {
var precision = this._precisionOf( this.options.step );
if ( this.options.min !== null ) {
precision = Math.max( precision, this._precisionOf( this.options.min ) );
}
return precision;
},
_precisionOf: function( num ) {
var str = num.toString(),
decimal = str.indexOf( "." );
return decimal === -1 ? 0 : str.length - decimal - 1;
},
_adjustValue: function( value ) {
var base, aboveMin,
options = this.options;
// Make sure we're at a valid step
// - find out where we are relative to the base (min or 0)
base = options.min !== null ? options.min : 0;
aboveMin = value - base;
2015-08-24 12:57:40 +00:00
// - round to the nearest step
aboveMin = Math.round( aboveMin / options.step ) * options.step;
2015-08-24 12:57:40 +00:00
// - rounding is based on 0, so adjust back to our base
value = base + aboveMin;
// Fix precision from bad JS floating point math
value = parseFloat( value.toFixed( this._precision() ) );
// Clamp the value
if ( options.max !== null && value > options.max ) {
return options.max;
}
if ( options.min !== null && value < options.min ) {
return options.min;
}
return value;
},
2011-05-18 01:07:44 +00:00
_stop: function( event ) {
if ( !this.spinning ) {
return;
}
clearTimeout( this.timer );
clearTimeout( this.mousewheelTimer );
2010-11-30 12:43:43 +00:00
this.counter = 0;
this.spinning = false;
2011-05-18 01:07:44 +00:00
this._trigger( "stop", event );
2010-11-30 12:43:43 +00:00
},
2011-05-18 01:07:44 +00:00
_setOption: function( key, value ) {
var prevValue, first, last;
if ( key === "culture" || key === "numberFormat" ) {
prevValue = this._parse( this.element.val() );
this.options[ key ] = value;
this.element.val( this._format( prevValue ) );
return;
}
if ( key === "max" || key === "min" || key === "step" ) {
if ( typeof value === "string" ) {
value = this._parse( value );
}
}
if ( key === "icons" ) {
first = this.buttons.first().find( ".ui-icon" );
this._removeClass( first, null, this.options.icons.up );
this._addClass( first, null, value.up );
last = this.buttons.last().find( ".ui-icon" );
this._removeClass( last, null, this.options.icons.down );
this._addClass( last, null, value.down );
}
this._super( key, value );
},
_setOptionDisabled: function( value ) {
this._super( value );
this._toggleClass( this.uiSpinner, null, "ui-state-disabled", !!value );
this.element.prop( "disabled", !!value );
this.buttons.button( value ? "disable" : "enable" );
},
2011-05-18 01:07:44 +00:00
2016-10-26 14:12:12 +00:00
_setOptions: spinnerModifier( function( options ) {
this._super( options );
} ),
2011-05-18 01:07:44 +00:00
_parse: function( val ) {
if ( typeof val === "string" && val !== "" ) {
2011-09-28 22:30:58 +00:00
val = window.Globalize && this.options.numberFormat ?
Globalize.parseFloat( val, 10, this.options.culture ) : +val;
2010-11-30 12:43:43 +00:00
}
return val === "" || isNaN( val ) ? null : val;
2010-11-30 12:43:43 +00:00
},
2011-05-18 01:07:44 +00:00
_format: function( value ) {
if ( value === "" ) {
return "";
}
return window.Globalize && this.options.numberFormat ?
2011-09-28 22:30:58 +00:00
Globalize.format( value, this.options.numberFormat, this.options.culture ) :
value;
},
_refresh: function() {
this.element.attr( {
"aria-valuemin": this.options.min,
"aria-valuemax": this.options.max,
2015-08-24 12:57:40 +00:00
// TODO: what should we do with values that can't be parsed?
"aria-valuenow": this._parse( this.element.val() )
} );
2010-11-30 12:43:43 +00:00
},
2011-05-18 01:07:44 +00:00
isValid: function() {
var value = this.value();
// Null is invalid
if ( value === null ) {
return false;
}
// If value gets adjusted, it's invalid
return value === this._adjustValue( value );
},
// Update the value without triggering change
_value: function( value, allowAny ) {
var parsed;
if ( value !== "" ) {
parsed = this._parse( value );
if ( parsed !== null ) {
if ( !allowAny ) {
parsed = this._adjustValue( parsed );
}
value = this._format( parsed );
}
}
this.element.val( value );
this._refresh();
},
_destroy: function() {
2010-11-30 12:43:43 +00:00
this.element
2011-06-08 21:02:57 +00:00
.prop( "disabled", false )
.removeAttr( "autocomplete role aria-valuemin aria-valuemax aria-valuenow" );
2011-05-18 01:07:44 +00:00
this.uiSpinner.replaceWith( this.element );
2010-11-30 12:43:43 +00:00
},
2011-05-18 01:07:44 +00:00
2016-10-26 14:12:12 +00:00
stepUp: spinnerModifier( function( steps ) {
this._stepUp( steps );
} ),
_stepUp: function( steps ) {
if ( this._start() ) {
this._spin( ( steps || 1 ) * this.options.step );
this._stop();
}
2010-11-30 12:43:43 +00:00
},
2011-05-18 01:07:44 +00:00
2016-10-26 14:12:12 +00:00
stepDown: spinnerModifier( function( steps ) {
this._stepDown( steps );
} ),
_stepDown: function( steps ) {
if ( this._start() ) {
this._spin( ( steps || 1 ) * -this.options.step );
this._stop();
}
2010-11-30 12:43:43 +00:00
},
2011-05-18 01:07:44 +00:00
2016-10-26 14:12:12 +00:00
pageUp: spinnerModifier( function( pages ) {
this._stepUp( ( pages || 1 ) * this.options.page );
} ),
2011-05-18 01:07:44 +00:00
2016-10-26 14:12:12 +00:00
pageDown: spinnerModifier( function( pages ) {
this._stepDown( ( pages || 1 ) * this.options.page );
} ),
2011-05-18 01:07:44 +00:00
value: function( newVal ) {
if ( !arguments.length ) {
return this._parse( this.element.val() );
2010-11-30 12:43:43 +00:00
}
2016-10-26 14:12:12 +00:00
spinnerModifier( this._value ).call( this, newVal );
2010-11-30 12:43:43 +00:00
},
2011-05-18 01:07:44 +00:00
2010-11-30 12:43:43 +00:00
widget: function() {
return this.uiSpinner;
}
} );
2010-11-30 12:43:43 +00:00
// DEPRECATED
// TODO: switch return back to widget declaration at top of file when this is removed
if ( $.uiBackCompat === true ) {
// Backcompat for spinner html extension points
$.widget( "ui.spinner", $.ui.spinner, {
_enhance: function() {
this.uiSpinner = this.element
.attr( "autocomplete", "off" )
.wrap( this._uiSpinnerHtml() )
.parent()
// Add buttons
.append( this._buttonHtml() );
},
_uiSpinnerHtml: function() {
return "<span>";
},
_buttonHtml: function() {
2015-09-16 05:53:52 +00:00
return "<a></a><a></a>";
}
} );
}
return $.ui.spinner;
} );