FieldContainer2.html
10.8 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
<!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-FieldContainer'>/**
</span> * FieldContainer is a derivation of {@link Ext.container.Container Container} that implements the
* {@link Ext.form.Labelable Labelable} mixin. This allows it to be configured so that it is rendered with
* a {@link #fieldLabel field label} and optional {@link #msgTarget error message} around its sub-items.
* This is useful for arranging a group of fields or other components within a single item in a form, so
* that it lines up nicely with other fields. A common use is for grouping a set of related fields under
* a single label in a form.
*
* The container's configured {@link #cfg-items} will be layed out within the field body area according to the
* configured {@link #layout} type. The default layout is `'autocontainer'`.
*
* Like regular fields, FieldContainer can inherit its decoration configuration from the
* {@link Ext.form.Panel#fieldDefaults fieldDefaults} of an enclosing FormPanel. In addition,
* FieldContainer itself can pass {@link #fieldDefaults} to any {@link Ext.form.Labelable fields}
* it may itself contain.
*
* If you are grouping a set of {@link Ext.form.field.Checkbox Checkbox} or {@link Ext.form.field.Radio Radio}
* fields in a single labeled container, consider using a {@link Ext.form.CheckboxGroup}
* or {@link Ext.form.RadioGroup} instead as they are specialized for handling those types.
*
* # Example
*
* @example
* Ext.create('Ext.form.Panel', {
* title: 'FieldContainer Example',
* width: 550,
* bodyPadding: 10,
*
* items: [{
* xtype: 'fieldcontainer',
* fieldLabel: 'Last Three Jobs',
* labelWidth: 100,
*
* // The body area will contain three text fields, arranged
* // horizontally, separated by draggable splitters.
* layout: 'hbox',
* items: [{
* xtype: 'textfield',
* flex: 1
* }, {
* xtype: 'splitter'
* }, {
* xtype: 'textfield',
* flex: 1
* }, {
* xtype: 'splitter'
* }, {
* xtype: 'textfield',
* flex: 1
* }]
* }],
* renderTo: Ext.getBody()
* });
*
* # Usage of fieldDefaults
*
* @example
* Ext.create('Ext.form.Panel', {
* title: 'FieldContainer Example',
* width: 350,
* bodyPadding: 10,
*
* items: [{
* xtype: 'fieldcontainer',
* fieldLabel: 'Your Name',
* labelWidth: 75,
* defaultType: 'textfield',
*
* // Arrange fields vertically, stretched to full width
* layout: 'anchor',
* defaults: {
* layout: '100%'
* },
*
* // These config values will be applied to both sub-fields, except
* // for Last Name which will use its own msgTarget.
* fieldDefaults: {
* msgTarget: 'under',
* labelAlign: 'top'
* },
*
* items: [{
* fieldLabel: 'First Name',
* name: 'firstName'
* }, {
* fieldLabel: 'Last Name',
* name: 'lastName',
* msgTarget: 'under'
* }]
* }],
* renderTo: Ext.getBody()
* });
*
* @docauthor Jason Johnston <jason@sencha.com>
*/
Ext.define('Ext.form.FieldContainer', {
extend: 'Ext.container.Container',
mixins: {
labelable: 'Ext.form.Labelable',
fieldAncestor: 'Ext.form.FieldAncestor'
},
requires: 'Ext.layout.component.field.FieldContainer',
alias: 'widget.fieldcontainer',
componentLayout: 'fieldcontainer',
componentCls: Ext.baseCSSPrefix + 'form-fieldcontainer',
<span id='Ext-form-FieldContainer-cfg-combineLabels'> /**
</span> * @cfg {Boolean} combineLabels
* If set to true, and there is no defined {@link #fieldLabel}, the field container will automatically
* generate its label by combining the labels of all the fields it contains. Defaults to false.
*/
combineLabels: false,
//<locale>
<span id='Ext-form-FieldContainer-cfg-labelConnector'> /**
</span> * @cfg {String} labelConnector
* The string to use when joining the labels of individual sub-fields, when {@link #combineLabels} is
* set to true. Defaults to ', '.
*/
labelConnector: ', ',
//</locale>
<span id='Ext-form-FieldContainer-cfg-combineErrors'> /**
</span> * @cfg {Boolean} combineErrors
* If set to true, the field container will automatically combine and display the validation errors from
* all the fields it contains as a single error on the container, according to the configured
* {@link #msgTarget}. Defaults to false.
*/
combineErrors: false,
maskOnDisable: false,
fieldSubTpl: '{%this.renderContainer(out,values)%}',
initComponent: function() {
var me = this;
// Init mixins
me.initLabelable();
me.initFieldAncestor();
me.callParent();
},
beforeRender: function(){
this.callParent(arguments);
this.beforeLabelableRender(arguments);
},
<span id='Ext-form-FieldContainer-method-onLabelableAdded'> /**
</span> * @protected Called when a {@link Ext.form.Labelable} instance is added to the container's subtree.
* @param {Ext.form.Labelable} labelable The instance that was added
*/
onLabelableAdded: function(labelable) {
var me = this;
me.mixins.fieldAncestor.onLabelableAdded.call(this, labelable);
me.updateLabel();
},
<span id='Ext-form-FieldContainer-method-onLabelableRemoved'> /**
</span> * @protected Called when a {@link Ext.form.Labelable} instance is removed from the container's subtree.
* @param {Ext.form.Labelable} labelable The instance that was removed
*/
onLabelableRemoved: function(labelable) {
var me = this;
me.mixins.fieldAncestor.onLabelableRemoved.call(this, labelable);
me.updateLabel();
},
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-FieldContainer-method-getFieldLabel'> /**
</span> * Returns the combined field label if {@link #combineLabels} is set to true and if there is no
* set {@link #fieldLabel}. Otherwise returns the fieldLabel like normal. You can also override
* this method to provide a custom generated label.
* @template
* @return {String} The label, or empty string if none.
*/
getFieldLabel: function() {
var label = this.fieldLabel || '';
if (!label && this.combineLabels) {
label = Ext.Array.map(this.query('[isFieldLabelable]'), function(field) {
return field.getFieldLabel();
}).join(this.labelConnector);
}
return label;
},
getSubTplData: function() {
var ret = this.initRenderData();
Ext.apply(ret, this.subTplData);
return ret;
},
getSubTplMarkup: function() {
var me = this,
tpl = me.getTpl('fieldSubTpl'),
html;
if (!tpl.renderContent) {
me.setupRenderTpl(tpl);
}
html = tpl.apply(me.getSubTplData());
return html;
},
<span id='Ext-form-FieldContainer-method-updateLabel'> /**
</span> * @private Updates the content of the labelEl if it is rendered
*/
updateLabel: function() {
var me = this,
label = me.labelEl;
if (label) {
me.setFieldLabel(me.getFieldLabel());
}
},
<span id='Ext-form-FieldContainer-method-onFieldErrorChange'> /**
</span> * @private Fired when the error message of any field within the container changes, and updates the
* combined error message to match.
*/
onFieldErrorChange: function(field, activeError) {
if (this.combineErrors) {
var me = this,
oldError = me.getActiveError(),
invalidFields = Ext.Array.filter(me.query('[isFormField]'), function(field) {
return field.hasActiveError();
}),
newErrors = me.getCombinedErrors(invalidFields);
if (newErrors) {
me.setActiveErrors(newErrors);
} else {
me.unsetActiveError();
}
if (oldError !== me.getActiveError()) {
me.doComponentLayout();
}
}
},
<span id='Ext-form-FieldContainer-method-getCombinedErrors'> /**
</span> * Takes an Array of invalid {@link Ext.form.field.Field} objects and builds a combined list of error
* messages from them. Defaults to prepending each message by the field name and a colon. This
* can be overridden to provide custom combined error message handling, for instance changing
* the format of each message or sorting the array (it is sorted in order of appearance by default).
* @param {Ext.form.field.Field[]} invalidFields An Array of the sub-fields which are currently invalid.
* @return {String[]} The combined list of error messages
*/
getCombinedErrors: function(invalidFields) {
var errors = [],
f,
fLen = invalidFields.length,
field,
activeErrors, a, aLen,
error, label;
for (f = 0; f < fLen; f++) {
field = invalidFields[f];
activeErrors = field.getActiveErrors();
aLen = activeErrors.length;
for (a = 0; a < aLen; a++) {
error = activeErrors[a];
label = field.getFieldLabel();
errors.push((label ? label + ': ' : '') + error);
}
}
return errors;
},
getTargetEl: function() {
return this.bodyEl || this.callParent();
}
});
</pre>
</body>
</html>