FieldSet2.html
17.5 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
<!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-FieldSet'>/**
</span> * @docauthor Jason Johnston <jason@sencha.com>
*
* A container for grouping sets of fields, rendered as a HTML `fieldset` element. The {@link #title}
* config will be rendered as the fieldset's `legend`.
*
* While FieldSets commonly contain simple groups of fields, they are general {@link Ext.container.Container Containers}
* and may therefore contain any type of components in their {@link #cfg-items}, including other nested containers.
* The default {@link #layout} for the FieldSet's items is `'anchor'`, but it can be configured to use any other
* layout type.
*
* FieldSets may also be collapsed if configured to do so; this can be done in two ways:
*
* 1. Set the {@link #collapsible} config to true; this will result in a collapse button being rendered next to
* the {@link #title legend title}, or:
* 2. Set the {@link #checkboxToggle} config to true; this is similar to using {@link #collapsible} but renders
* a {@link Ext.form.field.Checkbox checkbox} in place of the toggle button. The fieldset will be expanded when the
* checkbox is checked and collapsed when it is unchecked. The checkbox will also be included in the
* {@link Ext.form.Basic#submit form submit parameters} using the {@link #checkboxName} as its parameter name.
*
* # Example usage
*
* @example
* Ext.create('Ext.form.Panel', {
* title: 'Simple Form with FieldSets',
* labelWidth: 75, // label settings here cascade unless overridden
* url: 'save-form.php',
* frame: true,
* bodyStyle: 'padding:5px 5px 0',
* width: 550,
* renderTo: Ext.getBody(),
* layout: 'column', // arrange fieldsets side by side
* defaults: {
* bodyPadding: 4
* },
* items: [{
* // Fieldset in Column 1 - collapsible via toggle button
* xtype:'fieldset',
* columnWidth: 0.5,
* title: 'Fieldset 1',
* collapsible: true,
* defaultType: 'textfield',
* defaults: {anchor: '100%'},
* layout: 'anchor',
* items :[{
* fieldLabel: 'Field 1',
* name: 'field1'
* }, {
* fieldLabel: 'Field 2',
* name: 'field2'
* }]
* }, {
* // Fieldset in Column 2 - collapsible via checkbox, collapsed by default, contains a panel
* xtype:'fieldset',
* title: 'Show Panel', // title or checkboxToggle creates fieldset header
* columnWidth: 0.5,
* checkboxToggle: true,
* collapsed: true, // fieldset initially collapsed
* layout:'anchor',
* items :[{
* xtype: 'panel',
* anchor: '100%',
* title: 'Panel inside a fieldset',
* frame: true,
* height: 52
* }]
* }]
* });
*/
Ext.define('Ext.form.FieldSet', {
extend: 'Ext.container.Container',
alias: 'widget.fieldset',
uses: ['Ext.form.field.Checkbox', 'Ext.panel.Tool', 'Ext.layout.container.Anchor', 'Ext.layout.component.FieldSet'],
<span id='Ext-form-FieldSet-cfg-title'> /**
</span> * @cfg {String} title
* A title to be displayed in the fieldset's legend. May contain HTML markup.
*/
<span id='Ext-form-FieldSet-cfg-checkboxToggle'> /**
</span> * @cfg {Boolean} [checkboxToggle=false]
* Set to true to render a checkbox into the fieldset frame just in front of the legend to expand/collapse the
* fieldset when the checkbox is toggled.. This checkbox will be included in form submits using
* the {@link #checkboxName}.
*/
<span id='Ext-form-FieldSet-cfg-checkboxName'> /**
</span> * @cfg {String} checkboxName
* The name to assign to the fieldset's checkbox if {@link #checkboxToggle} = true
* (defaults to '[fieldset id]-checkbox').
*/
<span id='Ext-form-FieldSet-cfg-collapsible'> /**
</span> * @cfg {Boolean} [collapsible=false]
* Set to true to make the fieldset collapsible and have the expand/collapse toggle button automatically rendered
* into the legend element, false to keep the fieldset statically sized with no collapse button.
* Another option is to configure {@link #checkboxToggle}. Use the {@link #collapsed} config to collapse the
* fieldset by default.
*/
<span id='Ext-form-FieldSet-cfg-collapsed'> /**
</span> * @cfg {Boolean} collapsed
* Set to true to render the fieldset as collapsed by default. If {@link #checkboxToggle} is specified, the checkbox
* will also be unchecked by default.
*/
collapsed: false,
<span id='Ext-form-FieldSet-cfg-toggleOnTitleClick'> /**
</span> * @cfg {Boolean} [toggleOnTitleClick=true]
* Set to true will add a listener to the titleCmp property for the click event which will execute the
* {@link #toggle} method. This option is only used when the {@link #collapsible} property is set to true.
*/
toggleOnTitleClick : true,
<span id='Ext-form-FieldSet-property-legend'> /**
</span> * @property {Ext.Component} legend
* The component for the fieldset's legend. Will only be defined if the configuration requires a legend to be
* created, by setting the {@link #title} or {@link #checkboxToggle} options.
*/
<span id='Ext-form-FieldSet-cfg-baseCls'> /**
</span> * @cfg {String} [baseCls='x-fieldset']
* The base CSS class applied to the fieldset.
*/
baseCls: Ext.baseCSSPrefix + 'fieldset',
<span id='Ext-form-FieldSet-cfg-layout'> /**
</span> * @cfg {String} layout
* The {@link Ext.container.Container#layout} for the fieldset's immediate child items.
*/
layout: 'anchor',
border: 1,
componentLayout: 'fieldset',
autoEl: 'fieldset',
childEls: [
'body'
],
renderTpl: [
'{%this.renderLegend(out,values);%}',
'<div id="{id}-body" class="{baseCls}-body">',
'{%this.renderContainer(out,values);%}',
'</div>'
],
stateEvents : [ 'collapse', 'expand' ],
maskOnDisable: false,
beforeDestroy: function(){
var me = this,
legend = me.legend;
if (legend) {
// get rid of the ownerCt since it's not a proper item
delete legend.ownerCt;
legend.destroy();
me.legend = null;
}
me.callParent();
},
initComponent: function() {
var me = this,
baseCls = me.baseCls;
me.callParent();
me.addEvents(
<span id='Ext-form-FieldSet-event-beforeexpand'> /**
</span> * @event beforeexpand
* Fires before this FieldSet is expanded. Return false to prevent the expand.
* @param {Ext.form.FieldSet} f The FieldSet being expanded.
*/
"beforeexpand",
<span id='Ext-form-FieldSet-event-beforecollapse'> /**
</span> * @event beforecollapse
* Fires before this FieldSet is collapsed. Return false to prevent the collapse.
* @param {Ext.form.FieldSet} f The FieldSet being collapsed.
*/
"beforecollapse",
<span id='Ext-form-FieldSet-event-expand'> /**
</span> * @event expand
* Fires after this FieldSet has expanded.
* @param {Ext.form.FieldSet} f The FieldSet that has been expanded.
*/
"expand",
<span id='Ext-form-FieldSet-event-collapse'> /**
</span> * @event collapse
* Fires after this FieldSet has collapsed.
* @param {Ext.form.FieldSet} f The FieldSet that has been collapsed.
*/
"collapse"
);
if (me.collapsed) {
me.addCls(baseCls + '-collapsed');
me.collapse();
}
if (me.title) {
me.addCls(baseCls + '-with-title');
}
if (me.title || me.checkboxToggle || me.collapsible) {
me.addCls(baseCls + '-with-legend');
me.legend = Ext.widget(me.createLegendCt());
}
},
<span id='Ext-form-FieldSet-method-initRenderData'> /**
</span> * Initialized the renderData to be used when rendering the renderTpl.
* @return {Object} Object with keys and values that are going to be applied to the renderTpl
* @private
*/
initRenderData: function() {
var data = this.callParent();
data.baseCls = this.baseCls;
return data;
},
getState: function () {
var state = this.callParent();
state = this.addPropertyToState(state, 'collapsed');
return state;
},
afterCollapse: Ext.emptyFn,
afterExpand: Ext.emptyFn,
collapsedHorizontal: function () {
return true;
},
collapsedVertical: function () {
return true;
},
createLegendCt: function () {
var me = this,
items = [],
legend = {
xtype: 'container',
baseCls: me.baseCls + '-header',
id: me.id + '-legend',
autoEl: 'legend',
items: items,
ownerCt: me,
ownerLayout: me.componentLayout
};
// Checkbox
if (me.checkboxToggle) {
items.push(me.createCheckboxCmp());
} else if (me.collapsible) {
// Toggle button
items.push(me.createToggleCmp());
}
// Title
items.push(me.createTitleCmp());
return legend;
},
<span id='Ext-form-FieldSet-method-createTitleCmp'> /**
</span> * Creates the legend title component. This is only called internally, but could be overridden in subclasses to
* customize the title component. If {@link #toggleOnTitleClick} is set to true, a listener for the click event
* will toggle the collapsed state of the FieldSet.
* @return Ext.Component
* @protected
*/
createTitleCmp: function() {
var me = this,
cfg = {
xtype : 'component',
html : me.title,
cls : me.baseCls + '-header-text',
id : me.id + '-legendTitle'
};
if (me.collapsible && me.toggleOnTitleClick) {
cfg.listeners = {
el : {
scope : me,
click : me.toggle
}
};
cfg.cls += ' ' + me.baseCls + '-header-text-collapsible';
}
return (me.titleCmp = Ext.widget(cfg));
},
<span id='Ext-form-FieldSet-property-checkboxCmp'> /**
</span> * @property {Ext.form.field.Checkbox} checkboxCmp
* Refers to the {@link Ext.form.field.Checkbox} component that is added next to the title in the legend. Only
* populated if the fieldset is configured with {@link #checkboxToggle}:true.
*/
<span id='Ext-form-FieldSet-method-createCheckboxCmp'> /**
</span> * Creates the checkbox component. This is only called internally, but could be overridden in subclasses to
* customize the checkbox's configuration or even return an entirely different component type.
* @return Ext.Component
* @protected
*/
createCheckboxCmp: function() {
var me = this,
suffix = '-checkbox';
me.checkboxCmp = Ext.widget({
xtype: 'checkbox',
hideEmptyLabel: true,
name: me.checkboxName || me.id + suffix,
cls: me.baseCls + '-header' + suffix,
id: me.id + '-legendChk',
checked: !me.collapsed,
listeners: {
change: me.onCheckChange,
scope: me
}
});
return me.checkboxCmp;
},
<span id='Ext-form-FieldSet-property-toggleCmp'> /**
</span> * @property {Ext.panel.Tool} toggleCmp
* Refers to the {@link Ext.panel.Tool} component that is added as the collapse/expand button next to the title in
* the legend. Only populated if the fieldset is configured with {@link #collapsible}:true.
*/
<span id='Ext-form-FieldSet-method-createToggleCmp'> /**
</span> * Creates the toggle button component. This is only called internally, but could be overridden in subclasses to
* customize the toggle component.
* @return Ext.Component
* @protected
*/
createToggleCmp: function() {
var me = this;
me.toggleCmp = Ext.widget({
xtype: 'tool',
type: 'toggle',
handler: me.toggle,
id: me.id + '-legendToggle',
scope: me
});
return me.toggleCmp;
},
doRenderLegend: function (out, renderData) {
// Careful! This method is bolted on to the renderTpl so all we get for context is
// the renderData! The "this" pointer is the renderTpl instance!
var me = renderData.$comp,
legend = me.legend,
tree;
// Create the Legend component if needed
if (legend) {
legend.ownerLayout.configureItem(legend);
tree = legend.getRenderTree();
Ext.DomHelper.generateMarkup(tree, out);
}
},
finishRender: function () {
var legend = this.legend;
this.callParent();
if (legend) {
legend.finishRender();
}
},
getCollapsed: function () {
return this.collapsed ? 'top' : false;
},
getCollapsedDockedItems: function () {
var legend = this.legend;
return legend ? [ legend ] : [];
},
<span id='Ext-form-FieldSet-method-setTitle'> /**
</span> * Sets the title of this fieldset
* @param {String} title The new title
* @return {Ext.form.FieldSet} this
*/
setTitle: function(title) {
var me = this,
legend = me.legend;
me.title = title;
if (me.rendered) {
if (!me.legend) {
me.legend = legend = Ext.widget(me.createLegendCt());
legend.ownerLayout.configureItem(legend);
legend.render(me.el, 0);
}
me.titleCmp.update(title);
}
return me;
},
getTargetEl : function() {
return this.body || this.frameBody || this.el;
},
getContentTarget: function() {
return this.body;
},
<span id='Ext-form-FieldSet-method-expand'> /**
</span> * Expands the fieldset.
* @return {Ext.form.FieldSet} this
*/
expand : function(){
return this.setExpanded(true);
},
<span id='Ext-form-FieldSet-method-collapse'> /**
</span> * Collapses the fieldset.
* @return {Ext.form.FieldSet} this
*/
collapse : function() {
return this.setExpanded(false);
},
<span id='Ext-form-FieldSet-method-setExpanded'> /**
</span> * @private Collapse or expand the fieldset
*/
setExpanded: function(expanded) {
var me = this,
checkboxCmp = me.checkboxCmp,
operation = expanded ? 'expand' : 'collapse';
if (!me.rendered || me.fireEvent('before' + operation, me) !== false) {
expanded = !!expanded;
if (checkboxCmp) {
checkboxCmp.setValue(expanded);
}
if (expanded) {
me.removeCls(me.baseCls + '-collapsed');
} else {
me.addCls(me.baseCls + '-collapsed');
}
me.collapsed = !expanded;
if (me.rendered) {
// say explicitly we are not root because when we have a fixed/configured height
// our ownerLayout would say we are root and so would not have it's height
// updated since it's not included in the layout cycle
me.updateLayout({ isRoot: false });
me.fireEvent(operation, me);
}
}
return me;
},
getRefItems: function(deep) {
var refItems = this.callParent(arguments),
legend = this.legend;
// Prepend legend items to ensure correct order
if (legend) {
refItems.unshift(legend);
if (deep) {
refItems.unshift.apply(refItems, legend.getRefItems(true));
}
}
return refItems;
},
<span id='Ext-form-FieldSet-method-toggle'> /**
</span> * Toggle the fieldset's collapsed state to the opposite of what it is currently
*/
toggle: function() {
this.setExpanded(!!this.collapsed);
},
<span id='Ext-form-FieldSet-method-onCheckChange'> /**
</span> * @private
* Handle changes in the checkbox checked state
*/
onCheckChange: function(cmp, checked) {
this.setExpanded(checked);
},
setupRenderTpl: function (renderTpl) {
this.callParent(arguments);
renderTpl.renderLegend = this.doRenderLegend;
}
});
</pre>
</body>
</html>