9 * @class Roo.bootstrap.Input
10 * @extends Roo.bootstrap.Component
11 * Bootstrap Input class
12 * @cfg {Boolean} disabled is it disabled
13 * @cfg {String} inputType button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text
14 * @cfg {String} name name of the input
15 * @cfg {string} fieldLabel - the label associated
16 * @cfg {string} placeholder - placeholder to put in text.
17 * @cfg {string} before - input group add on before
18 * @cfg {string} after - input group add on after
19 * @cfg {string} size - (lg|sm) or leave empty..
20 * @cfg {Number} xs colspan out of 12 for mobile-sized screens
21 * @cfg {Number} sm colspan out of 12 for tablet-sized screens
22 * @cfg {Number} md colspan out of 12 for computer-sized screens
23 * @cfg {Number} lg colspan out of 12 for large computer-sized screens
24 * @cfg {string} value default value of the input
25 * @cfg {Number} labelWidth set the width of label
26 * @cfg {Number} labellg set the width of label (1-12)
27 * @cfg {Number} labelmd set the width of label (1-12)
28 * @cfg {Number} labelsm set the width of label (1-12)
29 * @cfg {Number} labelxs set the width of label (1-12)
30 * @cfg {String} labelAlign (top|left)
31 * @cfg {Boolean} readOnly Specifies that the field should be read-only
32 * @cfg {String} autocomplete - default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en
33 * @cfg {String} indicatorpos (left|right) default left
35 * @cfg {String} align (left|center|right) Default left
36 * @cfg {Boolean} forceFeedback (true|false) Default false
43 * @param {Object} config The config object
46 Roo.bootstrap.Input = function(config){
48 Roo.bootstrap.Input.superclass.constructor.call(this, config);
53 * Fires when this field receives input focus.
54 * @param {Roo.form.Field} this
59 * Fires when this field loses input focus.
60 * @param {Roo.form.Field} this
65 * Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check
66 * {@link Roo.EventObject#getKey} to determine which key was pressed.
67 * @param {Roo.form.Field} this
68 * @param {Roo.EventObject} e The event object
73 * Fires just before the field blurs if the field value has changed.
74 * @param {Roo.form.Field} this
75 * @param {Mixed} newValue The new value
76 * @param {Mixed} oldValue The original value
81 * Fires after the field has been marked as invalid.
82 * @param {Roo.form.Field} this
83 * @param {String} msg The validation message
88 * Fires after the field has been validated with no errors.
89 * @param {Roo.form.Field} this
94 * Fires after the key up
95 * @param {Roo.form.Field} this
96 * @param {Roo.EventObject} e The event Object
102 Roo.extend(Roo.bootstrap.Input, Roo.bootstrap.Component, {
104 * @cfg {String/Boolean} validationEvent The event that should initiate field validation. Set to false to disable
105 automatic validation (defaults to "keyup").
107 validationEvent : "keyup",
109 * @cfg {Boolean} validateOnBlur Whether the field should validate when it loses focus (defaults to true).
111 validateOnBlur : true,
113 * @cfg {Number} validationDelay The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)
115 validationDelay : 250,
117 * @cfg {String} focusClass The CSS class to use when the field receives focus (defaults to "x-form-focus")
119 focusClass : "x-form-focus", // not needed???
123 * @cfg {String} invalidClass The CSS class to use when marking a field invalid (defaults to "x-form-invalid")
125 invalidClass : "has-warning",
128 * @cfg {String} validClass The CSS class to use when marking a field valid (defaults to "x-form-invalid")
130 validClass : "has-success",
133 * @cfg {Boolean} hasFeedback (true|false) default true
138 * @cfg {String} invalidFeedbackIcon The CSS class to use when create feedback icon (defaults to "x-form-invalid")
140 invalidFeedbackClass : "glyphicon-warning-sign",
143 * @cfg {String} validFeedbackIcon The CSS class to use when create feedback icon (defaults to "x-form-invalid")
145 validFeedbackClass : "glyphicon-ok",
148 * @cfg {Boolean} selectOnFocus True to automatically select any existing field text when the field receives input focus (defaults to false)
150 selectOnFocus : false,
153 * @cfg {String} maskRe An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)
157 * @cfg {String} vtype A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)
162 * @cfg {Boolean} disableKeyFilter True to disable input keystroke filtering (defaults to false)
164 disableKeyFilter : false,
167 * @cfg {Boolean} disabled True to disable the field (defaults to false).
171 * @cfg {Boolean} allowBlank False to validate that the value length > 0 (defaults to true)
175 * @cfg {String} blankText Error text to display if the allow blank validation fails (defaults to "This field is required")
177 blankText : "Please complete this mandatory field",
180 * @cfg {Number} minLength Minimum input field length required (defaults to 0)
184 * @cfg {Number} maxLength Maximum input field length allowed (defaults to Number.MAX_VALUE)
186 maxLength : Number.MAX_VALUE,
188 * @cfg {String} minLengthText Error text to display if the minimum length validation fails (defaults to "The minimum length for this field is {minLength}")
190 minLengthText : "The minimum length for this field is {0}",
192 * @cfg {String} maxLengthText Error text to display if the maximum length validation fails (defaults to "The maximum length for this field is {maxLength}")
194 maxLengthText : "The maximum length for this field is {0}",
198 * @cfg {Function} validator A custom validation function to be called during field validation (defaults to null).
199 * If available, this function will be called only after the basic validators all return true, and will be passed the
200 * current field value and expected to return boolean true if the value is valid or a string error message if invalid.
204 * @cfg {RegExp} regex A JavaScript RegExp object to be tested against the field value during validation (defaults to null).
205 * If available, this regex will be evaluated only after the basic validators all return true, and will be passed the
206 * current field value. If the test fails, the field will be marked invalid using {@link #regexText}.
210 * @cfg {String} regexText The error text to display if {@link #regex} is used and the test fails during validation (defaults to "")
214 * @cfg {String} regexText The error text to display if {@link #regex} is used and the test fails during validation (defaults to "")
239 formatedValue : false,
240 forceFeedback : false,
242 indicatorpos : 'left',
249 parentLabelAlign : function()
252 while (parent.parent()) {
253 parent = parent.parent();
254 if (typeof(parent.labelAlign) !='undefined') {
255 return parent.labelAlign;
262 getAutoCreate : function()
264 var align = (!this.labelAlign) ? this.parentLabelAlign() : this.labelAlign;
270 if(this.inputType != 'hidden'){
271 cfg.cls = 'form-group' //input-group
277 type : this.inputType,
279 cls : 'form-control',
280 placeholder : this.placeholder || '',
281 autocomplete : this.autocomplete || 'new-password'
285 input.style = (typeof(input.style) == 'undefined') ? ('text-align:' + this.align) : (input.style + 'text-align:' + this.align);
288 if(this.maxLength && this.maxLength != Number.MAX_VALUE){
289 input.maxLength = this.maxLength;
301 input.name = this.name;
305 input.cls += ' input-' + this.size;
309 ['xs','sm','md','lg'].map(function(size){
310 if (settings[size]) {
311 cfg.cls += ' col-' + size + '-' + settings[size];
315 var inputblock = input;
319 cls: 'glyphicon form-control-feedback'
322 if(this.hasFeedback && this.inputType != 'hidden' && !this.allowBlank){
325 cls : 'has-feedback',
333 if (this.before || this.after) {
340 if (this.before && typeof(this.before) == 'string') {
344 cls : 'roo-input-before input-group-addon',
348 if (this.before && typeof(this.before) == 'object') {
349 this.before = Roo.factory(this.before);
353 cls : 'roo-input-before input-group-' +
354 (this.before.xtype == 'Button' ? 'btn' : 'addon') //?? what about checkboxes - that looks like a bit of a hack thought?
358 inputblock.cn.push(input);
360 if (this.after && typeof(this.after) == 'string') {
363 cls : 'roo-input-after input-group-addon',
367 if (this.after && typeof(this.after) == 'object') {
368 this.after = Roo.factory(this.after);
372 cls : 'roo-input-after input-group-' +
373 (this.after.xtype == 'Button' ? 'btn' : 'addon') //?? what about checkboxes - that looks like a bit of a hack thought?
377 if(this.hasFeedback && this.inputType != 'hidden' && !this.allowBlank){
378 inputblock.cls += ' has-feedback';
379 inputblock.cn.push(feedback);
383 if (align ==='left' && this.fieldLabel.length) {
385 cfg.cls += ' roo-form-group-label-left';
390 cls : 'roo-required-indicator left-indicator text-danger fa fa-lg fa-star',
391 tooltip : 'This field is required'
396 cls : 'control-label',
397 html : this.fieldLabel
408 var labelCfg = cfg.cn[1];
409 var contentCfg = cfg.cn[2];
411 if(this.indicatorpos == 'right'){
416 cls : 'control-label',
417 html : this.fieldLabel
422 cls : 'roo-required-indicator right-indicator text-danger fa fa-lg fa-star',
423 tooltip : 'This field is required'
434 labelCfg = cfg.cn[0];
435 contentCfg = cfg.cn[2];
439 if(this.labelWidth > 12){
440 labelCfg.style = "width: " + this.labelWidth + 'px';
443 if(this.labelWidth < 13 && this.labelmd == 0){
444 this.labelmd = this.labelWidth;
447 if(this.labellg > 0){
448 labelCfg.cls += ' col-lg-' + this.labellg;
449 contentCfg.cls += ' col-lg-' + (12 - this.labellg);
452 if(this.labelmd > 0){
453 labelCfg.cls += ' col-md-' + this.labelmd;
454 contentCfg.cls += ' col-md-' + (12 - this.labelmd);
457 if(this.labelsm > 0){
458 labelCfg.cls += ' col-sm-' + this.labelsm;
459 contentCfg.cls += ' col-sm-' + (12 - this.labelsm);
462 if(this.labelxs > 0){
463 labelCfg.cls += ' col-xs-' + this.labelxs;
464 contentCfg.cls += ' col-xs-' + (12 - this.labelxs);
468 } else if ( this.fieldLabel.length) {
473 cls : 'roo-required-indicator left-indicator text-danger fa fa-lg fa-star',
474 tooltip : 'This field is required'
478 //cls : 'input-group-addon',
479 html : this.fieldLabel
487 if(this.indicatorpos == 'right'){
492 //cls : 'input-group-addon',
493 html : this.fieldLabel
498 cls : 'roo-required-indicator right-indicator text-danger fa fa-lg fa-star',
499 tooltip : 'This field is required'
519 if (this.parentType === 'Navbar' && this.parent().bar) {
520 cfg.cls += ' navbar-form';
523 if (this.parentType === 'NavGroup') {
524 cfg.cls += ' navbar-form';
532 * return the real input element.
536 return this.el.select('input.form-control',true).first();
539 tooltipEl : function()
541 return this.inputEl();
544 indicatorEl : function()
546 var indicator = this.el.select('i.roo-required-indicator',true).first();
556 setDisabled : function(v)
558 var i = this.inputEl().dom;
560 i.removeAttribute('disabled');
564 i.setAttribute('disabled','true');
566 initEvents : function()
569 this.inputEl().on("keydown" , this.fireKey, this);
570 this.inputEl().on("focus", this.onFocus, this);
571 this.inputEl().on("blur", this.onBlur, this);
573 this.inputEl().relayEvent('keyup', this);
575 this.indicator = this.indicatorEl();
578 this.indicator.setVisibilityMode(Roo.Element.DISPLAY);
579 this.indicator.hide();
582 // reference to original value for reset
583 this.originalValue = this.getValue();
584 //Roo.form.TextField.superclass.initEvents.call(this);
585 if(this.validationEvent == 'keyup'){
586 this.validationTask = new Roo.util.DelayedTask(this.validate, this);
587 this.inputEl().on('keyup', this.filterValidation, this);
589 else if(this.validationEvent !== false){
590 this.inputEl().on(this.validationEvent, this.validate, this, {buffer: this.validationDelay});
593 if(this.selectOnFocus){
594 this.on("focus", this.preFocus, this);
597 if(this.maskRe || (this.vtype && this.disableKeyFilter !== true && (this.maskRe = Roo.form.VTypes[this.vtype+'Mask']))){
598 this.inputEl().on("keypress", this.filterKeys, this);
600 this.inputEl().relayEvent('keypress', this);
603 this.el.on("keyup", this.onKeyUp, this, {buffer:50});
604 this.el.on("click", this.autoSize, this);
607 if(this.inputEl().is('input[type=password]') && Roo.isSafari){
608 this.inputEl().on('keydown', this.SafariOnKeyDown, this);
611 if (typeof(this.before) == 'object') {
612 this.before.render(this.el.select('.roo-input-before',true).first());
614 if (typeof(this.after) == 'object') {
615 this.after.render(this.el.select('.roo-input-after',true).first());
620 filterValidation : function(e){
621 if(!e.isNavKeyPress()){
622 this.validationTask.delay(this.validationDelay);
626 * Validates the field value
627 * @return {Boolean} True if the value is valid, else false
629 validate : function(){
630 //if(this.disabled || this.validateValue(this.processValue(this.getRawValue()))){
631 if(this.disabled || this.validateValue(this.getRawValue())){
642 * Validates a value according to the field's validation rules and marks the field as invalid
643 * if the validation fails
644 * @param {Mixed} value The value to validate
645 * @return {Boolean} True if the value is valid, else false
647 validateValue : function(value){
648 if(value.length < 1) { // if it's blank
652 return this.inputEl().hasClass('hide') ? true : false;
655 if(value.length < this.minLength){
658 if(value.length > this.maxLength){
662 var vt = Roo.form.VTypes;
663 if(!vt[this.vtype](value, this)){
667 if(typeof this.validator == "function"){
668 var msg = this.validator(value);
674 if(this.regex && !this.regex.test(value)){
684 fireKey : function(e){
685 //Roo.log('field ' + e.getKey());
686 if(e.isNavKeyPress()){
687 this.fireEvent("specialkey", this, e);
690 focus : function (selectText){
692 this.inputEl().focus();
693 if(selectText === true){
694 this.inputEl().dom.select();
700 onFocus : function(){
701 if(!Roo.isOpera && this.focusClass){ // don't touch in Opera
702 // this.el.addClass(this.focusClass);
705 this.hasFocus = true;
706 this.startValue = this.getValue();
707 this.fireEvent("focus", this);
711 beforeBlur : Roo.emptyFn,
717 if(!Roo.isOpera && this.focusClass){ // don't touch in Opera
718 //this.el.removeClass(this.focusClass);
720 this.hasFocus = false;
721 if(this.validationEvent !== false && this.validateOnBlur && this.validationEvent != "blur"){
724 var v = this.getValue();
725 if(String(v) !== String(this.startValue)){
726 this.fireEvent('change', this, v, this.startValue);
728 this.fireEvent("blur", this);
732 * Resets the current field value to the originally loaded value and clears any validation messages
735 this.setValue(this.originalValue);
739 * Returns the name of the field
740 * @return {Mixed} name The name field
746 * Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.
747 * @return {Mixed} value The field value
749 getValue : function(){
751 var v = this.inputEl().getValue();
756 * Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.
757 * @return {Mixed} value The field value
759 getRawValue : function(){
760 var v = this.inputEl().getValue();
766 * Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.
767 * @param {Mixed} value The value to set
769 setRawValue : function(v){
770 return this.inputEl().dom.value = (v === null || v === undefined ? '' : v);
773 selectText : function(start, end){
774 var v = this.getRawValue();
776 start = start === undefined ? 0 : start;
777 end = end === undefined ? v.length : end;
778 var d = this.inputEl().dom;
779 if(d.setSelectionRange){
780 d.setSelectionRange(start, end);
781 }else if(d.createTextRange){
782 var range = d.createTextRange();
783 range.moveStart("character", start);
784 range.moveEnd("character", v.length-end);
791 * Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.
792 * @param {Mixed} value The value to set
794 setValue : function(v){
797 this.inputEl().dom.value = (v === null || v === undefined ? '' : v);
803 processValue : function(value){
804 if(this.stripCharsRe){
805 var newValue = value.replace(this.stripCharsRe, '');
806 if(newValue !== value){
807 this.setRawValue(newValue);
814 preFocus : function(){
816 if(this.selectOnFocus){
817 this.inputEl().dom.select();
820 filterKeys : function(e){
822 if(!Roo.isIE && (e.isNavKeyPress() || k == e.BACKSPACE || (k == e.DELETE && e.button == -1))){
825 var c = e.getCharCode(), cc = String.fromCharCode(c);
826 if(Roo.isIE && (e.isSpecialKey() || !cc)){
829 if(!this.maskRe.test(cc)){
834 * Clear any invalid styles/messages for this field
836 clearInvalid : function(){
838 if(!this.el || this.preventMark){ // not rendered
843 this.el.removeClass(this.invalidClass);
845 if(this.hasFeedback && this.inputType != 'hidden' && !this.allowBlank){
847 var feedback = this.el.select('.form-control-feedback', true).first();
850 this.el.select('.form-control-feedback', true).first().removeClass(this.invalidFeedbackClass);
855 this.fireEvent('valid', this);
859 * Mark this field as valid
861 markValid : function()
863 if(!this.el || this.preventMark){ // not rendered...
867 this.el.removeClass([this.invalidClass, this.validClass]);
869 var feedback = this.el.select('.form-control-feedback', true).first();
872 this.el.select('.form-control-feedback', true).first().removeClass([this.invalidFeedbackClass, this.validFeedbackClass]);
879 if(this.allowBlank && !this.getRawValue().length){
884 this.indicator.hide();
887 this.el.addClass(this.validClass);
889 if(this.hasFeedback && this.inputType != 'hidden' && !this.allowBlank && (this.getValue().length || this.forceFeedback)){
891 var feedback = this.el.select('.form-control-feedback', true).first();
894 this.el.select('.form-control-feedback', true).first().removeClass([this.invalidFeedbackClass, this.validFeedbackClass]);
895 this.el.select('.form-control-feedback', true).first().addClass([this.validFeedbackClass]);
900 this.fireEvent('valid', this);
904 * Mark this field as invalid
905 * @param {String} msg The validation message
907 markInvalid : function(msg)
909 if(!this.el || this.preventMark){ // not rendered
913 this.el.removeClass([this.invalidClass, this.validClass]);
915 var feedback = this.el.select('.form-control-feedback', true).first();
918 this.el.select('.form-control-feedback', true).first().removeClass([this.invalidFeedbackClass, this.validFeedbackClass]);
925 if(this.allowBlank && !this.getRawValue().length){
930 this.indicator.show();
933 this.el.addClass(this.invalidClass);
935 if(this.hasFeedback && this.inputType != 'hidden' && !this.allowBlank){
937 var feedback = this.el.select('.form-control-feedback', true).first();
940 this.el.select('.form-control-feedback', true).first().removeClass([this.invalidFeedbackClass, this.validFeedbackClass]);
942 if(this.getValue().length || this.forceFeedback){
943 this.el.select('.form-control-feedback', true).first().addClass([this.invalidFeedbackClass]);
950 this.fireEvent('invalid', this, msg);
953 SafariOnKeyDown : function(event)
955 // this is a workaround for a password hang bug on chrome/ webkit.
956 if (this.inputEl().dom.type != 'password') {
960 var isSelectAll = false;
962 if(this.inputEl().dom.selectionEnd > 0){
963 isSelectAll = (this.inputEl().dom.selectionEnd - this.inputEl().dom.selectionStart - this.getValue().length == 0) ? true : false;
965 if(((event.getKey() == 8 || event.getKey() == 46) && this.getValue().length ==1)){ // backspace and delete key
966 event.preventDefault();
971 if(isSelectAll && event.getCharCode() > 31 && !event.ctrlKey) { // not backspace and delete key (or ctrl-v)
973 event.preventDefault();
974 // this is very hacky as keydown always get's upper case.
976 var cc = String.fromCharCode(event.getCharCode());
977 this.setValue( event.shiftKey ? cc : cc.toLowerCase());
981 adjustWidth : function(tag, w){
982 tag = tag.toLowerCase();
983 if(typeof w == 'number' && Roo.isStrict && !Roo.isSafari){
984 if(Roo.isIE && (tag == 'input' || tag == 'textarea')){
988 if(tag == 'textarea'){
991 }else if(Roo.isOpera){
995 if(tag == 'textarea'){