Base3.html
33 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>The source code</title>
<link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
<script type="text/javascript" src="../resources/prettify/prettify.js"></script>
<style type="text/css">
.highlight { display: block; background-color: #ddd; }
</style>
<script type="text/javascript">
function highlight() {
document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
}
</script>
</head>
<body onload="prettyPrint(); highlight();">
<pre class="prettyprint lang-js"><span id='Ext-form-field-Base'>/**
</span> * @docauthor Jason Johnston <jason@sencha.com>
*
* Base class for form fields that provides default event handling, rendering, and other common functionality
* needed by all form field types. Utilizes the {@link Ext.form.field.Field} mixin for value handling and validation,
* and the {@link Ext.form.Labelable} mixin to provide label and error message display.
*
* In most cases you will want to use a subclass, such as {@link Ext.form.field.Text} or {@link Ext.form.field.Checkbox},
* rather than creating instances of this class directly. However if you are implementing a custom form field,
* using this as the parent class is recommended.
*
* # Values and Conversions
*
* Because Base implements the Field mixin, it has a main value that can be initialized with the
* {@link #value} config and manipulated via the {@link #getValue} and {@link #setValue} methods. This main
* value can be one of many data types appropriate to the current field, for instance a {@link Ext.form.field.Date Date}
* field would use a JavaScript Date object as its value type. However, because the field is rendered as a HTML
* input, this value data type can not always be directly used in the rendered field.
*
* Therefore Base introduces the concept of a "raw value". This is the value of the rendered HTML input field,
* and is normally a String. The {@link #getRawValue} and {@link #setRawValue} methods can be used to directly
* work with the raw value, though it is recommended to use getValue and setValue in most cases.
*
* Conversion back and forth between the main value and the raw value is handled by the {@link #valueToRaw} and
* {@link #rawToValue} methods. If you are implementing a subclass that uses a non-String value data type, you
* should override these methods to handle the conversion.
*
* # Rendering
*
* The content of the field body is defined by the {@link #fieldSubTpl} XTemplate, with its argument data
* created by the {@link #getSubTplData} method. Override this template and/or method to create custom
* field renderings.
*
* # Example usage:
*
* @example
* // A simple subclass of Base that creates a HTML5 search field. Redirects to the
* // searchUrl when the Enter key is pressed.222
* Ext.define('Ext.form.SearchField', {
* extend: 'Ext.form.field.Base',
* alias: 'widget.searchfield',
*
* inputType: 'search',
*
* // Config defining the search URL
* searchUrl: 'http://www.google.com/search?q={0}',
*
* // Add specialkey listener
* initComponent: function() {
* this.callParent();
* this.on('specialkey', this.checkEnterKey, this);
* },
*
* // Handle enter key presses, execute the search if the field has a value
* checkEnterKey: function(field, e) {
* var value = this.getValue();
* if (e.getKey() === e.ENTER && !Ext.isEmpty(value)) {
* location.href = Ext.String.format(this.searchUrl, value);
* }
* }
* });
*
* Ext.create('Ext.form.Panel', {
* title: 'Base Example',
* bodyPadding: 5,
* width: 250,
*
* // Fields will be arranged vertically, stretched to full width
* layout: 'anchor',
* defaults: {
* anchor: '100%'
* },
* items: [{
* xtype: 'searchfield',
* fieldLabel: 'Search',
* name: 'query'
* }],
* renderTo: Ext.getBody()
* });
*/
Ext.define('Ext.form.field.Base', {
extend: 'Ext.Component',
mixins: {
labelable: 'Ext.form.Labelable',
field: 'Ext.form.field.Field'
},
alias: 'widget.field',
alternateClassName: ['Ext.form.Field', 'Ext.form.BaseField'],
requires: ['Ext.util.DelayedTask', 'Ext.XTemplate', 'Ext.layout.component.field.Field'],
<span id='Ext-form-field-Base-cfg-fieldSubTpl'> /**
</span> * @cfg {Ext.XTemplate} fieldSubTpl
* The content of the field body is defined by this config option.
* @private
*/
fieldSubTpl: [ // note: {id} here is really {inputId}, but {cmpId} is available
'<input id="{id}" type="{type}" {inputAttrTpl}',
' size="1"', // allows inputs to fully respect CSS widths across all browsers
'<tpl if="name"> name="{name}"</tpl>',
'<tpl if="value"> value="{[Ext.util.Format.htmlEncode(values.value)]}"</tpl>',
'<tpl if="placeholder"> placeholder="{placeholder}"</tpl>',
'{%if (values.maxLength !== undefined){%} maxlength="{maxLength}"{%}%}',
'<tpl if="readOnly"> readonly="readonly"</tpl>',
'<tpl if="disabled"> disabled="disabled"</tpl>',
'<tpl if="tabIdx"> tabIndex="{tabIdx}"</tpl>',
'<tpl if="fieldStyle"> style="{fieldStyle}"</tpl>',
' class="{fieldCls} {typeCls} {editableCls}" autocomplete="off"/>',
{
disableFormats: true
}
],
subTplInsertions: [
<span id='Ext-form-field-Base-cfg-inputAttrTpl'> /**
</span> * @cfg {String/Array/Ext.XTemplate} inputAttrTpl
* An optional string or `XTemplate` configuration to insert in the field markup
* inside the input element (as attributes). If an `XTemplate` is used, the component's
* {@link #getSubTplData subTpl data} serves as the context.
*/
'inputAttrTpl'
],
<span id='Ext-form-field-Base-cfg-name'> /**
</span> * @cfg {String} name
* The name of the field. This is used as the parameter name when including the field value
* in a {@link Ext.form.Basic#submit form submit()}. If no name is configured, it falls back to the {@link #inputId}.
* To prevent the field from being included in the form submit, set {@link #submitValue} to false.
*/
<span id='Ext-form-field-Base-cfg-inputType'> /**
</span> * @cfg {String} inputType
* The type attribute for input fields -- e.g. radio, text, password, file. The extended types
* supported by HTML5 inputs (url, email, etc.) may also be used, though using them will cause older browsers to
* fall back to 'text'.
*
* The type 'password' must be used to render that field type currently -- there is no separate Ext component for
* that. You can use {@link Ext.form.field.File} which creates a custom-rendered file upload field, but if you want
* a plain unstyled file input you can use a Base with inputType:'file'.
*/
inputType: 'text',
<span id='Ext-form-field-Base-cfg-tabIndex'> /**
</span> * @cfg {Number} tabIndex
* The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via
* applyTo
*/
//<locale>
<span id='Ext-form-field-Base-cfg-invalidText'> /**
</span> * @cfg {String} invalidText
* The error text to use when marking a field invalid and no message is provided
*/
invalidText : 'The value in this field is invalid',
//</locale>
<span id='Ext-form-field-Base-cfg-fieldCls'> /**
</span> * @cfg {String} [fieldCls='x-form-field']
* The default CSS class for the field input
*/
fieldCls : Ext.baseCSSPrefix + 'form-field',
<span id='Ext-form-field-Base-cfg-fieldStyle'> /**
</span> * @cfg {String} fieldStyle
* Optional CSS style(s) to be applied to the {@link #inputEl field input element}. Should be a valid argument to
* {@link Ext.Element#applyStyles}. Defaults to undefined. See also the {@link #setFieldStyle} method for changing
* the style after initialization.
*/
<span id='Ext-form-field-Base-cfg-focusCls'> /**
</span> * @cfg {String} [focusCls='x-form-focus']
* The CSS class to use when the field receives focus
*/
focusCls : 'form-focus',
<span id='Ext-form-field-Base-cfg-dirtyCls'> /**
</span> * @cfg {String} dirtyCls
* The CSS class to use when the field value {@link #isDirty is dirty}.
*/
dirtyCls : Ext.baseCSSPrefix + 'form-dirty',
<span id='Ext-form-field-Base-cfg-checkChangeEvents'> /**
</span> * @cfg {String[]} checkChangeEvents
* A list of event names that will be listened for on the field's {@link #inputEl input element}, which will cause
* the field's value to be checked for changes. If a change is detected, the {@link #change change event} will be
* fired, followed by validation if the {@link #validateOnChange} option is enabled.
*
* Defaults to ['change', 'propertychange'] in Internet Explorer, and ['change', 'input', 'textInput', 'keyup',
* 'dragdrop'] in other browsers. This catches all the ways that field values can be changed in most supported
* browsers; the only known exceptions at the time of writing are:
*
* - Safari 3.2 and older: cut/paste in textareas via the context menu, and dragging text into textareas
* - Opera 10 and 11: dragging text into text fields and textareas, and cut via the context menu in text fields
* and textareas
* - Opera 9: Same as Opera 10 and 11, plus paste from context menu in text fields and textareas
*
* If you need to guarantee on-the-fly change notifications including these edge cases, you can call the
* {@link #checkChange} method on a repeating interval, e.g. using {@link Ext.TaskManager}, or if the field is within
* a {@link Ext.form.Panel}, you can use the FormPanel's {@link Ext.form.Panel#pollForChanges} configuration to set up
* such a task automatically.
*/
checkChangeEvents: Ext.isIE && (!document.documentMode || document.documentMode < 9) ?
['change', 'propertychange'] :
['change', 'input', 'textInput', 'keyup', 'dragdrop'],
<span id='Ext-form-field-Base-cfg-checkChangeBuffer'> /**
</span> * @cfg {Number} checkChangeBuffer
* Defines a timeout in milliseconds for buffering {@link #checkChangeEvents} that fire in rapid succession.
* Defaults to 50 milliseconds.
*/
checkChangeBuffer: 50,
componentLayout: 'field',
<span id='Ext-form-field-Base-cfg-readOnly'> /**
</span> * @cfg {Boolean} readOnly
* true to mark the field as readOnly in HTML.
*
* **Note**: this only sets the element's readOnly DOM attribute. Setting `readOnly=true`, for example, will not
* disable triggering a ComboBox or Date; it gives you the option of forcing the user to choose via the trigger
* without typing in the text box. To hide the trigger use `{@link Ext.form.field.Trigger#hideTrigger hideTrigger}`.
*/
readOnly : false,
<span id='Ext-form-field-Base-cfg-readOnlyCls'> /**
</span> * @cfg {String} readOnlyCls
* The CSS class applied to the component's main element when it is {@link #readOnly}.
*/
readOnlyCls: Ext.baseCSSPrefix + 'form-readonly',
<span id='Ext-form-field-Base-cfg-inputId'> /**
</span> * @cfg {String} inputId
* The id that will be given to the generated input DOM element. Defaults to an automatically generated id. If you
* configure this manually, you must make sure it is unique in the document.
*/
<span id='Ext-form-field-Base-cfg-validateOnBlur'> /**
</span> * @cfg {Boolean} validateOnBlur
* Whether the field should validate when it loses focus. This will cause fields to be validated
* as the user steps through the fields in the form regardless of whether they are making changes to those fields
* along the way. See also {@link #validateOnChange}.
*/
validateOnBlur: true,
// private
hasFocus : false,
baseCls: Ext.baseCSSPrefix + 'field',
maskOnDisable: false,
// private
initComponent : function() {
var me = this;
me.callParent();
me.subTplData = me.subTplData || {};
me.addEvents(
<span id='Ext-form-field-Base-event-specialkey'> /**
</span> * @event specialkey
* Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. To handle other keys
* see {@link Ext.util.KeyMap}. You can check {@link Ext.EventObject#getKey} to determine which key was
* pressed. For example:
*
* var form = new Ext.form.Panel({
* ...
* items: [{
* fieldLabel: 'Field 1',
* name: 'field1',
* allowBlank: false
* },{
* fieldLabel: 'Field 2',
* name: 'field2',
* listeners: {
* specialkey: function(field, e){
* // e.HOME, e.END, e.PAGE_UP, e.PAGE_DOWN,
* // e.TAB, e.ESC, arrow keys: e.LEFT, e.RIGHT, e.UP, e.DOWN
* if (e.{@link Ext.EventObject#getKey getKey()} == e.ENTER) {
* var form = field.up('form').getForm();
* form.submit();
* }
* }
* }
* }
* ],
* ...
* });
*
* @param {Ext.form.field.Base} this
* @param {Ext.EventObject} e The event object
*/
'specialkey',
<span id='Ext-form-field-Base-event-writeablechange'> /**
</span> * @event writeablechange
* Fires when this field changes its read-only status.
* @param {Ext.form.field.Base} this
* @param {Boolean} Read only flag
*/
'writeablechange'
);
// Init mixins
me.initLabelable();
me.initField();
// Default name to inputId
if (!me.name) {
me.name = me.getInputId();
}
},
beforeRender: function(){
var me = this;
me.callParent(arguments);
me.beforeLabelableRender(arguments);
if (me.readOnly) {
me.addCls(me.readOnlyCls);
}
},
<span id='Ext-form-field-Base-method-getInputId'> /**
</span> * Returns the input id for this field. If none was specified via the {@link #inputId} config, then an id will be
* automatically generated.
*/
getInputId: function() {
return this.inputId || (this.inputId = this.id + '-inputEl');
},
<span id='Ext-form-field-Base-method-getSubTplData'> /**
</span> * Creates and returns the data object to be used when rendering the {@link #fieldSubTpl}.
* @return {Object} The template data
* @template
*/
getSubTplData: function() {
var me = this,
type = me.inputType,
inputId = me.getInputId(),
data;
data = Ext.apply({
id : inputId,
cmpId : me.id,
name : me.name || inputId,
disabled : me.disabled,
readOnly : me.readOnly,
value : me.getRawValue(),
type : type,
fieldCls : me.fieldCls,
fieldStyle : me.getFieldStyle(),
tabIdx : me.tabIndex,
typeCls : Ext.baseCSSPrefix + 'form-' + (type === 'password' ? 'text' : type)
}, me.subTplData);
me.getInsertionRenderData(data, me.subTplInsertions);
return data;
},
afterFirstLayout: function() {
this.callParent();
var el = this.inputEl;
if (el) {
el.selectable();
}
},
applyRenderSelectors: function() {
var me = this;
me.callParent();
<span id='Ext-form-field-Base-property-inputEl'> /**
</span> * @property {Ext.Element} inputEl
* The input Element for this Field. Only available after the field has been rendered.
*/
me.inputEl = me.el.getById(me.getInputId());
},
<span id='Ext-form-field-Base-method-getSubTplMarkup'> /**
</span> * Gets the markup to be inserted into the outer template's bodyEl. For fields this is the actual input element.
*/
getSubTplMarkup: function() {
return this.getTpl('fieldSubTpl').apply(this.getSubTplData());
},
initRenderTpl: function() {
var me = this;
if (!me.hasOwnProperty('renderTpl')) {
me.renderTpl = me.getTpl('labelableRenderTpl');
}
return me.callParent();
},
initRenderData: function() {
return Ext.applyIf(this.callParent(), this.getLabelableRenderData());
},
<span id='Ext-form-field-Base-method-setFieldStyle'> /**
</span> * Set the {@link #fieldStyle CSS style} of the {@link #inputEl field input element}.
* @param {String/Object/Function} style The style(s) to apply. Should be a valid argument to {@link
* Ext.Element#applyStyles}.
*/
setFieldStyle: function(style) {
var me = this,
inputEl = me.inputEl;
if (inputEl) {
inputEl.applyStyles(style);
}
me.fieldStyle = style;
},
getFieldStyle: function() {
return 'width:100%;' + (Ext.isObject(this.fieldStyle) ? Ext.DomHelper.generateStyles(this.fieldStyle) : this.fieldStyle ||'');
},
// private
onRender : function() {
var me = this;
me.callParent(arguments);
me.onLabelableRender();
me.renderActiveError();
},
getFocusEl: function() {
return this.inputEl;
},
isFileUpload: function() {
return this.inputType === 'file';
},
extractFileInput: function() {
var me = this,
fileInput = me.isFileUpload() ? me.inputEl.dom : null,
clone;
if (fileInput) {
clone = fileInput.cloneNode(true);
fileInput.parentNode.replaceChild(clone, fileInput);
me.inputEl = Ext.get(clone);
}
return fileInput;
},
// private override to use getSubmitValue() as a convenience
getSubmitData: function() {
var me = this,
data = null,
val;
if (!me.disabled && me.submitValue && !me.isFileUpload()) {
val = me.getSubmitValue();
if (val !== null) {
data = {};
data[me.getName()] = val;
}
}
return data;
},
<span id='Ext-form-field-Base-method-getSubmitValue'> /**
</span> * Returns the value that would be included in a standard form submit for this field. This will be combined with the
* field's name to form a name=value pair in the {@link #getSubmitData submitted parameters}. If an empty string is
* returned then just the name= will be submitted; if null is returned then nothing will be submitted.
*
* Note that the value returned will have been {@link #processRawValue processed} but may or may not have been
* successfully {@link #validate validated}.
*
* @return {String} The value to be submitted, or null.
*/
getSubmitValue: function() {
return this.processRawValue(this.getRawValue());
},
<span id='Ext-form-field-Base-method-getRawValue'> /**
</span> * Returns the raw value of the field, without performing any normalization, conversion, or validation. To get a
* normalized and converted value see {@link #getValue}.
* @return {String} value The raw String value of the field
*/
getRawValue: function() {
var me = this,
v = (me.inputEl ? me.inputEl.getValue() : Ext.value(me.rawValue, ''));
me.rawValue = v;
return v;
},
<span id='Ext-form-field-Base-method-setRawValue'> /**
</span> * Sets the field's raw value directly, bypassing {@link #valueToRaw value conversion}, change detection, and
* validation. To set the value with these additional inspections see {@link #setValue}.
* @param {Object} value The value to set
* @return {Object} value The field value that is set
*/
setRawValue: function(value) {
var me = this;
value = Ext.value(me.transformRawValue(value), '');
me.rawValue = value;
// Some Field subclasses may not render an inputEl
if (me.inputEl) {
me.inputEl.dom.value = value;
}
return value;
},
<span id='Ext-form-field-Base-method-transformRawValue'> /**
</span> * Transform the raw value before it is set
* @protected
* @param {Object} value The value
* @return {Object} The value to set
*/
transformRawValue: function(value) {
return value;
},
<span id='Ext-form-field-Base-method-valueToRaw'> /**
</span> * Converts a mixed-type value to a raw representation suitable for displaying in the field. This allows controlling
* how value objects passed to {@link #setValue} are shown to the user, including localization. For instance, for a
* {@link Ext.form.field.Date}, this would control how a Date object passed to {@link #setValue} would be converted
* to a String for display in the field.
*
* See {@link #rawToValue} for the opposite conversion.
*
* The base implementation simply does a standard toString conversion, and converts {@link Ext#isEmpty empty values}
* to an empty string.
*
* @param {Object} value The mixed-type value to convert to the raw representation.
* @return {Object} The converted raw value.
*/
valueToRaw: function(value) {
return '' + Ext.value(value, '');
},
<span id='Ext-form-field-Base-method-rawToValue'> /**
</span> * Converts a raw input field value into a mixed-type value that is suitable for this particular field type. This
* allows controlling the normalization and conversion of user-entered values into field-type-appropriate values,
* e.g. a Date object for {@link Ext.form.field.Date}, and is invoked by {@link #getValue}.
*
* It is up to individual implementations to decide how to handle raw values that cannot be successfully converted
* to the desired object type.
*
* See {@link #valueToRaw} for the opposite conversion.
*
* The base implementation does no conversion, returning the raw value untouched.
*
* @param {Object} rawValue
* @return {Object} The converted value.
*/
rawToValue: function(rawValue) {
return rawValue;
},
<span id='Ext-form-field-Base-method-processRawValue'> /**
</span> * Performs any necessary manipulation of a raw field value to prepare it for {@link #rawToValue conversion} and/or
* {@link #validate validation}, for instance stripping out ignored characters. In the base implementation it does
* nothing; individual subclasses may override this as needed.
*
* @param {Object} value The unprocessed string value
* @return {Object} The processed string value
*/
processRawValue: function(value) {
return value;
},
<span id='Ext-form-field-Base-method-getValue'> /**
</span> * Returns the current data value of the field. The type of value returned is particular to the type of the
* particular field (e.g. a Date object for {@link Ext.form.field.Date}), as the result of calling {@link #rawToValue} on
* the field's {@link #processRawValue processed} String value. To return the raw String value, see {@link #getRawValue}.
* @return {Object} value The field value
*/
getValue: function() {
var me = this,
val = me.rawToValue(me.processRawValue(me.getRawValue()));
me.value = val;
return val;
},
<span id='Ext-form-field-Base-method-setValue'> /**
</span> * Sets a data value into the field and runs the change detection and validation. To set the value directly
* without these inspections see {@link #setRawValue}.
* @param {Object} value The value to set
* @return {Ext.form.field.Field} this
*/
setValue: function(value) {
var me = this;
me.setRawValue(me.valueToRaw(value));
return me.mixins.field.setValue.call(me, value);
},
onBoxReady: function() {
var me = this;
me.callParent();
if (me.setReadOnlyOnBoxReady) {
me.setReadOnly(me.readOnly);
}
},
//private
onDisable: function() {
var me = this,
inputEl = me.inputEl;
me.callParent();
if (inputEl) {
inputEl.dom.disabled = true;
if (me.hasActiveError()) {
// clear invalid state since the field is now disabled
me.clearInvalid();
me.needsValidateOnEnable = true;
}
}
},
//private
onEnable: function() {
var me = this,
inputEl = me.inputEl;
me.callParent();
if (inputEl) {
inputEl.dom.disabled = false;
if (me.needsValidateOnEnable) {
delete me.needsValidateOnEnable;
// will trigger errors to be shown
me.forceValidation = true;
me.isValid();
delete me.forceValidation;
}
}
},
<span id='Ext-form-field-Base-method-setReadOnly'> /**
</span> * Sets the read only state of this field.
* @param {Boolean} readOnly Whether the field should be read only.
*/
setReadOnly: function(readOnly) {
var me = this,
inputEl = me.inputEl;
readOnly = !!readOnly;
me[readOnly ? 'addCls' : 'removeCls'](me.readOnlyCls);
me.readOnly = readOnly;
if (inputEl) {
inputEl.dom.readOnly = readOnly;
} else if (me.rendering) {
me.setReadOnlyOnBoxReady = true;
}
me.fireEvent('writeablechange', me, readOnly);
},
// private
fireKey: function(e){
if(e.isSpecialKey()){
this.fireEvent('specialkey', this, new Ext.EventObjectImpl(e));
}
},
// private
initEvents : function(){
var me = this,
inputEl = me.inputEl,
onChangeTask,
onChangeEvent,
events = me.checkChangeEvents,
e,
eLen = events.length,
event;
// standardise buffer across all browsers + OS-es for consistent event order.
// (the 10ms buffer for Editors fixes a weird FF/Win editor issue when changing OS window focus)
if (me.inEditor) {
me.onBlur = Ext.Function.createBuffered(me.onBlur, 10);
}
if (inputEl) {
me.mon(inputEl, Ext.EventManager.getKeyEvent(), me.fireKey, me);
// listen for immediate value changes
onChangeTask = new Ext.util.DelayedTask(me.checkChange, me);
me.onChangeEvent = onChangeEvent = function() {
onChangeTask.delay(me.checkChangeBuffer);
};
for (e = 0; e < eLen; e++) {
event = events[e];
if (event === 'propertychange') {
me.usesPropertychange = true;
}
me.mon(inputEl, event, onChangeEvent);
}
}
me.callParent();
},
doComponentLayout: function() {
var me = this,
inputEl = me.inputEl,
usesPropertychange = me.usesPropertychange,
ename = 'propertychange',
onChangeEvent = me.onChangeEvent;
// In IE if propertychange is one of the checkChangeEvents, we need to remove
// the listener prior to layout and re-add it after, to prevent it from firing
// needlessly for attribute and style changes applied to the inputEl.
if (usesPropertychange) {
me.mun(inputEl, ename, onChangeEvent);
}
me.callParent(arguments);
if (usesPropertychange) {
me.mon(inputEl, ename, onChangeEvent);
}
},
<span id='Ext-form-field-Base-method-onDirtyChange'> /**
</span> * @private Called when the field's dirty state changes. Adds/removes the {@link #dirtyCls} on the main element.
* @param {Boolean} isDirty
*/
onDirtyChange: function(isDirty) {
this[isDirty ? 'addCls' : 'removeCls'](this.dirtyCls);
},
<span id='Ext-form-field-Base-method-isValid'> /**
</span> * Returns whether or not the field value is currently valid by {@link #getErrors validating} the
* {@link #processRawValue processed raw value} of the field. **Note**: {@link #disabled} fields are
* always treated as valid.
*
* @return {Boolean} True if the value is valid, else false
*/
isValid : function() {
var me = this,
disabled = me.disabled,
validate = me.forceValidation || !disabled;
return validate ? me.validateValue(me.processRawValue(me.getRawValue())) : disabled;
},
<span id='Ext-form-field-Base-method-validateValue'> /**
</span> * Uses {@link #getErrors} to build an array of validation errors. If any errors are found, they are passed to
* {@link #markInvalid} and false is returned, otherwise true is returned.
*
* Previously, subclasses were invited to provide an implementation of this to process validations - from 3.2
* onwards {@link #getErrors} should be overridden instead.
*
* @param {Object} value The value to validate
* @return {Boolean} True if all validations passed, false if one or more failed
*/
validateValue: function(value) {
var me = this,
errors = me.getErrors(value),
isValid = Ext.isEmpty(errors);
if (!me.preventMark) {
if (isValid) {
me.clearInvalid();
} else {
me.markInvalid(errors);
}
}
return isValid;
},
<span id='Ext-form-field-Base-method-markInvalid'> /**
</span> * Display one or more error messages associated with this field, using {@link #msgTarget} to determine how to
* display the messages and applying {@link #invalidCls} to the field's UI element.
*
* **Note**: this method does not cause the Field's {@link #validate} or {@link #isValid} methods to return `false`
* if the value does _pass_ validation. So simply marking a Field as invalid will not prevent submission of forms
* submitted with the {@link Ext.form.action.Submit#clientValidation} option set.
*
* @param {String/String[]} errors The validation message(s) to display.
*/
markInvalid : function(errors) {
// Save the message and fire the 'invalid' event
var me = this,
oldMsg = me.getActiveError();
me.setActiveErrors(Ext.Array.from(errors));
if (oldMsg !== me.getActiveError()) {
me.updateLayout();
}
},
<span id='Ext-form-field-Base-method-clearInvalid'> /**
</span> * Clear any invalid styles/messages for this field.
*
* **Note**: this method does not cause the Field's {@link #validate} or {@link #isValid} methods to return `true`
* if the value does not _pass_ validation. So simply clearing a field's errors will not necessarily allow
* submission of forms submitted with the {@link Ext.form.action.Submit#clientValidation} option set.
*/
clearInvalid : function() {
// Clear the message and fire the 'valid' event
var me = this,
hadError = me.hasActiveError();
me.unsetActiveError();
if (hadError) {
me.updateLayout();
}
},
<span id='Ext-form-field-Base-method-renderActiveError'> /**
</span> * @private Overrides the method from the Ext.form.Labelable mixin to also add the invalidCls to the inputEl,
* as that is required for proper styling in IE with nested fields (due to lack of child selector)
*/
renderActiveError: function() {
var me = this,
hasError = me.hasActiveError();
if (me.inputEl) {
// Add/remove invalid class
me.inputEl[hasError ? 'addCls' : 'removeCls'](me.invalidCls + '-field');
}
me.mixins.labelable.renderActiveError.call(me);
},
getActionEl: function() {
return this.inputEl || this.el;
}
});
</pre>
</body>
</html>