dial.js revision db4ce980273cc4e9e42eebf699de9b44b51768a4
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * Create a circular dial value range input visualized as a draggable handle on a
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * background element.
2aa0883432cf56a974eb9261afcf6ede4313384cJeff Conniff * @module dial
2aa0883432cf56a974eb9261afcf6ede4313384cJeff Conniff if(Y.config.doc.namespaces && Y.config.doc.namespaces.add){
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff 'urn:schemas-microsoft-com:vml',
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff if(Y.config.doc.createElement('v:oval').strokeColor){
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * Create a dial to represent an input control capable of representing a
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * series of intermediate states based on the position of the Dial's handle.
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * These states are typically aligned to a value algorithm whereby the angle of the handle's
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * position corresponds to a given value.
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @class Dial
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @extends Widget
f47f024e093853ad3957be898687fc8317a835daJeff Conniff * @param config {Object} Configuration object
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @constructor
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff Dial.superclass.constructor.apply(this, arguments);
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff // Y.Dial static properties
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * The identity of the widget.
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @property Dial.NAME
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @type String
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @default 'dial'
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @protected
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * Static property used to define the default attribute configuration of
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * the Widget.
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @property Dial.ATTRS
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @type {Object}
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @protected
24ef71067b8f34f90df1fc636a73424647c97f4bJeff Conniff * minimum value allowed
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @attribute min
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @type {Number}
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @default -220
24ef71067b8f34f90df1fc636a73424647c97f4bJeff Conniff * maximum value allowed
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @attribute max
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @type {Number}
04f7ef259d54aeab53258697e1e7f8856adcc8a6Jeff Conniff * @default 220
04f7ef259d54aeab53258697e1e7f8856adcc8a6Jeff Conniff * diameter of the circular background object
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * other objects scale accordingly
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @attribute diameter
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @type {Number} the number of px in diameter
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @default 100
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff * initial value of the Dial
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff * @attribute value
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff * @type {Number}
7928e2ef0532df9064d9374ceda31d6ab080eb2dJeff Conniff * @default 0
7928e2ef0532df9064d9374ceda31d6ab080eb2dJeff Conniff * amount to increment/decrement the dial value
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff * when the arrow up/down/left/right keys are pressed
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff * @attribute minorStep
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff * @type {Number}
7928e2ef0532df9064d9374ceda31d6ab080eb2dJeff Conniff * @default 1
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff * amount to increment/decrement the dial value
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff * when the page up/down keys are pressed
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff * @attribute majorStep
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff * @type {Number}
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff * @default 10
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * number of value increments in one 360 degree revolution
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * of the handle around the dial
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @attribute stepsPerRev
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @type {Number}
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @default 100
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * number of decimal places of accuracy in the value
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @attribute decimalPlaces
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @type {Number}
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @default 0
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * visible strings for the dial UI. This attribute is
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * defined by the base Widget class but has an empty value. The
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * Dial is simply providing a default value for the attribute.
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * Gets localized strings in the current language
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @attribute strings
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @type {Object}
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @default {label: 'My label', resetStr: 'Reset', tooltipHandle: 'Drag to set value'}
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff valueFn: function () {
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * distance from the center of the dial to the
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * resting place of the center of the handle and marker.
7928e2ef0532df9064d9374ceda31d6ab080eb2dJeff Conniff * The value is a percent of the radius of the dial.
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @attribute handleDist
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @type {number}
7928e2ef0532df9064d9374ceda31d6ab080eb2dJeff Conniff * @default 0.75
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff * returns a properly formed yui class name
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff * @param {String} string to be appended at the end of class name
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff return Y.ClassNameManager.getClassName(Dial.NAME, str);
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * array of static constants used to identify the classname applied to the Dial DOM objects
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff * @property Dial.CSS_CLASSES
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @type {Array}
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff centerButtonVml : makeClassName('center-button-vml'),
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff dragging : Y.ClassNameManager.getClassName("dd-dragging")
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff /* Static constants used to define the markup templates used to create Dial DOM elements */
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff var labelId = Dial.CSS_CLASSES.label + Y.guid(); //get this unique id once then use
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * template that will contain the Dial's label.
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @property Dial.LABEL_TEMPLATE
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @type {String}
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @default <div>...</div>
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @protected
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff Dial.LABEL_TEMPLATE = '<div id="' + labelId + '" class="' + Dial.CSS_CLASSES.label + '"><span class="' + Dial.CSS_CLASSES.labelString + '">{label}</span><span class="' + Dial.CSS_CLASSES.valueString + '"></span></div>';
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff if(supportsVML === false){
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * template that will contain the Dial's background ring.
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @property Dial.RING_TEMPLATE
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @type {String}
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @default <div class="[...-ring]"><div class="[...-northMark]"></div></div>
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @protected
2353184083624510261e335c156a05e8cae2fc41Jeff Conniff Dial.RING_TEMPLATE = '<div class="' + Dial.CSS_CLASSES.ring + '"><div class="' + Dial.CSS_CLASSES.northMark + '"></div></div>';
2353184083624510261e335c156a05e8cae2fc41Jeff Conniff * template that will contain the Dial's current angle marker.
2353184083624510261e335c156a05e8cae2fc41Jeff Conniff * @property Dial.MARKER_TEMPLATE
41a8874f3c14857a5a311a43eaf30a123f376771Jeff Conniff * @type {String}
4af2659c7f72aa2813a2eea32fcc568bbea27de7Jeff Conniff * @default <div class="[...-marker] marker-hidden"><div class="[...-markerUser]"></div></div>
2353184083624510261e335c156a05e8cae2fc41Jeff Conniff * @protected
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff Dial.MARKER_TEMPLATE = '<div class="' + Dial.CSS_CLASSES.marker + ' marker-hidden"><div class="' + Dial.CSS_CLASSES.markerUser + '"></div></div>';
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff * template that will contain the Dial's center button.
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @property Dial.CENTER_BUTTON_TEMPLATE
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @type {String}
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @default <div class="[...-centerButton]"><div class="[...-resetString]">' + Y.substitute('{resetStr}', Dial.ATTRS.strings.value) + '</div></div>
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @protected
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff Dial.CENTER_BUTTON_TEMPLATE = '<div class="' + Dial.CSS_CLASSES.centerButton + '"><div class="' + Dial.CSS_CLASSES.resetString + '">{resetStr}</div></div>';
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * template that will contain the Dial's handle.
aa1805d3af3a9ac854fadba9707e18ee5f006804Jeff Conniff * @property Dial.HANDLE_TEMPLATE
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff * @type {String}
f47f024e093853ad3957be898687fc8317a835daJeff Conniff * @default <div class="[...-handle]"><div class="[...-handleUser]" aria-labelledby="' + labelId + '" aria-valuetext="" aria-valuemax="" aria-valuemin="" aria-valuenow="" role="slider" tabindex="0"></div></div>';// title="{tooltipHandle}"
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @protected
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff Dial.HANDLE_TEMPLATE = '<div class="' + Dial.CSS_CLASSES.handle + '"><div class="' + Dial.CSS_CLASSES.handleUser + '" aria-labelledby="' + labelId + '" aria-valuetext="" aria-valuemax="" aria-valuemin="" aria-valuenow="" role="slider" tabindex="0" title="{tooltipHandle}"></div></div>';// title="{tooltipHandle}"
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff }else{ // VML case
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff Dial.RING_TEMPLATE = '<div class="' + Dial.CSS_CLASSES.ring + '">'+
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff '<div class="' + Dial.CSS_CLASSES.northMark + '"></div>'+
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff '<v:oval strokecolor="#ceccc0" strokeweight="1px" class="' + Dial.CSS_CLASSES.ringVml + '"><v:fill type=gradient color="#8B8A7F" color2="#EDEDEB" angle="45"/></v:oval>'+
aa1805d3af3a9ac854fadba9707e18ee5f006804Jeff Conniff '<v:oval></v:oval>'+
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff Dial.MARKER_TEMPLATE = '<div class="' + Dial.CSS_CLASSES.marker + ' marker-hidden">'+
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff '<v:oval stroked="false" class="' + Dial.CSS_CLASSES.markerUser + '">'+
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff '<v:fill opacity="20%" color="#000"/>'+
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff '</v:oval>'+
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff '<v:oval></v:oval>'+
aa1805d3af3a9ac854fadba9707e18ee5f006804Jeff Conniff Dial.CENTER_BUTTON_TEMPLATE = '<div class="' + Dial.CSS_CLASSES.centerButton + '">'+
3e16868ea3bfcadfeeb8e23aca5bb2317a6a8ba9Jeff Conniff '<v:oval strokecolor="#ceccc0" strokeweight="1px" class="' + Dial.CSS_CLASSES.centerButtonVml + '">'+
f47f024e093853ad3957be898687fc8317a835daJeff Conniff '<v:fill type=gradient color="#C7C5B9" color2="#fefcf6" colors="35% #d9d7cb, 65% #fefcf6" angle="45"/>'+
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff '<v:shadow on="True" color="#000" opacity="10%" offset="2px, 2px"/>'+
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff '</v:oval>'+
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff '<v:oval></v:oval>'+
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff '<div class="' + Dial.CSS_CLASSES.resetString + '">{resetStr}</div>'+
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff Dial.HANDLE_TEMPLATE = '<div class="' + Dial.CSS_CLASSES.handle + '">'+
aa1805d3af3a9ac854fadba9707e18ee5f006804Jeff Conniff '<v:oval stroked="false" class="' + Dial.CSS_CLASSES.handleUser + '"'+
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff ' aria-labelledby="' + labelId + '" aria-valuetext="" aria-valuemax="" aria-valuemin="" aria-valuenow="" role="slider" tabindex="0" title="{tooltipHandle}">'+ //title="{tooltipHandle}"
f47f024e093853ad3957be898687fc8317a835daJeff Conniff '<v:fill opacity="20%" color="#6C3A3A"/>'+
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff '</v:oval>'+
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff '<v:oval></v:oval>'+
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff /* Dial extends the base Widget class */
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * creates the DOM structure for the Dial.
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @method renderUI
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @protected
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff renderUI : function() {
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff // object handles
2aa0883432cf56a974eb9261afcf6ede4313384cJeff Conniff // constants
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff this._handleDist = this._centerX * this.get('handleDist');
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff // variables
624b3d25f12c6e63f607b2690315293ad7ef6481Jeff Conniff this._angle = this._getAngleFromValue(this.get('value'));
624b3d25f12c6e63f607b2690315293ad7ef6481Jeff Conniff this._setTimesWrapedFromValue(this.get('value'));
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff this._handleUserNode.set('aria-valuemin', this.get('min'));
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff this._handleUserNode.set('aria-valuemax', this.get('max'));
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * Creates the Y.DD.Drag instance used for the handle movement and
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * binds Dial interaction to the configured value model.
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @method bindUI
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @protected
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff bindUI : function() {
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff this.after("valueChange", this._afterValueChange);
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff // Looking for a key event which will fire continously across browsers while the key is held down.
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff keyEventSpec = (!Y.UA.opera) ? "down:" : "press:",
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff keyLeftRightSpec = (!Y.UA.opera) ? "down:" : "press:";
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff // 38, 40 = arrow up/down, 33, 34 = page up/down, 35 , 36 = end/home
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff // 37 , 39 = arrow left/right
4af2659c7f72aa2813a2eea32fcc568bbea27de7Jeff Conniff Y.on("key", Y.bind(this._onDirectionKey, this), boundingBox, keyEventSpec);
4af2659c7f72aa2813a2eea32fcc568bbea27de7Jeff Conniff Y.on("key", Y.bind(this._onLeftRightKey, this), boundingBox, keyLeftRightSpec);
4af2659c7f72aa2813a2eea32fcc568bbea27de7Jeff Conniff Y.on('mouseenter', Y.bind(this._dialCenterOver, this), this._centerButtonNode);
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff Y.on('mouseleave', Y.bind(this._dialCenterOut, this), this._centerButtonNode);
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff Y.on('click', Y.bind(this._resetDial, this), this._centerButtonNode);
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff Y.on('mousedown', Y.bind(function(){this._handleUserNode.focus();}, this), this._handleNode);
4af2659c7f72aa2813a2eea32fcc568bbea27de7Jeff Conniff 'drag:start' : Y.bind(this._handleDragStart, this),
e81cc12bafc201061ba76fdfd173f1412371e0ecJeff Conniff * Sets _timesWrapped based on Dial value
e81cc12bafc201061ba76fdfd173f1412371e0ecJeff Conniff * to net integer revolutions the user dragged the handle around the Dial
e81cc12bafc201061ba76fdfd173f1412371e0ecJeff Conniff * @method _setTimesWrapedFromValue
e81cc12bafc201061ba76fdfd173f1412371e0ecJeff Conniff * @param val {Number} current value of the Dial
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff this._timesWrapped = (val / this.get('stepsPerRev')) -1;
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff this._timesWrapped = Math.floor(val / this.get('stepsPerRev'));
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff * Sets the string in the object the user clicks to reset the Dial value
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff * @method _dialCenterOver
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff * @param e {DOMEvent} the mouseover event object
2353184083624510261e335c156a05e8cae2fc41Jeff Conniff this._resetString.setContent(Y.substitute('{resetStr}', this.get('strings')));
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * Sets the string in the object the user clicks to reset the Dial value
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @method _dialCenterOut
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @param e {DOMEvent} the mouseover event object
2353184083624510261e335c156a05e8cae2fc41Jeff Conniff * handles the user dragging the handle around the Dial, calculates the angle,
2353184083624510261e335c156a05e8cae2fc41Jeff Conniff * checks for wrapping around top center, handles exceeding min or max values
2353184083624510261e335c156a05e8cae2fc41Jeff Conniff * @method _handleDrag
41af0d917f0352d732a7dbf9c9594f3ef30b82a0Jeff Conniff * @param e {DOMEvent} the drag event object
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @protected
2353184083624510261e335c156a05e8cae2fc41Jeff Conniff _handleDrag : function(e){
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff var ang = Math.atan( (this._centerYOnPage - e.pageY) / (this._centerXOnPage - e.pageX) ) * (180 / Math.PI),
624b3d25f12c6e63f607b2690315293ad7ef6481Jeff Conniff // check for need to set timesWrapped
4af2659c7f72aa2813a2eea32fcc568bbea27de7Jeff Conniff if(e.pageY < this._centerYOnPage){ //if handle is above the middle of the dial...
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff if((this._prevX <= this._centerXOnPage) && (e.pageX > this._centerXOnPage)){ // If wrapping, clockwise
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff }else if((this._prevX > this._centerXOnPage) && (e.pageX <= this._centerXOnPage)){ // if un-wrapping, counter-clockwise
4af2659c7f72aa2813a2eea32fcc568bbea27de7Jeff Conniff var newValue = this._getValueFromAngle(ang); // This function needs the current _timesWrapped value
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff // handle hitting max and min and going beyond, stops at max or min
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff //if((newValue > this.get('min')) && (newValue < this.get('max'))) {
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff if((newValue > this.get('min')) && (newValue < this.get('max'))) {
7928e2ef0532df9064d9374ceda31d6ab080eb2dJeff Conniff * handles the user starting to drag the handle around the Dial
7928e2ef0532df9064d9374ceda31d6ab080eb2dJeff Conniff * @method _handleDragStart
24ef71067b8f34f90df1fc636a73424647c97f4bJeff Conniff * @param e {DOMEvent} the drag event object
24ef71067b8f34f90df1fc636a73424647c97f4bJeff Conniff * @protected
f47f024e093853ad3957be898687fc8317a835daJeff Conniff this._centerYOnPage = (this._ringNode.getY() + this._centerY);
f47f024e093853ad3957be898687fc8317a835daJeff Conniff this._centerXOnPage = (this._ringNode.getX() + this._centerX);
7e21402185b2bb1c42859a8dca7863be3759647dJeff Conniff * When handle is handleDragEnd, this animates the return to the fixed dial
4af2659c7f72aa2813a2eea32fcc568bbea27de7Jeff Conniff * handles the end of a user dragging the handle, animates the handle returning to
4af2659c7f72aa2813a2eea32fcc568bbea27de7Jeff Conniff * resting position.
7e21402185b2bb1c42859a8dca7863be3759647dJeff Conniff * @method _handleDragEnd
4af2659c7f72aa2813a2eea32fcc568bbea27de7Jeff Conniff * @protected
7e21402185b2bb1c42859a8dca7863be3759647dJeff Conniff }, Y.bind(function(){
7e21402185b2bb1c42859a8dca7863be3759647dJeff Conniff this._prevX = this._handleNode.getX(); //makes us ready for next drag.
7e21402185b2bb1c42859a8dca7863be3759647dJeff Conniff this._setTimesWrapedFromValue(this.get('value'));
41a8874f3c14857a5a311a43eaf30a123f376771Jeff Conniff * returns the XY of the fixed position, handleDist, from the center of the Dial (resting position)
82cdeb4d776987d0e2501978b1e1c50143931bbcJeff Conniff * The XY also represents the angle related to the current value
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * If no param is passed, [X,Y] is returned.
4af2659c7f72aa2813a2eea32fcc568bbea27de7Jeff Conniff * If param is passed, the XY of the node passed is set.
4af2659c7f72aa2813a2eea32fcc568bbea27de7Jeff Conniff * @method _setNodeToFixedRadius
4af2659c7f72aa2813a2eea32fcc568bbea27de7Jeff Conniff * @param obj {Node}
4af2659c7f72aa2813a2eea32fcc568bbea27de7Jeff Conniff * @protected
4af2659c7f72aa2813a2eea32fcc568bbea27de7Jeff Conniff * @return {Array} an array of [XY] is optionally returned
4af2659c7f72aa2813a2eea32fcc568bbea27de7Jeff Conniff var newY = Math.round(Math.sin(thisAngle * rad) * this._handleDist);
4af2659c7f72aa2813a2eea32fcc568bbea27de7Jeff Conniff var newX = Math.round(Math.cos(thisAngle * rad) * this._handleDist);
4af2659c7f72aa2813a2eea32fcc568bbea27de7Jeff Conniff obj.setXY([(this._ringNode.getX() + this._centerX + newX), (this._ringNode.getY() + this._centerY + newY)]);
4af2659c7f72aa2813a2eea32fcc568bbea27de7Jeff Conniff }else{ // just need the style for css transform left and top to animate the handle drag:end
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff return [this._centerX + newX, this._centerX + newY];
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * Synchronizes the DOM state with the attribute settings.
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @method syncUI
f47f024e093853ad3957be898687fc8317a835daJeff Conniff syncUI : function() {
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * renders the DOM object for the Dial's label
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @method _renderLabel
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @protected
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff _renderLabel : function() {
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff label = contentBox.one("." + Dial.CSS_CLASSES.label);
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff label = Node.create(Y.substitute(Dial.LABEL_TEMPLATE, this.get('strings')));
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff this._valueStringNode = this._labelNode.one("." + Dial.CSS_CLASSES.valueString);
624b3d25f12c6e63f607b2690315293ad7ef6481Jeff Conniff * renders the DOM object for the Dial's background ring
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @method _renderRing
4af2659c7f72aa2813a2eea32fcc568bbea27de7Jeff Conniff * @protected
4af2659c7f72aa2813a2eea32fcc568bbea27de7Jeff Conniff _renderRing : function() {
4af2659c7f72aa2813a2eea32fcc568bbea27de7Jeff Conniff ring = contentBox.one("." + Dial.CSS_CLASSES.ring);
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff ring.setStyles({width:this.get('diameter') + 'px', height:this.get('diameter') + 'px'});
624b3d25f12c6e63f607b2690315293ad7ef6481Jeff Conniff * renders the DOM object for the Dial's background marker which
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * tracks the angle of the user dragging the handle
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @method _renderMarker
624b3d25f12c6e63f607b2690315293ad7ef6481Jeff Conniff * @protected
624b3d25f12c6e63f607b2690315293ad7ef6481Jeff Conniff marker = contentBox.one("." + Dial.CSS_CLASSES.marker);
7928e2ef0532df9064d9374ceda31d6ab080eb2dJeff Conniff contentBox.one('.' + Dial.CSS_CLASSES.ring).append(marker);
624b3d25f12c6e63f607b2690315293ad7ef6481Jeff Conniff this._markerUserNode = this._markerNode.one('.' + Dial.CSS_CLASSES.markerUser);
624b3d25f12c6e63f607b2690315293ad7ef6481Jeff Conniff * places the centerbutton's reset string in the center of the button
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff * based on the size of the string object
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @method _setXYResetString
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @protected
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff this._resetString.setStyle('top', (this._centerButtonNode.get('region').height / 2) - (this._resetString.get('region').height / 2) + 'px');
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff this._resetString.setStyle('left', (this._centerButtonNode.get('region').width / 2) - (this._resetString.get('region').width / 2) + 'px');
11b81e1c54469a27a52271a2bcff20794d259d27Jeff Conniff * renders the DOM object for the Dial's center
11b81e1c54469a27a52271a2bcff20794d259d27Jeff Conniff * @method _renderCenterButton
4af2659c7f72aa2813a2eea32fcc568bbea27de7Jeff Conniff * @protected
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff centerButton = contentBox.one("." + Dial.CSS_CLASSES.centerButton);
4af2659c7f72aa2813a2eea32fcc568bbea27de7Jeff Conniff centerButton = Node.create(Y.substitute(Dial.CENTER_BUTTON_TEMPLATE, this.get('strings')));
7e21402185b2bb1c42859a8dca7863be3759647dJeff Conniff contentBox.one('.' + Dial.CSS_CLASSES.ring).append(centerButton);
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff this._resetString = this._centerButtonNode.one('.' + Dial.CSS_CLASSES.resetString);
2aa0883432cf56a974eb9261afcf6ede4313384cJeff Conniff this._setXYResetString(); // centering the reset string in the button
624b3d25f12c6e63f607b2690315293ad7ef6481Jeff Conniff //var offset = (this._ringNode.get('region').width - this._centerButtonNode.get('region').width) / 2;
624b3d25f12c6e63f607b2690315293ad7ef6481Jeff Conniff var offset = this._ringNode.get('region').width * 0.25; //better in IE
624b3d25f12c6e63f607b2690315293ad7ef6481Jeff Conniff this._centerButtonNode.setXY([(this._ringNode.getX() + offset), (this._ringNode.getY() + offset)]);
624b3d25f12c6e63f607b2690315293ad7ef6481Jeff Conniff * renders the DOM object for the Dial's user draggable handle
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff * @method _renderHandle
2aa0883432cf56a974eb9261afcf6ede4313384cJeff Conniff * @protected
624b3d25f12c6e63f607b2690315293ad7ef6481Jeff Conniff handle = contentBox.one("." + Dial.CSS_CLASSES.handle);
dcb17c0ed0cc508b4c74234b7477b05e6a8723ebJeff Conniff handle = Node.create(Y.substitute(Dial.HANDLE_TEMPLATE, this.get('strings')));
2aa0883432cf56a974eb9261afcf6ede4313384cJeff Conniff contentBox.one('.' + Dial.CSS_CLASSES.ring).append(handle);
7928e2ef0532df9064d9374ceda31d6ab080eb2dJeff Conniff this._handleUserNode = this._handleNode.one('.' + Dial.CSS_CLASSES.handleUser);
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff * sets the visible UI label string
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff * @method _setLabelString
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff * @param str {String}
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff * @protected
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff this.get("contentBox").one("." + Dial.CSS_CLASSES.labelString).setContent(str);
11b81e1c54469a27a52271a2bcff20794d259d27Jeff Conniff * sets the visible UI label string
11b81e1c54469a27a52271a2bcff20794d259d27Jeff Conniff * @method _setResetString
11b81e1c54469a27a52271a2bcff20794d259d27Jeff Conniff * @param str {String}
11b81e1c54469a27a52271a2bcff20794d259d27Jeff Conniff * @protected
2aa0883432cf56a974eb9261afcf6ede4313384cJeff Conniff this.get("contentBox").one("." + Dial.CSS_CLASSES.resetString).setContent(str);
624b3d25f12c6e63f607b2690315293ad7ef6481Jeff Conniff this._setXYResetString(); // recenters the string in the button
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * sets the tooltip string in the Dial's handle
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @method _setTooltipString
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @param str {String}
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @protected
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff this.get("contentBox").one("." + Dial.CSS_CLASSES.handleUser).set('title', str);
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * sets the Dial's value in response to key events.
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * Left and right keys are in a separate method
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * in case an implementation wants to increment values
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * but needs left and right arrow keys for other purposes.
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @method _onDirectionKey
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @param e {Event} the key event
f47f024e093853ad3957be898687fc8317a835daJeff Conniff * @protected
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff _onDirectionKey : function(e) {
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * sets the Dial's value in response to left or right key events
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @method _onLeftRightKey
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @param e {Event} the key event
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @protected
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff _onLeftRightKey : function(e) {
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * increments Dial value by a minor increment
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @method _incrMinor
f47f024e093853ad3957be898687fc8317a835daJeff Conniff * @protected
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff var newVal = (this.get('value') + this.get("minorStep"));
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff this.set('value', newVal.toFixed(this.get('decimalPlaces')) - 0);
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * decrements Dial value by a minor increment
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @method _decrMinor
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @protected
db4ce980273cc4e9e42eebf699de9b44b51768a4Jeff Conniff var newVal = (this.get('value') - this.get("minorStep"));
f47f024e093853ad3957be898687fc8317a835daJeff Conniff this.set('value', newVal.toFixed(this.get('decimalPlaces')) - 0);
db4ce980273cc4e9e42eebf699de9b44b51768a4Jeff Conniff * increments Dial value by a major increment
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @method _incrMajor
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @protected
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff var newVal = (this.get('value') + this.get("majorStep"));
aa1805d3af3a9ac854fadba9707e18ee5f006804Jeff Conniff this.set('value', newVal.toFixed(this.get('decimalPlaces')) - 0);
db4ce980273cc4e9e42eebf699de9b44b51768a4Jeff Conniff * decrements Dial value by a major increment
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff * @method _decrMajor
691af6c84a00ad5f629ffcfa3b1e42c38da5da4fJeff Conniff * @protected
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff var newVal = (this.get('value') - this.get("majorStep"));
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff this.set('value', newVal.toFixed(this.get('decimalPlaces')) - 0);
aa1805d3af3a9ac854fadba9707e18ee5f006804Jeff Conniff * sets Dial value to dial's max attr
db4ce980273cc4e9e42eebf699de9b44b51768a4Jeff Conniff * @method _decrMajor
41a8874f3c14857a5a311a43eaf30a123f376771Jeff Conniff * @protected
2353184083624510261e335c156a05e8cae2fc41Jeff Conniff * sets Dial value to dial's min attr
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff * @method _decrMajor
f47f024e093853ad3957be898687fc8317a835daJeff Conniff * @protected
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff * resets Dial value to the orignal initial value.
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @method _resetDial
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff * @protected
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * returns the handle angle associated with the current value of the Dial
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @method _getAngleFromValue
df71f95acec70ebddf0ab97cc1e0ff2b70048017Jeff Conniff * @param newVal {Number} the current value of the Dial
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff * @return {Number} the angle associated with the current Dial value
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff * @protected
736745cee753d967cf5fb1063c21578ecca61b4aJeff Conniff var nonWrapedPartOfValue = newVal % this.get('stepsPerRev');
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff var angleFromValue = nonWrapedPartOfValue / this.get('stepsPerRev') * 360;
f47f024e093853ad3957be898687fc8317a835daJeff Conniff * returns the value of the Dial calculated from the current handle angle
2353184083624510261e335c156a05e8cae2fc41Jeff Conniff * @method _getValueFromAngle
2353184083624510261e335c156a05e8cae2fc41Jeff Conniff * @param angle {Number} the current angle of the Dial's handle
2353184083624510261e335c156a05e8cae2fc41Jeff Conniff * @return {Number} the current Dial value corresponding to the handle position
2353184083624510261e335c156a05e8cae2fc41Jeff Conniff * @protected
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff var value = (angle / 360) * this.get('stepsPerRev');
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff value = (value + (this._timesWrapped * this.get('stepsPerRev')));
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff //return Math.round(value * 100) / 100;
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff return value.toFixed(this.get('decimalPlaces')) - 0;
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff * calls the method to update the UI whenever the Dial value changes
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff * @method _afterValueChange
59927fc7ef43db5ef49fce3811b307e2f0a4267cJeff Conniff * @param e {Event}
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff * @protected
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff * Updates the UI display value of the Dial to reflect
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff * the value passed in.
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff * Makes all other needed UI display changes
59927fc7ef43db5ef49fce3811b307e2f0a4267cJeff Conniff * @method _uiSetValue
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff * @param val {Number} value of the Dial
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff * @protected
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff if(this._handleNode.hasClass(Dial.CSS_CLASSES.dragging) === false){
59927fc7ef43db5ef49fce3811b307e2f0a4267cJeff Conniff this._handleUserNode.set('aria-valuenow', val);
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff this._handleUserNode.set('aria-valuetext', val);
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff if((val === this.get('max')) || (val === this.get('min'))){
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff if(this._markerUserNode.hasClass('marker-max-min') === false){
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff this._markerUserNode.addClass('marker-max-min');
f47f024e093853ad3957be898687fc8317a835daJeff Conniff this._markerUserNode.one('fill').set('color', '#AB3232');
59927fc7ef43db5ef49fce3811b307e2f0a4267cJeff Conniff this._markerUserNode.one('fill').set('color', '#000');
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff if(this._markerUserNode.hasClass('marker-max-min') === true){
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff this._markerUserNode.removeClass('marker-max-min');
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff * value attribute default validator. Verifies that
59927fc7ef43db5ef49fce3811b307e2f0a4267cJeff Conniff * the value being set lies between the min/max value
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff * @method _validateValue
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff * @param val {Number} value of the Dial
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff * @protected
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff return (Lang.isNumber(val) && val >= min && val <= max);
44c68f247b9311ea767cb4656220793317e3383bJeff Conniff}, '@VERSION@' ,{requires:['widget', 'dd-drag', 'substitute', 'event-mouseenter', 'transition', 'intl'], skinnable:true, lang:['en','es' ]});