3 * Copyright(c) 2006-2010 Ext JS, Inc.
5 * http://www.extjs.com/license
8 * @class Ext.form.CompositeField
9 * @extends Ext.form.Field
10 * Composite field allowing a number of form Fields to be rendered on the same row. The fields are rendered
11 * using an hbox layout internally, so all of the normal HBox layout config items are available. Example usage:
14 xtype: 'compositefield',
35 * In the example above the composite's fieldLabel will be set to 'Title, First, Last' as it groups the fieldLabels
36 * of each of its children. This can be overridden by setting a fieldLabel on the compositefield itself:
39 xtype: 'compositefield',
40 fieldLabel: 'Custom label',
44 * Any Ext.form.* component can be placed inside a composite field.
46 Ext.form.CompositeField = Ext.extend(Ext.form.Field, {
49 * @property defaultMargins
51 * The margins to apply by default to each field in the composite
53 defaultMargins: '0 5 0 0',
56 * @property skipLastItemMargin
58 * If true, the defaultMargins are not applied to the last item in the composite field set (defaults to true)
60 skipLastItemMargin: true,
63 * @property isComposite
65 * Signifies that this is a Composite field
70 * @property combineErrors
72 * True to combine errors from the individual fields into a single error message at the CompositeField level (defaults to true)
77 //Builds the composite field label
78 initComponent: function() {
83 for (var i=0, j = items.length; i < j; i++) {
86 labels.push(item.fieldLabel);
89 Ext.apply(item, this.defaults);
91 //apply default margins to each item except the last
92 if (!(i == j - 1 && this.skipLastItemMargin)) {
93 Ext.applyIf(item, {margins: this.defaultMargins});
97 this.fieldLabel = this.fieldLabel || this.buildLabel(labels);
100 * @property fieldErrors
101 * @type Ext.util.MixedCollection
102 * MixedCollection of current errors on the Composite's subfields. This is used internally to track when
103 * to show and hide error messages at the Composite level. Listeners are attached to the MixedCollection's
104 * add, remove and replace events to update the error icon in the UI as errors are added or removed.
106 this.fieldErrors = new Ext.util.MixedCollection(true, function(item) {
110 this.fieldErrors.on({
112 add : this.updateInvalidMark,
113 remove : this.updateInvalidMark,
114 replace: this.updateInvalidMark
117 Ext.form.CompositeField.superclass.initComponent.apply(this, arguments);
122 * Creates an internal container using hbox and renders the fields to it
124 onRender: function(ct, position) {
128 * @type Ext.Container
129 * A container configured with hbox layout which is responsible for laying out the subfields
131 var innerCt = this.innerCt = new Ext.Container({
135 cls : 'x-form-composite',
136 defaultMargins: '0 3 0 0'
139 this.el = innerCt.getEl();
141 var fields = innerCt.findBy(function(c) {
142 return c.isFormField;
147 * @type Ext.util.MixedCollection
148 * Internal collection of all of the subfields in this Composite
150 this.items = new Ext.util.MixedCollection();
151 this.items.addAll(fields);
153 //if we're combining subfield errors into a single message, override the markInvalid and clearInvalid
154 //methods of each subfield and show them at the Composite level instead
155 if (this.combineErrors) {
156 this.eachItem(function(field) {
158 markInvalid : this.onFieldMarkInvalid.createDelegate(this, [field], 0),
159 clearInvalid: this.onFieldClearInvalid.createDelegate(this, [field], 0)
164 //set the label 'for' to the first item
165 var l = this.el.parent().parent().child('label', true);
167 l.setAttribute('for', this.items.items[0].id);
171 Ext.form.CompositeField.superclass.onRender.apply(this, arguments);
175 * Called if combineErrors is true and a subfield's markInvalid method is called.
176 * By default this just adds the subfield's error to the internal fieldErrors MixedCollection
177 * @param {Ext.form.Field} field The field that was marked invalid
178 * @param {String} message The error message
180 onFieldMarkInvalid: function(field, message) {
181 var name = field.getName(),
182 error = {field: name, error: message};
184 this.fieldErrors.replace(name, error);
186 field.el.addClass(field.invalidClass);
190 * Called if combineErrors is true and a subfield's clearInvalid method is called.
191 * By default this just updates the internal fieldErrors MixedCollection.
192 * @param {Ext.form.Field} field The field that was marked invalid
194 onFieldClearInvalid: function(field) {
195 this.fieldErrors.removeKey(field.getName());
197 field.el.removeClass(field.invalidClass);
202 * Called after a subfield is marked valid or invalid, this checks to see if any of the subfields are
203 * currently invalid. If any subfields are invalid it builds a combined error message marks the composite
204 * invalid, otherwise clearInvalid is called
206 updateInvalidMark: function() {
207 var ieStrict = Ext.isIE6 && Ext.isStrict;
209 if (this.fieldErrors.length == 0) {
212 //IE6 in strict mode has a layout bug when using 'under' as the error message target. This fixes it
214 this.clearInvalid.defer(50, this);
217 var message = this.buildCombinedErrorMessage(this.fieldErrors.items);
220 this.markInvalid(message);
222 //IE6 in strict mode has a layout bug when using 'under' as the error message target. This fixes it
224 this.markInvalid(message);
230 * Performs validation checks on each subfield and returns false if any of them fail validation.
231 * @return {Boolean} False if any subfield failed validation
233 validateValue: function() {
236 this.eachItem(function(field) {
237 if (!field.isValid()) valid = false;
244 * Takes an object containing error messages for contained fields, returning a combined error
245 * string (defaults to just placing each item on a new line). This can be overridden to provide
246 * custom combined error message handling.
247 * @param {Array} errors Array of errors in format: [{field: 'title', error: 'some error'}]
248 * @return {String} The combined error message
250 buildCombinedErrorMessage: function(errors) {
254 for (var i = 0, j = errors.length; i < j; i++) {
257 combined.push(String.format("{0}: {1}", error.field, error.error));
260 return combined.join("<br />");
264 * Sorts the internal fieldErrors MixedCollection by the order in which the fields are defined.
265 * This is called before displaying errors to ensure that the errors are presented in the expected order.
266 * This function can be overridden to provide a custom sorting order if needed.
268 sortErrors: function() {
269 var fields = this.items;
271 this.fieldErrors.sort("ASC", function(a, b) {
272 var findByName = function(key) {
273 return function(field) {
274 return field.getName() == key;
278 var aIndex = fields.findIndexBy(findByName(a.field)),
279 bIndex = fields.findIndexBy(findByName(b.field));
281 return aIndex < bIndex ? -1 : 1;
286 * Resets each field in the composite to their previous value
289 this.eachItem(function(item) {
293 // Defer the clearInvalid so if BaseForm's collection is being iterated it will be called AFTER it is complete.
294 // Important because reset is being called on both the group and the individual items.
301 * Calls clearInvalid on all child fields. This is a convenience function and should not often need to be called
302 * as fields usually take care of clearing themselves
304 clearInvalidChildren: function() {
305 this.eachItem(function(item) {
311 * Builds a label string from an array of subfield labels.
312 * By default this just joins the labels together with a comma
313 * @param {Array} segments Array of each of the labels in the composite field's subfields
314 * @return {String} The built label
316 buildLabel: function(segments) {
317 return segments.join(", ");
321 * Checks each field in the composite and returns true if any is dirty
322 * @return {Boolean} True if any field is dirty
325 //override the behaviour to check sub items.
326 if (this.disabled || !this.rendered) {
331 this.eachItem(function(item){
342 * Convenience function which passes the given function to every item in the composite
343 * @param {Function} fn The function to call
344 * @param {Object} scope Optional scope object
346 eachItem: function(fn, scope) {
347 if(this.items && this.items.each){
348 this.items.each(fn, scope || this);
354 * Passes the resize call through to the inner panel
356 onResize: function(adjWidth, adjHeight, rawWidth, rawHeight) {
357 var innerCt = this.innerCt;
359 if (this.rendered && innerCt.rendered) {
360 innerCt.setSize(adjWidth, adjHeight);
363 Ext.form.CompositeField.superclass.onResize.apply(this, arguments);
368 * Forces the internal container to be laid out again
370 doLayout: function(shallow, force) {
372 var innerCt = this.innerCt;
374 innerCt.forceLayout = this.ownerCt.forceLayout;
375 innerCt.doLayout(shallow, force);
382 beforeDestroy: function(){
383 Ext.destroy(this.innerCt);
385 Ext.form.CompositeField.superclass.beforeDestroy.call(this);
388 //override the behaviour to check sub items.
389 setReadOnly : function(readOnly) {
390 readOnly = readOnly || true;
393 this.eachItem(function(item){
394 item.setReadOnly(readOnly);
397 this.readOnly = readOnly;
400 onShow : function() {
401 Ext.form.CompositeField.superclass.onShow.call(this);
405 //override the behaviour to check sub items.
406 onDisable : function(){
407 this.eachItem(function(item){
412 //override the behaviour to check sub items.
413 onEnable : function(){
414 this.eachItem(function(item){
420 Ext.reg('compositefield', Ext.form.CompositeField);