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
34 * @cfg {String} capture (user|camera) use for file input only. (default empty)
35 * @cfg {String} accept (image|video|audio) use for file input only. (default empty)
37 * @cfg {String} align (left|center|right) Default left
38 * @cfg {Boolean} forceFeedback (true|false) Default false
42 * @param {Object} config The config object
45 Roo.bootstrap.Input = function(config){
47 Roo.bootstrap.Input.superclass.constructor.call(this, config);
52 * Fires when this field receives input focus.
53 * @param {Roo.form.Field} this
58 * Fires when this field loses input focus.
59 * @param {Roo.form.Field} this
64 * Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check
65 * {@link Roo.EventObject#getKey} to determine which key was pressed.
66 * @param {Roo.form.Field} this
67 * @param {Roo.EventObject} e The event object
72 * Fires just before the field blurs if the field value has changed.
73 * @param {Roo.form.Field} this
74 * @param {Mixed} newValue The new value
75 * @param {Mixed} oldValue The original value
80 * Fires after the field has been marked as invalid.
81 * @param {Roo.form.Field} this
82 * @param {String} msg The validation message
87 * Fires after the field has been validated with no errors.
88 * @param {Roo.form.Field} this
93 * Fires after the key up
94 * @param {Roo.form.Field} this
95 * @param {Roo.EventObject} e The event Object
101 Roo.extend(Roo.bootstrap.Input, Roo.bootstrap.Component, {
103 * @cfg {String/Boolean} validationEvent The event that should initiate field validation. Set to false to disable
104 automatic validation (defaults to "keyup").
106 validationEvent : "keyup",
108 * @cfg {Boolean} validateOnBlur Whether the field should validate when it loses focus (defaults to true).
110 validateOnBlur : true,
112 * @cfg {Number} validationDelay The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)
114 validationDelay : 250,
116 * @cfg {String} focusClass The CSS class to use when the field receives focus (defaults to "x-form-focus")
118 focusClass : "x-form-focus", // not needed???
122 * @cfg {String} invalidClass The CSS class to use when marking a field invalid (defaults to "x-form-invalid")
124 invalidClass : "has-warning",
127 * @cfg {String} validClass The CSS class to use when marking a field valid (defaults to "x-form-invalid")
129 validClass : "has-success",
132 * @cfg {Boolean} hasFeedback (true|false) default true
137 * @cfg {String} invalidFeedbackIcon The CSS class to use when create feedback icon (defaults to "x-form-invalid")
139 invalidFeedbackClass : "glyphicon-warning-sign",
142 * @cfg {String} validFeedbackIcon The CSS class to use when create feedback icon (defaults to "x-form-invalid")
144 validFeedbackClass : "glyphicon-ok",
147 * @cfg {Boolean} selectOnFocus True to automatically select any existing field text when the field receives input focus (defaults to false)
149 selectOnFocus : false,
152 * @cfg {String} maskRe An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)
156 * @cfg {String} vtype A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)
161 * @cfg {Boolean} disableKeyFilter True to disable input keystroke filtering (defaults to false)
163 disableKeyFilter : false,
166 * @cfg {Boolean} disabled True to disable the field (defaults to false).
170 * @cfg {Boolean} allowBlank False to validate that the value length > 0 (defaults to true)
174 * @cfg {String} blankText Error text to display if the allow blank validation fails (defaults to "This field is required")
176 blankText : "Please complete this mandatory field",
179 * @cfg {Number} minLength Minimum input field length required (defaults to 0)
183 * @cfg {Number} maxLength Maximum input field length allowed (defaults to Number.MAX_VALUE)
185 maxLength : Number.MAX_VALUE,
187 * @cfg {String} minLengthText Error text to display if the minimum length validation fails (defaults to "The minimum length for this field is {minLength}")
189 minLengthText : "The minimum length for this field is {0}",
191 * @cfg {String} maxLengthText Error text to display if the maximum length validation fails (defaults to "The maximum length for this field is {maxLength}")
193 maxLengthText : "The maximum length for this field is {0}",
197 * @cfg {Function} validator A custom validation function to be called during field validation (defaults to null).
198 * If available, this function will be called only after the basic validators all return true, and will be passed the
199 * current field value and expected to return boolean true if the value is valid or a string error message if invalid.
203 * @cfg {RegExp} regex A JavaScript RegExp object to be tested against the field value during validation (defaults to null).
204 * If available, this regex will be evaluated only after the basic validators all return true, and will be passed the
205 * current field value. If the test fails, the field will be marked invalid using {@link #regexText}.
209 * @cfg {String} regexText -- Depricated - use Invalid Text
214 * @cfg {String} invalidText The error text to display if {@link #validator} test fails during validation (defaults to "")
239 formatedValue : false,
240 forceFeedback : false,
242 indicatorpos : 'left',
252 parentLabelAlign : function()
255 while (parent.parent()) {
256 parent = parent.parent();
257 if (typeof(parent.labelAlign) !='undefined') {
258 return parent.labelAlign;
265 getAutoCreate : function()
267 var align = (!this.labelAlign) ? this.parentLabelAlign() : this.labelAlign;
273 if(this.inputType != 'hidden'){
274 cfg.cls = 'form-group' //input-group
280 type : this.inputType,
282 cls : 'form-control',
283 placeholder : this.placeholder || '',
284 autocomplete : this.autocomplete || 'new-password'
287 if(this.capture.length){
288 input.capture = this.capture;
291 if(this.accept.length){
292 input.accept = this.accept + "/*";
296 input.style = (typeof(input.style) == 'undefined') ? ('text-align:' + this.align) : (input.style + 'text-align:' + this.align);
299 if(this.maxLength && this.maxLength != Number.MAX_VALUE){
300 input.maxLength = this.maxLength;
312 input.name = this.name;
316 input.cls += ' input-' + this.size;
320 ['xs','sm','md','lg'].map(function(size){
321 if (settings[size]) {
322 cfg.cls += ' col-' + size + '-' + settings[size];
326 var inputblock = input;
330 cls: 'glyphicon form-control-feedback'
333 if(this.hasFeedback && this.inputType != 'hidden' && !this.allowBlank){
336 cls : 'has-feedback',
344 if (this.before || this.after) {
351 if (this.before && typeof(this.before) == 'string') {
355 cls : 'roo-input-before input-group-addon',
359 if (this.before && typeof(this.before) == 'object') {
360 this.before = Roo.factory(this.before);
364 cls : 'roo-input-before input-group-' +
365 (this.before.xtype == 'Button' ? 'btn' : 'addon') //?? what about checkboxes - that looks like a bit of a hack thought?
369 inputblock.cn.push(input);
371 if (this.after && typeof(this.after) == 'string') {
374 cls : 'roo-input-after input-group-addon',
378 if (this.after && typeof(this.after) == 'object') {
379 this.after = Roo.factory(this.after);
383 cls : 'roo-input-after input-group-' +
384 (this.after.xtype == 'Button' ? 'btn' : 'addon') //?? what about checkboxes - that looks like a bit of a hack thought?
388 if(this.hasFeedback && this.inputType != 'hidden' && !this.allowBlank){
389 inputblock.cls += ' has-feedback';
390 inputblock.cn.push(feedback);
394 if (align ==='left' && this.fieldLabel.length) {
396 cfg.cls += ' roo-form-group-label-left';
401 cls : 'roo-required-indicator left-indicator text-danger fa fa-lg fa-star',
402 tooltip : 'This field is required'
407 cls : 'control-label',
408 html : this.fieldLabel
419 var labelCfg = cfg.cn[1];
420 var contentCfg = cfg.cn[2];
422 if(this.indicatorpos == 'right'){
427 cls : 'control-label',
431 html : this.fieldLabel
435 cls : 'roo-required-indicator right-indicator text-danger fa fa-lg fa-star',
436 tooltip : 'This field is required'
449 labelCfg = cfg.cn[0];
450 contentCfg = cfg.cn[1];
454 if(this.labelWidth > 12){
455 labelCfg.style = "width: " + this.labelWidth + 'px';
458 if(this.labelWidth < 13 && this.labelmd == 0){
459 this.labelmd = this.labelWidth;
462 if(this.labellg > 0){
463 labelCfg.cls += ' col-lg-' + this.labellg;
464 contentCfg.cls += ' col-lg-' + (12 - this.labellg);
467 if(this.labelmd > 0){
468 labelCfg.cls += ' col-md-' + this.labelmd;
469 contentCfg.cls += ' col-md-' + (12 - this.labelmd);
472 if(this.labelsm > 0){
473 labelCfg.cls += ' col-sm-' + this.labelsm;
474 contentCfg.cls += ' col-sm-' + (12 - this.labelsm);
477 if(this.labelxs > 0){
478 labelCfg.cls += ' col-xs-' + this.labelxs;
479 contentCfg.cls += ' col-xs-' + (12 - this.labelxs);
483 } else if ( this.fieldLabel.length) {
488 cls : 'roo-required-indicator left-indicator text-danger fa fa-lg fa-star',
489 tooltip : 'This field is required'
493 //cls : 'input-group-addon',
494 html : this.fieldLabel
502 if(this.indicatorpos == 'right'){
507 //cls : 'input-group-addon',
508 html : this.fieldLabel
513 cls : 'roo-required-indicator right-indicator text-danger fa fa-lg fa-star',
514 tooltip : 'This field is required'
534 if (this.parentType === 'Navbar' && this.parent().bar) {
535 cfg.cls += ' navbar-form';
538 if (this.parentType === 'NavGroup') {
539 cfg.cls += ' navbar-form';
547 * return the real input element.
551 return this.el.select('input.form-control',true).first();
554 tooltipEl : function()
556 return this.inputEl();
559 indicatorEl : function()
561 var indicator = this.el.select('i.roo-required-indicator',true).first();
571 setDisabled : function(v)
573 var i = this.inputEl().dom;
575 i.removeAttribute('disabled');
579 i.setAttribute('disabled','true');
581 initEvents : function()
584 this.inputEl().on("keydown" , this.fireKey, this);
585 this.inputEl().on("focus", this.onFocus, this);
586 this.inputEl().on("blur", this.onBlur, this);
588 this.inputEl().relayEvent('keyup', this);
590 this.indicator = this.indicatorEl();
593 this.indicator.addClass('invisible');
596 // reference to original value for reset
597 this.originalValue = this.getValue();
598 //Roo.form.TextField.superclass.initEvents.call(this);
599 if(this.validationEvent == 'keyup'){
600 this.validationTask = new Roo.util.DelayedTask(this.validate, this);
601 this.inputEl().on('keyup', this.filterValidation, this);
603 else if(this.validationEvent !== false){
604 this.inputEl().on(this.validationEvent, this.validate, this, {buffer: this.validationDelay});
607 if(this.selectOnFocus){
608 this.on("focus", this.preFocus, this);
611 if(this.maskRe || (this.vtype && this.disableKeyFilter !== true && (this.maskRe = Roo.form.VTypes[this.vtype+'Mask']))){
612 this.inputEl().on("keypress", this.filterKeys, this);
614 this.inputEl().relayEvent('keypress', this);
617 this.el.on("keyup", this.onKeyUp, this, {buffer:50});
618 this.el.on("click", this.autoSize, this);
621 if(this.inputEl().is('input[type=password]') && Roo.isSafari){
622 this.inputEl().on('keydown', this.SafariOnKeyDown, this);
625 if (typeof(this.before) == 'object') {
626 this.before.render(this.el.select('.roo-input-before',true).first());
628 if (typeof(this.after) == 'object') {
629 this.after.render(this.el.select('.roo-input-after',true).first());
632 this.inputEl().on('change', this.onChange, this);
635 filterValidation : function(e){
636 if(!e.isNavKeyPress()){
637 this.validationTask.delay(this.validationDelay);
641 * Validates the field value
642 * @return {Boolean} True if the value is valid, else false
644 validate : function(){
645 //if(this.disabled || this.validateValue(this.processValue(this.getRawValue()))){
646 if(this.disabled || this.validateValue(this.getRawValue())){
657 * Validates a value according to the field's validation rules and marks the field as invalid
658 * if the validation fails
659 * @param {Mixed} value The value to validate
660 * @return {Boolean} True if the value is valid, else false
662 validateValue : function(value)
664 if(this.getVisibilityEl().hasClass('hidden')){
668 if(value.length < 1) { // if it's blank
675 if(value.length < this.minLength){
678 if(value.length > this.maxLength){
682 var vt = Roo.form.VTypes;
683 if(!vt[this.vtype](value, this)){
687 if(typeof this.validator == "function"){
688 var msg = this.validator(value);
692 if (typeof(msg) == 'string') {
693 this.invalidText = msg;
697 if(this.regex && !this.regex.test(value)){
705 fireKey : function(e){
706 //Roo.log('field ' + e.getKey());
707 if(e.isNavKeyPress()){
708 this.fireEvent("specialkey", this, e);
711 focus : function (selectText){
713 this.inputEl().focus();
714 if(selectText === true){
715 this.inputEl().dom.select();
721 onFocus : function(){
722 if(!Roo.isOpera && this.focusClass){ // don't touch in Opera
723 // this.el.addClass(this.focusClass);
726 this.hasFocus = true;
727 this.startValue = this.getValue();
728 this.fireEvent("focus", this);
732 beforeBlur : Roo.emptyFn,
738 if(!Roo.isOpera && this.focusClass){ // don't touch in Opera
739 //this.el.removeClass(this.focusClass);
741 this.hasFocus = false;
742 if(this.validationEvent !== false && this.validateOnBlur && this.validationEvent != "blur"){
745 var v = this.getValue();
746 if(String(v) !== String(this.startValue)){
747 this.fireEvent('change', this, v, this.startValue);
749 this.fireEvent("blur", this);
752 onChange : function(e)
754 var v = this.getValue();
755 if(String(v) !== String(this.startValue)){
756 this.fireEvent('change', this, v, this.startValue);
762 * Resets the current field value to the originally loaded value and clears any validation messages
765 this.setValue(this.originalValue);
769 * Returns the name of the field
770 * @return {Mixed} name The name field
776 * Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.
777 * @return {Mixed} value The field value
779 getValue : function(){
781 var v = this.inputEl().getValue();
786 * Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.
787 * @return {Mixed} value The field value
789 getRawValue : function(){
790 var v = this.inputEl().getValue();
796 * Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.
797 * @param {Mixed} value The value to set
799 setRawValue : function(v){
800 return this.inputEl().dom.value = (v === null || v === undefined ? '' : v);
803 selectText : function(start, end){
804 var v = this.getRawValue();
806 start = start === undefined ? 0 : start;
807 end = end === undefined ? v.length : end;
808 var d = this.inputEl().dom;
809 if(d.setSelectionRange){
810 d.setSelectionRange(start, end);
811 }else if(d.createTextRange){
812 var range = d.createTextRange();
813 range.moveStart("character", start);
814 range.moveEnd("character", v.length-end);
821 * Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.
822 * @param {Mixed} value The value to set
824 setValue : function(v){
827 this.inputEl().dom.value = (v === null || v === undefined ? '' : v);
833 processValue : function(value){
834 if(this.stripCharsRe){
835 var newValue = value.replace(this.stripCharsRe, '');
836 if(newValue !== value){
837 this.setRawValue(newValue);
844 preFocus : function(){
846 if(this.selectOnFocus){
847 this.inputEl().dom.select();
850 filterKeys : function(e){
852 if(!Roo.isIE && (e.isNavKeyPress() || k == e.BACKSPACE || (k == e.DELETE && e.button == -1))){
855 var c = e.getCharCode(), cc = String.fromCharCode(c);
856 if(Roo.isIE && (e.isSpecialKey() || !cc)){
859 if(!this.maskRe.test(cc)){
864 * Clear any invalid styles/messages for this field
866 clearInvalid : function(){
868 if(!this.el || this.preventMark){ // not rendered
873 this.el.removeClass(this.invalidClass);
875 if(this.hasFeedback && this.inputType != 'hidden' && !this.allowBlank){
877 var feedback = this.el.select('.form-control-feedback', true).first();
880 this.el.select('.form-control-feedback', true).first().removeClass(this.invalidFeedbackClass);
885 this.fireEvent('valid', this);
889 * Mark this field as valid
891 markValid : function()
893 if(!this.el || this.preventMark){ // not rendered...
897 this.el.removeClass([this.invalidClass, this.validClass]);
899 var feedback = this.el.select('.form-control-feedback', true).first();
902 this.el.select('.form-control-feedback', true).first().removeClass([this.invalidFeedbackClass, this.validFeedbackClass]);
906 this.indicator.removeClass('visible');
907 this.indicator.addClass('invisible');
914 if(this.allowBlank && !this.getRawValue().length){
918 this.el.addClass(this.validClass);
920 if(this.hasFeedback && this.inputType != 'hidden' && !this.allowBlank && (this.getValue().length || this.forceFeedback)){
922 var feedback = this.el.select('.form-control-feedback', true).first();
925 this.el.select('.form-control-feedback', true).first().removeClass([this.invalidFeedbackClass, this.validFeedbackClass]);
926 this.el.select('.form-control-feedback', true).first().addClass([this.validFeedbackClass]);
931 this.fireEvent('valid', this);
935 * Mark this field as invalid
936 * @param {String} msg The validation message
938 markInvalid : function(msg)
940 if(!this.el || this.preventMark){ // not rendered
944 this.el.removeClass([this.invalidClass, this.validClass]);
946 var feedback = this.el.select('.form-control-feedback', true).first();
949 this.el.select('.form-control-feedback', true).first().removeClass([this.invalidFeedbackClass, this.validFeedbackClass]);
956 if(this.allowBlank && !this.getRawValue().length){
961 this.indicator.removeClass('invisible');
962 this.indicator.addClass('visible');
965 this.el.addClass(this.invalidClass);
967 if(this.hasFeedback && this.inputType != 'hidden' && !this.allowBlank){
969 var feedback = this.el.select('.form-control-feedback', true).first();
972 this.el.select('.form-control-feedback', true).first().removeClass([this.invalidFeedbackClass, this.validFeedbackClass]);
974 if(this.getValue().length || this.forceFeedback){
975 this.el.select('.form-control-feedback', true).first().addClass([this.invalidFeedbackClass]);
982 this.fireEvent('invalid', this, msg);
985 SafariOnKeyDown : function(event)
987 // this is a workaround for a password hang bug on chrome/ webkit.
988 if (this.inputEl().dom.type != 'password') {
992 var isSelectAll = false;
994 if(this.inputEl().dom.selectionEnd > 0){
995 isSelectAll = (this.inputEl().dom.selectionEnd - this.inputEl().dom.selectionStart - this.getValue().length == 0) ? true : false;
997 if(((event.getKey() == 8 || event.getKey() == 46) && this.getValue().length ==1)){ // backspace and delete key
998 event.preventDefault();
1003 if(isSelectAll && event.getCharCode() > 31 && !event.ctrlKey) { // not backspace and delete key (or ctrl-v)
1005 event.preventDefault();
1006 // this is very hacky as keydown always get's upper case.
1008 var cc = String.fromCharCode(event.getCharCode());
1009 this.setValue( event.shiftKey ? cc : cc.toLowerCase());
1013 adjustWidth : function(tag, w){
1014 tag = tag.toLowerCase();
1015 if(typeof w == 'number' && Roo.isStrict && !Roo.isSafari){
1016 if(Roo.isIE && (tag == 'input' || tag == 'textarea')){
1020 if(tag == 'textarea'){
1023 }else if(Roo.isOpera){
1027 if(tag == 'textarea'){
1035 setFieldLabel : function(v)
1042 var ar = this.el.select('label > span',true);
1044 if (ar.elements.length) {
1045 this.el.select('label > span',true).first().dom.innerHTML = (v === null || v === undefined ? '' : v);
1046 this.fieldLabel = v;
1050 var br = this.el.select('label',true);
1052 if(br.elements.length) {
1053 this.el.select('label',true).first().dom.innerHTML = (v === null || v === undefined ? '' : v);
1054 this.fieldLabel = v;
1058 Roo.log('Cannot Found any of label > span || label in input');
1062 this.el.select('label',true).first().dom.innerHTML = (v === null || v === undefined ? '' : v);
1063 this.fieldLabel = v;