TextField.js
上传用户:shuoshiled
上传日期:2018-01-28
资源大小:10124k
文件大小:19k
源码类别:

中间件编程

开发平台:

JavaScript

  1. /*!
  2.  * Ext JS Library 3.0.0
  3.  * Copyright(c) 2006-2009 Ext JS, LLC
  4.  * licensing@extjs.com
  5.  * http://www.extjs.com/license
  6.  */
  7. /**
  8.  * @class Ext.form.TextField
  9.  * @extends Ext.form.Field
  10.  * <p>Basic text field.  Can be used as a direct replacement for traditional text inputs,
  11.  * or as the base class for more sophisticated input controls (like {@link Ext.form.TextArea}
  12.  * and {@link Ext.form.ComboBox}).</p>
  13.  * <p><b><u>Validation</u></b></p>
  14.  * <p>Field validation is processed in a particular order.  If validation fails at any particular
  15.  * step the validation routine halts.</p>
  16.  * <div class="mdetail-params"><ul>
  17.  * <li><b>1. Field specific validator</b>
  18.  * <div class="sub-desc">
  19.  * <p>If a field is configured with a <code>{@link Ext.form.TextField#validator validator}</code> function,
  20.  * it will be passed the current field value.  The <code>{@link Ext.form.TextField#validator validator}</code>
  21.  * function is expected to return boolean <tt>true</tt> if the value is valid or return a string to
  22.  * represent the invalid message if invalid.</p>
  23.  * </div></li>
  24.  * <li><b>2. Built in Validation</b>
  25.  * <div class="sub-desc">
  26.  * <p>Basic validation is affected with the following configuration properties:</p>
  27.  * <pre>
  28.  * <u>Validation</u>    <u>Invalid Message</u>
  29.  * <code>{@link Ext.form.TextField#allowBlank allowBlank}    {@link Ext.form.TextField#emptyText emptyText}</code>
  30.  * <code>{@link Ext.form.TextField#minLength minLength}     {@link Ext.form.TextField#minLengthText minLengthText}</code>
  31.  * <code>{@link Ext.form.TextField#maxLength maxLength}     {@link Ext.form.TextField#maxLengthText maxLengthText}</code>
  32.  * </pre>
  33.  * </div></li>
  34.  * <li><b>3. Preconfigured Validation Types (VTypes)</b>
  35.  * <div class="sub-desc">
  36.  * <p>Using VTypes offers a convenient way to reuse validation. If a field is configured with a
  37.  * <code>{@link Ext.form.TextField#vtype vtype}</code>, the corresponding {@link Ext.form.VTypes VTypes}
  38.  * validation function will be used for validation.  If invalid, either the field's
  39.  * <code>{@link Ext.form.TextField#vtypeText vtypeText}</code> or the VTypes vtype Text property will be
  40.  * used for the invalid message.  Keystrokes on the field will be filtered according to the VTypes
  41.  * vtype Mask property.</p>
  42.  * </div></li>
  43.  * <li><b>4. Field specific regex test</b>
  44.  * <div class="sub-desc">
  45.  * <p>Each field may also specify a <code>{@link Ext.form.TextField#regex regex}</code> test.
  46.  * The invalid message for this test is configured with
  47.  * <code>{@link Ext.form.TextField#regexText regexText}</code>.</p>
  48.  * </div></li>
  49.  * <li><b>Alter Validation Behavior</b>
  50.  * <div class="sub-desc">
  51.  * <p>Validation behavior for each field can be configured:</p><ul>
  52.  * <li><code>{@link Ext.form.TextField#invalidText invalidText}</code> : the default validation message to
  53.  * show if any validation step above does not provide a message when invalid</li>
  54.  * <li><code>{@link Ext.form.TextField#maskRe maskRe}</code> : filter out keystrokes before any validation occurs</li>
  55.  * <li><code>{@link Ext.form.TextField#stripCharsRe stripCharsRe}</code> : filter characters after being typed in,
  56.  * but before being validated</li>
  57.  * <li><code>{@link Ext.form.Field#invalidClass invalidClass}</code> : alternate style when invalid</li>
  58.  * <li><code>{@link Ext.form.Field#validateOnBlur validateOnBlur}</code>,
  59.  * <code>{@link Ext.form.Field#validationDelay validationDelay}</code>, and
  60.  * <code>{@link Ext.form.Field#validationEvent validationEvent}</code> : modify how/when validation is triggered</li>
  61.  * </ul>
  62.  * </div></li>
  63.  * </ul></div>
  64.  * @constructor
  65.  * Creates a new TextField
  66.  * @param {Object} config Configuration options
  67.  * @xtype textfield
  68.  */
  69. Ext.form.TextField = Ext.extend(Ext.form.Field,  {
  70.     /**
  71.      * @cfg {String} vtypeText A custom error message to display in place of the default message provided
  72.      * for the <b><code>{@link #vtype}</code></b> currently set for this field (defaults to <tt>''</tt>).  <b>Note</b>:
  73.      * only applies if <b><code>{@link #vtype}</code></b> is set, else ignored.
  74.      */
  75.     /**
  76.      * @cfg {RegExp} stripCharsRe A JavaScript RegExp object used to strip unwanted content from the value
  77.      * before validation (defaults to <tt>null</tt>).
  78.      */
  79.     /**
  80.      * @cfg {Boolean} grow <tt>true</tt> if this field should automatically grow and shrink to its content
  81.      * (defaults to <tt>false</tt>)
  82.      */
  83.     grow : false,
  84.     /**
  85.      * @cfg {Number} growMin The minimum width to allow when <code><b>{@link #grow}</b> = true</code> (defaults
  86.      * to <tt>30</tt>)
  87.      */
  88.     growMin : 30,
  89.     /**
  90.      * @cfg {Number} growMax The maximum width to allow when <code><b>{@link #grow}</b> = true</code> (defaults
  91.      * to <tt>800</tt>)
  92.      */
  93.     growMax : 800,
  94.     /**
  95.      * @cfg {String} vtype A validation type name as defined in {@link Ext.form.VTypes} (defaults to <tt>null</tt>)
  96.      */
  97.     vtype : null,
  98.     /**
  99.      * @cfg {RegExp} maskRe An input mask regular expression that will be used to filter keystrokes that do
  100.      * not match (defaults to <tt>null</tt>)
  101.      */
  102.     maskRe : null,
  103.     /**
  104.      * @cfg {Boolean} disableKeyFilter Specify <tt>true</tt> to disable input keystroke filtering (defaults
  105.      * to <tt>false</tt>)
  106.      */
  107.     disableKeyFilter : false,
  108.     /**
  109.      * @cfg {Boolean} allowBlank Specify <tt>false</tt> to validate that the value's length is > 0 (defaults to
  110.      * <tt>true</tt>)
  111.      */
  112.     allowBlank : true,
  113.     /**
  114.      * @cfg {Number} minLength Minimum input field length required (defaults to <tt>0</tt>)
  115.      */
  116.     minLength : 0,
  117.     /**
  118.      * @cfg {Number} maxLength Maximum input field length allowed by validation (defaults to Number.MAX_VALUE).
  119.      * This behavior is intended to provide instant feedback to the user by improving usability to allow pasting
  120.      * and editing or overtyping and back tracking. To restrict the maximum number of characters that can be
  121.      * entered into the field use <tt><b>{@link Ext.form.Field#autoCreate autoCreate}</b></tt> to add
  122.      * any attributes you want to a field, for example:<pre><code>
  123. var myField = new Ext.form.NumberField({
  124.     id: 'mobile',
  125.     anchor:'90%',
  126.     fieldLabel: 'Mobile',
  127.     maxLength: 16, // for validation
  128.     autoCreate: {tag: 'input', type: 'text', size: '20', autocomplete: 'off', maxlength: '10'}
  129. });
  130. </code></pre>
  131.      */
  132.     maxLength : Number.MAX_VALUE,
  133.     /**
  134.      * @cfg {String} minLengthText Error text to display if the <b><tt>{@link #minLength minimum length}</tt></b>
  135.      * validation fails (defaults to <tt>'The minimum length for this field is {minLength}'</tt>)
  136.      */
  137.     minLengthText : 'The minimum length for this field is {0}',
  138.     /**
  139.      * @cfg {String} maxLengthText Error text to display if the <b><tt>{@link #maxLength maximum length}</tt></b>
  140.      * validation fails (defaults to <tt>'The maximum length for this field is {maxLength}'</tt>)
  141.      */
  142.     maxLengthText : 'The maximum length for this field is {0}',
  143.     /**
  144.      * @cfg {Boolean} selectOnFocus <tt>true</tt> to automatically select any existing field text when the field
  145.      * receives input focus (defaults to <tt>false</tt>)
  146.      */
  147.     selectOnFocus : false,
  148.     /**
  149.      * @cfg {String} blankText The error text to display if the <b><tt>{@link #allowBlank}</tt></b> validation
  150.      * fails (defaults to <tt>'This field is required'</tt>)
  151.      */
  152.     blankText : 'This field is required',
  153.     /**
  154.      * @cfg {Function} validator A custom validation function to be called during field validation
  155.      * (defaults to <tt>null</tt>). If specified, this function will be called first, allowing the
  156.      * developer to override the default validation process. This function will be passed the current
  157.      * field value and expected to return boolean <tt>true</tt> if the value is valid or a string
  158.      * error message if invalid.
  159.      */
  160.     validator : null,
  161.     /**
  162.      * @cfg {RegExp} regex A JavaScript RegExp object to be tested against the field value during validation
  163.      * (defaults to <tt>null</tt>). If the test fails, the field will be marked invalid using
  164.      * <b><tt>{@link #regexText}</tt></b>.
  165.      */
  166.     regex : null,
  167.     /**
  168.      * @cfg {String} regexText The error text to display if <b><tt>{@link #regex}</tt></b> is used and the
  169.      * test fails during validation (defaults to <tt>''</tt>)
  170.      */
  171.     regexText : '',
  172.     /**
  173.      * @cfg {String} emptyText The default text to place into an empty field (defaults to <tt>null</tt>).
  174.      * <b>Note</b>: that this value will be submitted to the server if this field is enabled and configured
  175.      * with a {@link #name}.
  176.      */
  177.     emptyText : null,
  178.     /**
  179.      * @cfg {String} emptyClass The CSS class to apply to an empty field to style the <b><tt>{@link #emptyText}</tt></b>
  180.      * (defaults to <tt>'x-form-empty-field'</tt>).  This class is automatically added and removed as needed
  181.      * depending on the current field value.
  182.      */
  183.     emptyClass : 'x-form-empty-field',
  184.     /**
  185.      * @cfg {Boolean} enableKeyEvents <tt>true</tt> to enable the proxying of key events for the HTML input
  186.      * field (defaults to <tt>false</tt>)
  187.      */
  188.     initComponent : function(){
  189.         Ext.form.TextField.superclass.initComponent.call(this);
  190.         this.addEvents(
  191.             /**
  192.              * @event autosize
  193.              * Fires when the <tt><b>{@link #autoSize}</b></tt> function is triggered. The field may or
  194.              * may not have actually changed size according to the default logic, but this event provides
  195.              * a hook for the developer to apply additional logic at runtime to resize the field if needed.
  196.              * @param {Ext.form.Field} this This text field
  197.              * @param {Number} width The new field width
  198.              */
  199.             'autosize',
  200.             /**
  201.              * @event keydown
  202.              * Keydown input field event. This event only fires if <tt><b>{@link #enableKeyEvents}</b></tt>
  203.              * is set to true.
  204.              * @param {Ext.form.TextField} this This text field
  205.              * @param {Ext.EventObject} e
  206.              */
  207.             'keydown',
  208.             /**
  209.              * @event keyup
  210.              * Keyup input field event. This event only fires if <tt><b>{@link #enableKeyEvents}</b></tt>
  211.              * is set to true.
  212.              * @param {Ext.form.TextField} this This text field
  213.              * @param {Ext.EventObject} e
  214.              */
  215.             'keyup',
  216.             /**
  217.              * @event keypress
  218.              * Keypress input field event. This event only fires if <tt><b>{@link #enableKeyEvents}</b></tt>
  219.              * is set to true.
  220.              * @param {Ext.form.TextField} this This text field
  221.              * @param {Ext.EventObject} e
  222.              */
  223.             'keypress'
  224.         );
  225.     },
  226.     // private
  227.     initEvents : function(){
  228.         Ext.form.TextField.superclass.initEvents.call(this);
  229.         if(this.validationEvent == 'keyup'){
  230.             this.validationTask = new Ext.util.DelayedTask(this.validate, this);
  231.             this.mon(this.el, 'keyup', this.filterValidation, this);
  232.         }
  233.         else if(this.validationEvent !== false){
  234.          this.mon(this.el, this.validationEvent, this.validate, this, {buffer: this.validationDelay});
  235.         }
  236.         if(this.selectOnFocus || this.emptyText){
  237.             this.on('focus', this.preFocus, this);
  238.             
  239.             this.mon(this.el, 'mousedown', function(){
  240.                 if(!this.hasFocus){
  241.                     this.el.on('mouseup', function(e){
  242.                         e.preventDefault();
  243.                     }, this, {single:true});
  244.                 }
  245.             }, this);
  246.             
  247.             if(this.emptyText){
  248.                 this.on('blur', this.postBlur, this);
  249.                 this.applyEmptyText();
  250.             }
  251.         }
  252.         if(this.maskRe || (this.vtype && this.disableKeyFilter !== true && (this.maskRe = Ext.form.VTypes[this.vtype+'Mask']))){
  253.          this.mon(this.el, 'keypress', this.filterKeys, this);
  254.         }
  255.         if(this.grow){
  256.          this.mon(this.el, 'keyup', this.onKeyUpBuffered, this, {buffer: 50});
  257. this.mon(this.el, 'click', this.autoSize, this);
  258.         }
  259.         if(this.enableKeyEvents){
  260.          this.mon(this.el, 'keyup', this.onKeyUp, this);
  261.          this.mon(this.el, 'keydown', this.onKeyDown, this);
  262.          this.mon(this.el, 'keypress', this.onKeyPress, this);
  263.         }
  264.     },
  265.     processValue : function(value){
  266.         if(this.stripCharsRe){
  267.             var newValue = value.replace(this.stripCharsRe, '');
  268.             if(newValue !== value){
  269.                 this.setRawValue(newValue);
  270.                 return newValue;
  271.             }
  272.         }
  273.         return value;
  274.     },
  275.     filterValidation : function(e){
  276.         if(!e.isNavKeyPress()){
  277.             this.validationTask.delay(this.validationDelay);
  278.         }
  279.     },
  280.     
  281.     //private
  282.     onDisable: function(){
  283.         Ext.form.TextField.superclass.onDisable.call(this);
  284.         if(Ext.isIE){
  285.             this.el.dom.unselectable = 'on';
  286.         }
  287.     },
  288.     
  289.     //private
  290.     onEnable: function(){
  291.         Ext.form.TextField.superclass.onEnable.call(this);
  292.         if(Ext.isIE){
  293.             this.el.dom.unselectable = '';
  294.         }
  295.     },
  296.     // private
  297.     onKeyUpBuffered : function(e){
  298.         if(!e.isNavKeyPress()){
  299.             this.autoSize();
  300.         }
  301.     },
  302.     // private
  303.     onKeyUp : function(e){
  304.         this.fireEvent('keyup', this, e);
  305.     },
  306.     // private
  307.     onKeyDown : function(e){
  308.         this.fireEvent('keydown', this, e);
  309.     },
  310.     // private
  311.     onKeyPress : function(e){
  312.         this.fireEvent('keypress', this, e);
  313.     },
  314.     /**
  315.      * Resets the current field value to the originally-loaded value and clears any validation messages.
  316.      * Also adds <tt><b>{@link #emptyText}</b></tt> and <tt><b>{@link #emptyClass}</b></tt> if the
  317.      * original value was blank.
  318.      */
  319.     reset : function(){
  320.         Ext.form.TextField.superclass.reset.call(this);
  321.         this.applyEmptyText();
  322.     },
  323.     applyEmptyText : function(){
  324.         if(this.rendered && this.emptyText && this.getRawValue().length < 1 && !this.hasFocus){
  325.             this.setRawValue(this.emptyText);
  326.             this.el.addClass(this.emptyClass);
  327.         }
  328.     },
  329.     // private
  330.     preFocus : function(){
  331.         var el = this.el;
  332.         if(this.emptyText){
  333.             if(el.dom.value == this.emptyText){
  334.                 this.setRawValue('');
  335.             }
  336.             el.removeClass(this.emptyClass);
  337.         }
  338.         if(this.selectOnFocus){
  339.             (function(){
  340.                 el.dom.select();
  341.             }).defer(this.inEditor && Ext.isIE ? 50 : 0);    
  342.         }
  343.     },
  344.     // private
  345.     postBlur : function(){
  346.         this.applyEmptyText();
  347.     },
  348.     // private
  349.     filterKeys : function(e){
  350.         // special keys don't generate charCodes, so leave them alone
  351.         if(e.ctrlKey || e.isSpecialKey()){
  352.             return;
  353.         }
  354.         
  355.         if(!this.maskRe.test(String.fromCharCode(e.getCharCode()))){
  356.             e.stopEvent();
  357.         }
  358.     },
  359.     setValue : function(v){
  360.         if(this.emptyText && this.el && !Ext.isEmpty(v)){
  361.             this.el.removeClass(this.emptyClass);
  362.         }
  363.         Ext.form.TextField.superclass.setValue.apply(this, arguments);
  364.         this.applyEmptyText();
  365.         this.autoSize();
  366.         return this;
  367.     },
  368.     /**
  369.      * Validates a value according to the field's validation rules and marks the field as invalid
  370.      * if the validation fails
  371.      * @param {Mixed} value The value to validate
  372.      * @return {Boolean} True if the value is valid, else false
  373.      */
  374.     validateValue : function(value){
  375.         if(Ext.isFunction(this.validator)){
  376.             var msg = this.validator(value);
  377.             if(msg !== true){
  378.                 this.markInvalid(msg);
  379.                 return false;
  380.             }
  381.         }
  382.         if(value.length < 1 || value === this.emptyText){ // if it's blank
  383.              if(this.allowBlank){
  384.                  this.clearInvalid();
  385.                  return true;
  386.              }else{
  387.                  this.markInvalid(this.blankText);
  388.                  return false;
  389.              }
  390.         }
  391.         if(value.length < this.minLength){
  392.             this.markInvalid(String.format(this.minLengthText, this.minLength));
  393.             return false;
  394.         }
  395.         if(value.length > this.maxLength){
  396.             this.markInvalid(String.format(this.maxLengthText, this.maxLength));
  397.             return false;
  398.         }
  399.         if(this.vtype){
  400.             var vt = Ext.form.VTypes;
  401.             if(!vt[this.vtype](value, this)){
  402.                 this.markInvalid(this.vtypeText || vt[this.vtype +'Text']);
  403.                 return false;
  404.             }
  405.         }
  406.         if(this.regex && !this.regex.test(value)){
  407.             this.markInvalid(this.regexText);
  408.             return false;
  409.         }
  410.         return true;
  411.     },
  412.     /**
  413.      * Selects text in this field
  414.      * @param {Number} start (optional) The index where the selection should start (defaults to 0)
  415.      * @param {Number} end (optional) The index where the selection should end (defaults to the text length)
  416.      */
  417.     selectText : function(start, end){
  418.         var v = this.getRawValue();
  419.         var doFocus = false;
  420.         if(v.length > 0){
  421.             start = start === undefined ? 0 : start;
  422.             end = end === undefined ? v.length : end;
  423.             var d = this.el.dom;
  424.             if(d.setSelectionRange){
  425.                 d.setSelectionRange(start, end);
  426.             }else if(d.createTextRange){
  427.                 var range = d.createTextRange();
  428.                 range.moveStart('character', start);
  429.                 range.moveEnd('character', end-v.length);
  430.                 range.select();
  431.             }
  432.             doFocus = Ext.isGecko || Ext.isOpera;
  433.         }else{
  434.             doFocus = true;
  435.         }
  436.         if(doFocus){
  437.             this.focus();
  438.         }
  439.     },
  440.     /**
  441.      * Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.
  442.      * This only takes effect if <tt><b>{@link #grow}</b> = true</tt>, and fires the {@link #autosize} event.
  443.      */
  444.     autoSize : function(){
  445.         if(!this.grow || !this.rendered){
  446.             return;
  447.         }
  448.         if(!this.metrics){
  449.             this.metrics = Ext.util.TextMetrics.createInstance(this.el);
  450.         }
  451.         var el = this.el;
  452.         var v = el.dom.value;
  453.         var d = document.createElement('div');
  454.         d.appendChild(document.createTextNode(v));
  455.         v = d.innerHTML;
  456.         d = null;
  457.         Ext.removeNode(d);
  458.         v += '&#160;';
  459.         var w = Math.min(this.growMax, Math.max(this.metrics.getWidth(v) + /* add extra padding */ 10, this.growMin));
  460.         this.el.setWidth(w);
  461.         this.fireEvent('autosize', this, w);
  462.     },
  463. onDestroy: function(){
  464. if(this.validationTask){
  465. this.validationTask.cancel();
  466. this.validationTask = null;
  467. }
  468. Ext.form.TextField.superclass.onDestroy.call(this);
  469. }
  470. });
  471. Ext.reg('textfield', Ext.form.TextField);