docs/source/Number.html

   1 <!DOCTYPE html>
   2 <html>
   3 <head>
   4   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   5   <title>The source code</title>
   6   <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
   7   <script type="text/javascript" src="../prettify/prettify.js"></script>
   8   <style type="text/css">
   9     .highlight { display: block; background-color: #ddd; }
  10   </style>
  11   <script type="text/javascript">
  12     function highlight() {
  13       document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
  14     }
  15   </script>
  16 </head>
  17 <body onload="prettyPrint(); highlight();">
  18   <pre class="prettyprint lang-js"><span id='Ext-form-field-Number'>/**
  19 </span> * @class Ext.form.field.Number
  20  * @extends Ext.form.field.Spinner
  21
  22 A numeric text field that provides automatic keystroke filtering to disallow non-numeric characters,
  23 and numeric validation to limit the value to a range of valid numbers. The range of acceptable number
  24 values can be controlled by setting the {@link #minValue} and {@link #maxValue} configs, and fractional
  25 decimals can be disallowed by setting {@link #allowDecimals} to `false`.
  26
  27 By default, the number field is also rendered with a set of up/down spinner buttons and has
  28 up/down arrow key and mouse wheel event listeners attached for incrementing/decrementing the value by the
  29 {@link #step} value. To hide the spinner buttons set `{@link #hideTrigger hideTrigger}:true`; to disable the arrow key
  30 and mouse wheel handlers set `{@link #keyNavEnabled keyNavEnabled}:false` and
  31 `{@link #mouseWheelEnabled mouseWheelEnabled}:false`. See the example below.
  32
  33 #Example usage:#
  34 {@img Ext.form.Number/Ext.form.Number1.png Ext.form.Number component}
  35     Ext.create('Ext.form.Panel', {
  36         title: 'On The Wall',
  37         width: 300,
  38         bodyPadding: 10,
  39         renderTo: Ext.getBody(),
  40         items: [{
  41             xtype: 'numberfield',
  42             anchor: '100%',
  43             name: 'bottles',
  44             fieldLabel: 'Bottles of Beer',
  45             value: 99,
  46             maxValue: 99,
  47             minValue: 0
  48         }],
  49         buttons: [{
  50             text: 'Take one down, pass it around',
  51             handler: function() {
  52                 this.up('form').down('[name=bottles]').spinDown();
  53             }
  54         }]
  55     });
  56
  57 #Removing UI Enhancements#
  58 {@img Ext.form.Number/Ext.form.Number2.png Ext.form.Number component}
  59     Ext.create('Ext.form.Panel', {
  60         title: 'Personal Info',
  61         width: 300,
  62         bodyPadding: 10,
  63         renderTo: Ext.getBody(),
  64         items: [{
  65             xtype: 'numberfield',
  66             anchor: '100%',
  67             name: 'age',
  68             fieldLabel: 'Age',
  69             minValue: 0, //prevents negative numbers
  70
  71             // Remove spinner buttons, and arrow key and mouse wheel listeners
  72             hideTrigger: true,
  73             keyNavEnabled: false,
  74             mouseWheelEnabled: false
  75         }]
  76     });
  77
  78 #Using Step#
  79     Ext.create('Ext.form.Panel', {
  80         renderTo: Ext.getBody(),
  81         title: 'Step',
  82         width: 300,
  83         bodyPadding: 10,
  84         items: [{
  85             xtype: 'numberfield',
  86             anchor: '100%',
  87             name: 'evens',
  88             fieldLabel: 'Even Numbers',
  89
  90             // Set step so it skips every other number
  91             step: 2,
  92             value: 0,
  93
  94             // Add change handler to force user-entered numbers to evens
  95             listeners: {
  96                 change: function(field, value) {
  97                     value = parseInt(value, 10);
  98                     field.setValue(value + value % 2);
  99                 }
 100             }
 101         }]
 102     });
 103
 104
 105  *
 106  * @markdown
 107  * @docauthor Jason Johnston &lt;jason@sencha.com&gt;
 108  */
 109 Ext.define('Ext.form.field.Number', {
 110     extend:'Ext.form.field.Spinner',
 111     alias: 'widget.numberfield',
 112     alternateClassName: ['Ext.form.NumberField', 'Ext.form.Number'],
 113
 114 <span id='Ext-form-field-Number-cfg-stripCharsRe'>    /**
 115 </span>     * @cfg {RegExp} stripCharsRe @hide
 116      */
 117 <span id='Ext-form-field-Number-cfg-maskRe'>    /**
 118 </span>     * @cfg {RegExp} maskRe @hide
 119      */
 120
 121 <span id='Ext-form-field-Number-cfg-allowDecimals'>    /**
 122 </span>     * @cfg {Boolean} allowDecimals False to disallow decimal values (defaults to true)
 123      */
 124     allowDecimals : true,
 125
 126 <span id='Ext-form-field-Number-cfg-decimalSeparator'>    /**
 127 </span>     * @cfg {String} decimalSeparator Character(s) to allow as the decimal separator (defaults to '.')
 128      */
 129     decimalSeparator : '.',
 130
 131 <span id='Ext-form-field-Number-cfg-decimalPrecision'>    /**
 132 </span>     * @cfg {Number} decimalPrecision The maximum precision to display after the decimal separator (defaults to 2)
 133      */
 134     decimalPrecision : 2,
 135
 136 <span id='Ext-form-field-Number-cfg-minValue'>    /**
 137 </span>     * @cfg {Number} minValue The minimum allowed value (defaults to Number.NEGATIVE_INFINITY). Will be used by
 138      * the field's validation logic, and for
 139      * {@link Ext.form.field.Spinner#setSpinUpEnabled enabling/disabling the down spinner button}.
 140      */
 141     minValue: Number.NEGATIVE_INFINITY,
 142
 143 <span id='Ext-form-field-Number-cfg-maxValue'>    /**
 144 </span>     * @cfg {Number} maxValue The maximum allowed value (defaults to Number.MAX_VALUE). Will be used by
 145      * the field's validation logic, and for
 146      * {@link Ext.form.field.Spinner#setSpinUpEnabled enabling/disabling the up spinner button}.
 147      */
 148     maxValue: Number.MAX_VALUE,
 149
 150 <span id='Ext-form-field-Number-cfg-step'>    /**
 151 </span>     * @cfg {Number} step Specifies a numeric interval by which the field's value will be incremented or
 152      * decremented when the user invokes the spinner. Defaults to &lt;tt&gt;1&lt;/tt&gt;.
 153      */
 154     step: 1,
 155
 156 <span id='Ext-form-field-Number-cfg-minText'>    /**
 157 </span>     * @cfg {String} minText Error text to display if the minimum value validation fails (defaults to 'The minimum
 158      * value for this field is {minValue}')
 159      */
 160     minText : 'The minimum value for this field is {0}',
 161
 162 <span id='Ext-form-field-Number-cfg-maxText'>    /**
 163 </span>     * @cfg {String} maxText Error text to display if the maximum value validation fails (defaults to 'The maximum
 164      * value for this field is {maxValue}')
 165      */
 166     maxText : 'The maximum value for this field is {0}',
 167
 168 <span id='Ext-form-field-Number-cfg-nanText'>    /**
 169 </span>     * @cfg {String} nanText Error text to display if the value is not a valid number.  For example, this can happen
 170      * if a valid character like '.' or '-' is left in the field with no number (defaults to '{value} is not a valid number')
 171      */
 172     nanText : '{0} is not a valid number',
 173
 174 <span id='Ext-form-field-Number-cfg-negativeText'>    /**
 175 </span>     * @cfg {String} negativeText Error text to display if the value is negative and {@link #minValue} is set to
 176      * &lt;tt&gt;0&lt;/tt&gt;. This is used instead of the {@link #minText} in that circumstance only.
 177      */
 178     negativeText : 'The value cannot be negative',
 179
 180 <span id='Ext-form-field-Number-cfg-baseChars'>    /**
 181 </span>     * @cfg {String} baseChars The base set of characters to evaluate as valid numbers (defaults to '0123456789').
 182      */
 183     baseChars : '0123456789',
 184
 185 <span id='Ext-form-field-Number-cfg-autoStripChars'>    /**
 186 </span>     * @cfg {Boolean} autoStripChars True to automatically strip not allowed characters from the field. Defaults to &lt;tt&gt;false&lt;/tt&gt;
 187      */
 188     autoStripChars: false,
 189
 190     initComponent: function() {
 191         var me = this,
 192             allowed;
 193
 194         me.callParent();
 195
 196         me.setMinValue(me.minValue);
 197         me.setMaxValue(me.maxValue);
 198
 199         // Build regexes for masking and stripping based on the configured options
 200         if (me.disableKeyFilter !== true) {
 201             allowed = me.baseChars + '';
 202             if (me.allowDecimals) {
 203                 allowed += me.decimalSeparator;
 204             }
 205             if (me.minValue &lt; 0) {
 206                 allowed += '-';
 207             }
 208             allowed = Ext.String.escapeRegex(allowed);
 209             me.maskRe = new RegExp('[' + allowed + ']');
 210             if (me.autoStripChars) {
 211                 me.stripCharsRe = new RegExp('[^' + allowed + ']', 'gi');
 212             }
 213         }
 214     },
 215
 216 <span id='Ext-form-field-Number-method-getErrors'>    /**
 217 </span>     * Runs all of Number's validations and returns an array of any errors. Note that this first
 218      * runs Text's validations, so the returned array is an amalgamation of all field errors.
 219      * The additional validations run test that the value is a number, and that it is within the
 220      * configured min and max values.
 221      * @param {Mixed} value The value to get errors for (defaults to the current field value)
 222      * @return {Array} All validation errors for this field
 223      */
 224     getErrors: function(value) {
 225         var me = this,
 226             errors = me.callParent(arguments),
 227             format = Ext.String.format,
 228             num;
 229
 230         value = Ext.isDefined(value) ? value : this.processRawValue(this.getRawValue());
 231
 232         if (value.length &lt; 1) { // if it's blank and textfield didn't flag it then it's valid
 233              return errors;
 234         }
 235
 236         value = String(value).replace(me.decimalSeparator, '.');
 237
 238         if(isNaN(value)){
 239             errors.push(format(me.nanText, value));
 240         }
 241
 242         num = me.parseValue(value);
 243
 244         if (me.minValue === 0 &amp;&amp; num &lt; 0) {
 245             errors.push(this.negativeText);
 246         }
 247         else if (num &lt; me.minValue) {
 248             errors.push(format(me.minText, me.minValue));
 249         }
 250
 251         if (num &gt; me.maxValue) {
 252             errors.push(format(me.maxText, me.maxValue));
 253         }
 254
 255
 256         return errors;
 257     },
 258
 259     rawToValue: function(rawValue) {
 260         var value = this.fixPrecision(this.parseValue(rawValue));
 261         if (value === null) {
 262             value = rawValue || null;
 263         }
 264         return  value;
 265     },
 266
 267     valueToRaw: function(value) {
 268         var me = this,
 269             decimalSeparator = me.decimalSeparator;
 270         value = me.parseValue(value);
 271         value = me.fixPrecision(value);
 272         value = Ext.isNumber(value) ? value : parseFloat(String(value).replace(decimalSeparator, '.'));
 273         value = isNaN(value) ? '' : String(value).replace('.', decimalSeparator);
 274         return value;
 275     },
 276
 277     onChange: function() {
 278         var me = this,
 279             value = me.getValue(),
 280             valueIsNull = value === null;
 281
 282         me.callParent(arguments);
 283
 284         // Update the spinner buttons
 285         me.setSpinUpEnabled(valueIsNull || value &lt; me.maxValue);
 286         me.setSpinDownEnabled(valueIsNull || value &gt; me.minValue);
 287     },
 288
 289 <span id='Ext-form-field-Number-method-setMinValue'>    /**
 290 </span>     * Replaces any existing {@link #minValue} with the new value.
 291      * @param {Number} value The minimum value
 292      */
 293     setMinValue : function(value) {
 294         this.minValue = Ext.Number.from(value, Number.NEGATIVE_INFINITY);
 295     },
 296
 297 <span id='Ext-form-field-Number-method-setMaxValue'>    /**
 298 </span>     * Replaces any existing {@link #maxValue} with the new value.
 299      * @param {Number} value The maximum value
 300      */
 301     setMaxValue: function(value) {
 302         this.maxValue = Ext.Number.from(value, Number.MAX_VALUE);
 303     },
 304
 305     // private
 306     parseValue : function(value) {
 307         value = parseFloat(String(value).replace(this.decimalSeparator, '.'));
 308         return isNaN(value) ? null : value;
 309     },
 310
 311 <span id='Ext-form-field-Number-method-fixPrecision'>    /**
 312 </span>     * @private
 313      *
 314      */
 315     fixPrecision : function(value) {
 316         var me = this,
 317             nan = isNaN(value),
 318             precision = me.decimalPrecision;
 319
 320         if (nan || !value) {
 321             return nan ? '' : value;
 322         } else if (!me.allowDecimals || precision &lt;= 0) {
 323             precision = 0;
 324         }
 325
 326         return parseFloat(Ext.Number.toFixed(parseFloat(value), precision));
 327     },
 328
 329     beforeBlur : function() {
 330         var me = this,
 331             v = me.parseValue(me.getRawValue());
 332
 333         if (!Ext.isEmpty(v)) {
 334             me.setValue(v);
 335         }
 336     },
 337
 338     onSpinUp: function() {
 339         var me = this;
 340         if (!me.readOnly) {
 341             me.setValue(Ext.Number.constrain(me.getValue() + me.step, me.minValue, me.maxValue));
 342         }
 343     },
 344
 345     onSpinDown: function() {
 346         var me = this;
 347         if (!me.readOnly) {
 348             me.setValue(Ext.Number.constrain(me.getValue() - me.step, me.minValue, me.maxValue));
 349         }
 350     }
 351 });
 352 </pre>
 353 </body>
 354 </html>