4 * Copyright(c) 2006-2007, Ext JS, LLC.
6 * Originally Released Under LGPL - original licence link has changed is not relivant.
9 * <script type="text/javascript">
13 * @class Roo.form.Form
14 * @extends Roo.form.BasicForm
15 * Adds the ability to dynamically render forms with JavaScript to {@link Roo.form.BasicForm}.
17 * @param {Object} config Configuration options
19 Roo.form.Form = function(config){
22 xitems = config.items;
27 Roo.form.Form.superclass.constructor.call(this, null, config);
28 this.url = this.url || this.action;
30 this.root = new Roo.form.Layout(Roo.applyIf({
34 this.active = this.root;
36 * Array of all the buttons that have been added to this form via {@link addButton}
43 * @event clientvalidation
44 * If the monitorValid config option is true, this event fires repetitively to notify of valid state
46 * @param {Boolean} valid true if the form has passed client-side validation
48 clientvalidation: true,
51 * Fires when the form is rendered
52 * @param {Roo.form.Form} form
57 if (this.progressUrl) {
58 // push a hidden field onto the list of fields..
59 this.items.addxtype( {
62 name : 'UPLOAD_IDENTIFIER'
67 Roo.each(xitems, this.addxtype, this);
73 Roo.extend(Roo.form.Form, Roo.form.BasicForm, {
75 * @cfg {Number} labelWidth The width of labels. This property cascades to child containers.
78 * @cfg {String} itemCls A css class to apply to the x-form-item of fields. This property cascades to child containers.
81 * @cfg {String} buttonAlign Valid values are "left," "center" and "right" (defaults to "center")
86 * @cfg {Number} minButtonWidth Minimum width of all buttons in pixels (defaults to 75)
91 * @cfg {String} labelAlign Valid values are "left," "top" and "right" (defaults to "left").
92 * This property cascades to child containers if not set.
97 * @cfg {Boolean} monitorValid If true the form monitors its valid state <b>client-side</b> and
98 * fires a looping event with that state. This is required to bind buttons to the valid
99 * state using the config value formBind:true on the button.
101 monitorValid : false,
104 * @cfg {Number} monitorPoll The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)
109 * @cfg {String} progressUrl - Url to return progress data
115 * Opens a new {@link Roo.form.Column} container in the layout stack. If fields are passed after the config, the
116 * fields are added and the column is closed. If no fields are passed the column remains open
117 * until end() is called.
118 * @param {Object} config The config to pass to the column
119 * @param {Field} field1 (optional)
120 * @param {Field} field2 (optional)
121 * @param {Field} etc (optional)
122 * @return Column The column container object
124 column : function(c){
125 var col = new Roo.form.Column(c);
127 if(arguments.length > 1){ // duplicate code required because of Opera
128 this.add.apply(this, Array.prototype.slice.call(arguments, 1));
135 * Opens a new {@link Roo.form.FieldSet} container in the layout stack. If fields are passed after the config, the
136 * fields are added and the fieldset is closed. If no fields are passed the fieldset remains open
137 * until end() is called.
138 * @param {Object} config The config to pass to the fieldset
139 * @param {Field} field1 (optional)
140 * @param {Field} field2 (optional)
141 * @param {Field} etc (optional)
142 * @return FieldSet The fieldset container object
144 fieldset : function(c){
145 var fs = new Roo.form.FieldSet(c);
147 if(arguments.length > 1){ // duplicate code required because of Opera
148 this.add.apply(this, Array.prototype.slice.call(arguments, 1));
155 * Opens a new {@link Roo.form.Layout} container in the layout stack. If fields are passed after the config, the
156 * fields are added and the container is closed. If no fields are passed the container remains open
157 * until end() is called.
158 * @param {Object} config The config to pass to the Layout
159 * @param {Field} field1 (optional)
160 * @param {Field} field2 (optional)
161 * @param {Field} etc (optional)
162 * @return Layout The container object
164 container : function(c){
165 var l = new Roo.form.Layout(c);
167 if(arguments.length > 1){ // duplicate code required because of Opera
168 this.add.apply(this, Array.prototype.slice.call(arguments, 1));
175 * Opens the passed container in the layout stack. The container can be any {@link Roo.form.Layout} or subclass.
176 * @param {Object} container A Roo.form.Layout or subclass of Layout
177 * @return {Form} this
180 // cascade label info
181 Roo.applyIf(c, {'labelAlign': this.active.labelAlign, 'labelWidth': this.active.labelWidth, 'itemCls': this.active.itemCls});
182 this.active.stack.push(c);
183 c.ownerCt = this.active;
189 * Closes the current open container
190 * @return {Form} this
193 if(this.active == this.root){
196 this.active = this.active.ownerCt;
201 * Add Roo.form components to the current open container (e.g. column, fieldset, etc.). Fields added via this method
202 * can also be passed with an additional property of fieldLabel, which if supplied, will provide the text to display
203 * as the label of the field.
204 * @param {Field} field1
205 * @param {Field} field2 (optional)
206 * @param {Field} etc. (optional)
207 * @return {Form} this
210 this.active.stack.push.apply(this.active.stack, arguments);
211 this.allItems.push.apply(this.allItems,arguments);
213 for(var i = 0, a = arguments, len = a.length; i < len; i++) {
214 if(a[i].isFormField){
219 Roo.form.Form.superclass.add.apply(this, r);
229 * Find any element that has been added to a form, using it's ID or name
230 * This can include framesets, columns etc. along with regular fields..
231 * @param {String} id - id or name to find.
233 * @return {Element} e - or false if nothing found.
235 findbyId : function(id)
241 Ext.each(this.allItems, function(f){
242 if (f.id == id || f.name == id ){
253 * Render this form into the passed container. This should only be called once!
254 * @param {String/HTMLElement/Element} container The element this component should be rendered into
255 * @return {Form} this
257 render : function(ct)
263 var o = this.autoCreate || {
265 method : this.method || 'POST',
266 id : this.id || Roo.id()
268 this.initEl(ct.createChild(o));
270 this.root.render(this.el);
274 this.items.each(function(f){
275 f.render('x-form-el-'+f.id);
278 if(this.buttons.length > 0){
279 // tables are required to maintain order and for correct IE layout
280 var tb = this.el.createChild({cls:'x-form-btns-ct', cn: {
281 cls:"x-form-btns x-form-btns-"+this.buttonAlign,
282 html:'<table cellspacing="0"><tbody><tr></tr></tbody></table><div class="x-clear"></div>'
284 var tr = tb.getElementsByTagName('tr')[0];
285 for(var i = 0, len = this.buttons.length; i < len; i++) {
286 var b = this.buttons[i];
287 var td = document.createElement('td');
288 td.className = 'x-form-btn-td';
289 b.render(tr.appendChild(td));
292 if(this.monitorValid){ // initialize after render
293 this.startMonitoring();
295 this.fireEvent('rendered', this);
300 * Adds a button to the footer of the form - this <b>must</b> be called before the form is rendered.
301 * @param {String/Object} config A string becomes the button text, an object can either be a Button config
302 * object or a valid Roo.DomHelper element config
303 * @param {Function} handler The function called when the button is clicked
304 * @param {Object} scope (optional) The scope of the handler function
305 * @return {Roo.Button}
307 addButton : function(config, handler, scope){
311 minWidth: this.minButtonWidth,
314 if(typeof config == "string"){
317 Roo.apply(bc, config);
319 var btn = new Roo.Button(null, bc);
320 this.buttons.push(btn);
325 * Adds a series of form elements (using the xtype property as the factory method.
326 * Valid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column, (and 'end' to close a block)
327 * @param {Object} config
330 addxtype : function()
332 var ar = Array.prototype.slice.call(arguments, 0);
334 for(var i = 0; i < ar.length; i++) {
336 continue; // skip -- if this happends something invalid got sent, we
337 // should ignore it, as basically that interface element will not show up
338 // and that should be pretty obvious!!
341 if (Roo.form[ar[i].xtype]) {
343 var fe = Roo.factory(ar[i], Roo.form);
349 fe.store.form = this;
354 this.allItems.push(fe);
355 if (fe.items && fe.addxtype) {
356 fe.addxtype.apply(fe, fe.items);
366 // console.log('adding ' + ar[i].xtype);
368 if (ar[i].xtype == 'Button') {
369 //console.log('adding button');
370 //console.log(ar[i]);
371 this.addButton(ar[i]);
372 this.allItems.push(fe);
376 if (ar[i].xtype == 'end') { // so we can add fieldsets... / layout etc.
377 alert('end is not supported on xtype any more, use items');
379 // //console.log('adding end');
387 * Starts monitoring of the valid state of this form. Usually this is done by passing the config
388 * option "monitorValid"
390 startMonitoring : function(){
394 run : this.bindHandler,
395 interval : this.monitorPoll || 200,
402 * Stops monitoring of the valid state of this form
404 stopMonitoring : function(){
409 bindHandler : function(){
411 return false; // stops binding
414 this.items.each(function(f){
415 if(!f.isValid(true)){
420 for(var i = 0, len = this.buttons.length; i < len; i++){
421 var btn = this.buttons[i];
422 if(btn.formBind === true && btn.disabled === valid){
423 btn.setDisabled(!valid);
426 this.fireEvent('clientvalidation', this, valid);
440 Roo.Form = Roo.form.Form;