/**
+ * @class Ext.form.field.Spinner
* @extends Ext.form.field.Trigger
* <p>A field with a pair of up/down spinner buttons. This class is not normally instantiated directly,
* instead it is subclassed and the {@link #onSpinUp} and {@link #onSpinDown} methods are implemented
@@ -50,10 +67,6 @@
* <p>By default, pressing the up and down arrow keys will also trigger the onSpinUp and onSpinDown methods;
* to prevent this, set <tt>{@link #keyNavEnabled} = false</tt>.</p>
*
- * @constructor
- * Creates a new Spinner field
- * @param {Object} config Configuration options
- * @xtype spinnerfield
*/
Ext.define('Ext.form.field.Spinner', {
extend: 'Ext.form.field.Trigger',
@@ -64,47 +77,47 @@ Ext.define('Ext.form.field.Spinner', {
trigger1Cls: Ext.baseCSSPrefix + 'form-spinner-up',
trigger2Cls: Ext.baseCSSPrefix + 'form-spinner-down',
- /**
+ /**
* @cfg {Boolean} spinUpEnabled
* Specifies whether the up spinner button is enabled. Defaults to <tt>true</tt>. To change this
* after the component is created, use the {@link #setSpinUpEnabled} method.
*/
spinUpEnabled: true,
- /**
+ /**
* @cfg {Boolean} spinDownEnabled
* Specifies whether the down spinner button is enabled. Defaults to <tt>true</tt>. To change this
* after the component is created, use the {@link #setSpinDownEnabled} method.
*/
spinDownEnabled: true,
- /**
+ /**
* @cfg {Boolean} keyNavEnabled
* Specifies whether the up and down arrow keys should trigger spinning up and down.
* Defaults to <tt>true</tt>.
*/
keyNavEnabled: true,
- /**
+ /**
* @cfg {Boolean} mouseWheelEnabled
* Specifies whether the mouse wheel should trigger spinning up and down while the field has
* focus. Defaults to <tt>true</tt>.
*/
mouseWheelEnabled: true,
- /**
+ /**
* @cfg {Boolean} repeatTriggerClick Whether a {@link Ext.util.ClickRepeater click repeater} should be
* attached to the spinner buttons. Defaults to <tt>true</tt>.
*/
repeatTriggerClick: true,
- /**
+ /**
* This method is called when the spinner up button is clicked, or when the up arrow key is pressed
* if {@link #keyNavEnabled} is <tt>true</tt>. Must be implemented by subclasses.
*/
onSpinUp: Ext.emptyFn,
- /**
+ /**
* This method is called when the spinner down button is clicked, or when the down arrow key is pressed
* if {@link #keyNavEnabled} is <tt>true</tt>. Must be implemented by subclasses.
*/
@@ -114,7 +127,7 @@ Ext.define('Ext.form.field.Spinner', {
this.callParent();
this.addEvents(
- /**
+ /**
* @event spin
* Fires when the spinner is made to spin up or down.
* @param {Ext.form.field.Spinner} this
@@ -122,14 +135,14 @@ Ext.define('Ext.form.field.Spinner', {
*/
'spin',
- /**
+ /**
* @event spinup
* Fires when the spinner is made to spin up.
* @param {Ext.form.field.Spinner} this
*/
'spinup',
- /**
+ /**
* @event spindown
* Fires when the spinner is made to spin down.
* @param {Ext.form.field.Spinner} this
@@ -138,7 +151,7 @@ Ext.define('Ext.form.field.Spinner', {
);
},
- /**
+ /**
* @private override
*/
onRender: function() {
@@ -148,13 +161,13 @@ Ext.define('Ext.form.field.Spinner', {
me.callParent(arguments);
triggers = me.triggerEl;
- /**
+ /**
* @property spinUpEl
* @type Ext.core.Element
* The spinner up button element
*/
me.spinUpEl = triggers.item(0);
- /**
+ /**
* @property spinDownEl
* @type Ext.core.Element
* The spinner down button element
@@ -180,7 +193,7 @@ Ext.define('Ext.form.field.Spinner', {
}
},
- /**
+ /**
* @private override
* Since the triggers are stacked, only measure the width of one of them.
*/
@@ -188,21 +201,21 @@ Ext.define('Ext.form.field.Spinner', {
return this.hideTrigger || this.readOnly ? 0 : this.spinUpEl.getWidth() + this.triggerWrap.getFrameWidth('lr');
},
- /**
+ /**
* @private Handles the spinner up button clicks.
*/
onTrigger1Click: function() {
this.spinUp();
},
- /**
+ /**
* @private Handles the spinner down button clicks.
*/
onTrigger2Click: function() {
this.spinDown();
},
- /**
+ /**
* Triggers the spinner to step up; fires the {@link #spin} and {@link #spinup} events and calls the
* {@link #onSpinUp} method. Does nothing if the field is {@link #disabled} or if {@link #spinUpEnabled}
* is false.
@@ -216,7 +229,7 @@ Ext.define('Ext.form.field.Spinner', {
}
},
- /**
+ /**
* Triggers the spinner to step down; fires the {@link #spin} and {@link #spindown} events and calls the
* {@link #onSpinDown} method. Does nothing if the field is {@link #disabled} or if {@link #spinDownEnabled}
* is false.
@@ -230,7 +243,7 @@ Ext.define('Ext.form.field.Spinner', {
}
},
- /**
+ /**
* Sets whether the spinner up button is enabled.
* @param {Boolean} enabled true to enable the button, false to disable it.
*/
@@ -243,7 +256,7 @@ Ext.define('Ext.form.field.Spinner', {
}
},
- /**
+ /**
* Sets whether the spinner down button is enabled.
* @param {Boolean} enabled true to enable the button, false to disable it.
*/
@@ -256,7 +269,7 @@ Ext.define('Ext.form.field.Spinner', {
}
},
- /**
+ /**
* @private
* Handles mousewheel events on the field
*/
@@ -280,4 +293,6 @@ Ext.define('Ext.form.field.Spinner', {
this.callParent();
}
-});