Updated Rico 2 and Rico 3 with all patches submitted on Sourceforge.
[infodrom/rico3] / minsrc / ricoLiveGridForms.js
1 /*
2  *  (c) 2005-2009 Richard Cowin (http://openrico.org)
3  *  (c) 2005-2009 Matt Brown (http://dowdybrown.com)
4  *
5  *  Licensed under the Apache License, Version 2.0 (the "License"); you may not use this
6  *  file except in compliance with the License. You may obtain a copy of the License at
7  *
8  *         http://www.apache.org/licenses/LICENSE-2.0
9  *
10  *  Unless required by applicable law or agreed to in writing, software distributed under the
11  *  License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
12  *  either express or implied. See the License for the specific language governing permissions
13  *  and limitations under the License.
14  */
15
16 if(typeof Rico=='undefined') throw("LiveGridForms requires the Rico JavaScript framework");
17
18
19 Rico.TableEdit = function(liveGrid) {
20   this.initialize(liveGrid);
21 }
22
23 Rico.TableEdit.prototype = {
24 /**
25  * @class Supports editing LiveGrid data.
26  * @constructs
27  */
28   initialize: function(liveGrid) {
29     Rico.log('Rico.TableEdit initialize: '+liveGrid.tableId);
30     this.grid=liveGrid;
31     this.options = {
32       maxDisplayLen    : 20,    // max displayed text field length
33       panelHeight      : 200,   // size of tabbed panels
34       panelWidth       : 500,
35       compact          : false,    // compact corners
36       RecordName       : Rico.getPhraseById("record"),
37       updateURL        : window.location.href, // default is that updates post back to the generating page
38       showSaveMsg      : 'errors'  // disposition of database update responses (full - show full response, errors - show full response for errors and short response otherwise)
39     };
40     Rico.extend(this.options, liveGrid.options);
41     var self=this;
42     this.menu=liveGrid.menu;
43     this.menu.options.dataMenuHandler=function(grid,r,c,onBlankRow) { return self.editMenu(grid,r,c,onBlankRow); };
44     this.menu.ignoreClicks();
45     this.editText=Rico.getPhraseById("editRecord",this.options.RecordName);
46     this.cloneText=Rico.getPhraseById("cloneRecord",this.options.RecordName);
47     this.delText=Rico.getPhraseById("deleteRecord",this.options.RecordName);
48     this.addText=Rico.getPhraseById("addRecord",this.options.RecordName);
49     this.buttonHover=new Rico.HoverSet();
50     this.dateRegExp=/^\s*(\w+)(\W)(\w+)(\W)(\w+)/i;
51     Rico.EditControls.atLoad();
52     this.createKeyArray();
53     this.createEditDiv();
54     this.saveMsg=Rico.$(liveGrid.tableId+'_savemsg');
55     Rico.eventBind(document,"click", Rico.eventHandle(this,'clearSaveMsg'));
56     this.extraMenuItems=[];
57     this.responseHandler=function(xhr) { self.processResponse(xhr); };
58     Rico.log("Rico.TableEdit.initialize complete");
59   },
60
61   createKeyArray: function() {
62     this.keys=[];
63     for (var i=0; i<this.grid.columns.length; i++) {
64       if (this.grid.columns[i].format && this.grid.columns[i].format.isKey)
65         this.keys.push({colidx:i});
66     }
67   },
68
69   createEditDiv: function() {
70
71     // create popup form
72
73     this.requestCount=1;
74     this.formPopup=this.createWindow();
75     Rico.addClass(this.formPopup.content.parentNode,'ricoLG_editDiv');
76     if (this.options.canEdit || this.options.canAdd) {
77       this.startForm();
78       this.createForm(this.form);
79     } else {
80       var buttonClose=this.createButton(Rico.getPhraseById("close"));
81       Rico.eventBind(buttonClose,"click", Rico.eventHandle(this,'cancelEdit'), false);
82       this.createForm(this.formPopup.contentDiv);
83     }
84     this.editDivCreated=true;
85
86     // create responseDialog
87
88     this.responseDialog = this.grid.createDiv('editResponse',document.body);
89     this.responseDialog.style.display='none';
90
91     var buttonOK = document.createElement('button');
92     buttonOK.appendChild(document.createTextNode('OK'));
93     Rico.eventBind(buttonOK,"click", Rico.eventHandle(this,'ackResponse'));
94     this.responseDialog.appendChild(buttonOK);
95
96     this.responseDiv = this.grid.createDiv('editResponseText',this.responseDialog);
97
98     if (this.panelGroup) {
99       Rico.log("createEditDiv complete, requestCount="+this.requestCount);
100       Rico.runLater(50,this,'initPanelGroup');
101     }
102   },
103   
104   createWindow: function() {
105     var self=this;
106     return new Rico.Window('', {closeFunc: function() { self.makeFormInvisible(); }, overflow: this.options.ColGroups ? 'hidden' : 'auto'});
107   },
108
109   initPanelGroup: function() {
110     this.requestCount--;
111     Rico.log("initPanelGroup: "+this.requestCount);
112     if (this.requestCount>0) return;
113     var wi=parseInt(this.options.panelWidth,10);
114     if (this.form) {
115       //this.form.style.width=(wi+10)+'px';
116       if (Rico.isWebKit) this.formPopup.container.style.display='block';  // this causes display to flash briefly
117       this.options.bgColor = Rico.Color.createColorFromBackground(this.form).toString();
118     }
119     this.formPopup.container.style.display='none';
120     this.formPanels=new Rico.TabbedPanel(this.panelGroup, this.options);
121   },
122
123   notEmpty: function(v) {
124     return typeof(v)!='undefined';
125   },
126
127   startForm: function() {
128     this.form = document.createElement('form');
129     /** @ignore */
130     this.form.onsubmit=function() {return false;};
131     this.form.autocomplete="off"; // seems to fix "Permission denied..." errors in FF
132     this.formPopup.contentDiv.appendChild(this.form);
133
134     var tab = document.createElement('div');
135     tab.className='ButtonBar';
136     var button=tab.appendChild(this.createButton(Rico.getPhraseById("saveRecord",this.options.RecordName)));
137     Rico.eventBind(button,"click", Rico.eventHandle(this,'TESubmit'), false);
138     button=tab.appendChild(this.createButton(Rico.getPhraseById("cancel")));
139     Rico.eventBind(button,"click", Rico.eventHandle(this,'cancelEdit'), false);
140     this.form.appendChild(tab);
141
142     // hidden fields
143     this.hiddenFields = document.createElement('div');
144     this.hiddenFields.style.display='none';
145     this.action = this.appendHiddenField(this.grid.actionId,'');
146     var i,fldSpec;
147     for (i=0; i<this.grid.columns.length; i++) {
148       fldSpec=this.grid.columns[i].format;
149       if (fldSpec && fldSpec.FormView && fldSpec.FormView=="hidden")
150         this.appendHiddenField(fldSpec.FieldName,fldSpec.ColData);
151     }
152     for (var k=0; k<this.keys.length; k++) {
153       this.keys[k].keyField = this.appendHiddenField('_k'+this.keys[k].colidx,'');
154     }
155     this.form.appendChild(this.hiddenFields);
156   },
157
158   createButton: function(buttonLabel) {
159     var button = document.createElement('a');
160     button.href='javascript:void(0)';
161     button.innerHTML=buttonLabel;
162     button.className='RicoButton';
163     if (Rico.theme.button) Rico.addClass(button,Rico.theme.button);
164     this.buttonHover.add(button);
165     return button;
166   },
167
168   createPanel: function(i) {
169     var hasFields=false;
170     for (var j=0; j<this.grid.columns.length; j++) {
171       var fldSpec=this.grid.columns[j].format;
172       if (!fldSpec) continue;
173       if (!fldSpec.EntryType) continue;
174       if (fldSpec.EntryType=='H') continue;
175       if (fldSpec.FormView && fldSpec.FormView=="hidden") continue;
176       var panelIdx=fldSpec.ColGroupIdx || 0;
177       if (panelIdx==i) {
178         hasFields=true;
179         break;
180       }
181     }
182     if (!hasFields) return null;
183     this.panelHdr[i] = document.createElement('li');
184     this.panelHdr[i].innerHTML=this.options.ColGroups[i];
185     this.panelHdrs.appendChild(this.panelHdr[i]);
186     this.panelContent[i] = document.createElement('div');
187     this.panelContents.appendChild(this.panelContent[i]);
188     this.panelActualIdx[i]=this.panelCnt++;
189     return this.createFormTable(this.panelContent[i],'tabContent');
190   },
191
192   createForm: function(parentDiv) {
193     var i,div,fldSpec,panelIdx,tables=[];
194     this.panelCnt=0;
195     this.panelHdr=[];
196     this.panelContent=[];
197     if (this.options.ColGroups) {
198       this.panelGroup = document.createElement('div');
199       this.panelGroup.className='tabPanelGroup';
200       this.panelHdrs = document.createElement('ul');
201       this.panelGroup.appendChild(this.panelHdrs);
202       this.panelContents = document.createElement('div');
203       this.panelContents.className='tabContentContainer';
204       this.panelGroup.appendChild(this.panelContents);
205       this.panelActualIdx=[];
206       parentDiv.appendChild(this.panelGroup);
207       if (this.grid.direction=='rtl') {
208         for (i=this.options.ColGroups.length-1; i>=0; i--) {
209           tables[i]=this.createPanel(i);
210         }
211       } else {
212         for (i=0; i<this.options.ColGroups.length; i++) {
213           tables[i]=this.createPanel(i);
214         }
215       }
216       parentDiv.appendChild(this.panelGroup);
217     } else {
218       div=document.createElement('div');
219       div.className='noTabContent';
220       tables[0]=this.createFormTable(div);
221       parentDiv.appendChild(div);
222     }
223     for (i=0; i<this.grid.columns.length; i++) {
224       fldSpec=this.grid.columns[i].format;
225       if (!fldSpec) continue;
226       panelIdx=fldSpec.ColGroupIdx || 0;
227       if (tables[panelIdx]) this.appendFormField(this.grid.columns[i],tables[panelIdx]);
228       if (typeof fldSpec.pattern=='string') {
229         switch (fldSpec.pattern) {
230           case 'email':
231             fldSpec.regexp=/^[_a-zA-Z0-9-]+(\.[_a-zA-Z0-9-]+)*@[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)*\.(([0-9]{1,3})|([a-zA-Z]{2,3})|(aero|coop|info|museum|name))$/;
232             break;
233           case 'float-unsigned':
234             fldSpec.regexp=/^\d+(\.\d+)?$/;
235             break;
236           case 'float-signed':
237             fldSpec.regexp=/^[-+]?\d+(\.\d+)?$/;
238             break;
239           case 'int-unsigned':
240             fldSpec.regexp=/^\d+$/;
241             break;
242           case 'int-signed':
243             fldSpec.regexp=/^[-+]?\d+$/;
244             break;
245           default:
246             fldSpec.regexp=new RegExp(fldSpec.pattern);
247             break;
248         }
249       }
250     }
251   },
252
253   createFormTable: function(div) {
254     var tab=document.createElement('table');
255     tab.border=0;
256     div.appendChild(tab);
257     return tab;
258   },
259
260   appendHiddenField: function(name,value) {
261     var field=Rico.createFormField(this.hiddenFields,'input','hidden',name,name);
262     field.value=value;
263     return field;
264   },
265
266   appendFormField: function(column, table) {
267     var fmt=column.format;
268     if (!fmt.EntryType) return;
269     if (fmt.EntryType=="H") return;
270     if (fmt.FormView) return;
271     Rico.log('appendFormField: '+column.displayName+' - '+fmt.EntryType);
272     var row = fmt.noFormBreak && table.rows.length > 0 ? table.rows[table.rows.length-1] : table.insertRow(-1);
273     var hdr = row.insertCell(-1);
274     column.formLabel=hdr;
275     if (hdr.noWrap) hdr.noWrap=true;
276     var entry = row.insertCell(-1);
277     if (entry.noWrap) entry.noWrap=true;
278     hdr.id='lbl_'+fmt.FieldName;
279     var field, name=fmt.FieldName;
280     switch (fmt.EntryType) {
281       case 'TA':
282       case 'tinyMCE':
283         field=Rico.createFormField(entry,'textarea',null,name);
284         field.cols=fmt.TxtAreaCols;
285         field.rows=fmt.TxtAreaRows;
286         field.innerHTML=fmt.ColData;
287         hdr.style.verticalAlign='top';
288         break;
289       case 'R':
290       case 'RL':
291         field=Rico.createFormField(entry,'div',null,name);
292         if (fmt.DescriptionField) field.RicoUpdate=fmt.DescriptionField;
293         if (fmt.MultiSelect) Rico.addClass(field, 'MultiSelect');
294         if (fmt.isNullable && !fmt.MultiSelect) this.addSelectNone(field);
295         this.selectValuesRequest(field,column);
296         break;
297       case 'N':
298         field=Rico.createFormField(entry,'select',null,name);
299         if (fmt.isNullable) this.addSelectNone(field);
300         Rico.eventBind(field,"change", Rico.eventHandle(this,'checkSelectNew'));
301         this.selectValuesRequest(field,column);
302         field=document.createElement('span');
303         field.className='ricoEditLabel';
304         field.id='labelnew__'+fmt.FieldName;
305         field.innerHTML='&nbsp;&nbsp;&nbsp;'+Rico.getPhraseById('formNewValue').replace(' ','&nbsp;');
306         entry.appendChild(field);
307         name='textnew__'+fmt.FieldName;
308         field=Rico.createFormField(entry,'input','text',name,name);
309         break;
310       case 'S':
311       case 'SL':
312         if (fmt.ReadOnly) {
313           field=Rico.createFormField(entry,'input','text',name,name);
314           this.initField(field,fmt);
315         } else {
316           field=Rico.createFormField(entry,'select',null,name);
317           if (fmt.MultiSelect) field.multiple=true;
318           if (fmt.SelectRows) field.size=parseInt(fmt.SelectRows,10);
319           if (fmt.isNullable && !fmt.MultiSelect) this.addSelectNone(field);
320           if (fmt.DescriptionField) {
321             field.RicoUpdate=fmt.DescriptionField;
322             Rico.eventBind(field,"change", Rico.eventHandle(this,'selectClick'), false);
323           }
324           this.selectValuesRequest(field,column);
325         }
326         break;
327       case 'D':
328         if (!fmt.isNullable) fmt.required=true;
329         if (!fmt.dateFmt) fmt.dateFmt=Rico.dateFmt;
330         if (!fmt.Help) fmt.Help=fmt.dateFmt;
331         if (typeof fmt.min=='string') fmt.min=Rico.setISO8601(fmt.min) || new Date(fmt.min);
332         if (typeof fmt.max=='string') fmt.max=Rico.setISO8601(fmt.max) || new Date(fmt.max);
333         if (Rico.inputtypes.date) {
334           field=Rico.createFormField(entry,'input','date',name,name);
335           field.required=fmt.required;
336           if (fmt.min) field.min=Rico.toISO8601String(fmt.min,3);
337           if (fmt.max) field.max=Rico.toISO8601String(fmt.max,3);
338           field.required=fmt.required;
339           fmt.SelectCtl=null;  // use the WebForms calendar instead of the Rico calendar
340         } else {
341           field=Rico.createFormField(entry,'input','text',name,name);
342         }
343         this.initField(field,fmt);
344         break;
345       case 'I':
346         if (!fmt.isNullable) fmt.required=true;
347         if (!fmt.pattern) fmt.pattern='int-signed';
348         if (Rico.inputtypes.number) {
349           field=Rico.createFormField(entry,'input','number',name,name);
350           field.required=fmt.required;
351           field.min=fmt.min;
352           field.max=fmt.max;
353           field.step=1;
354         } else {
355           field=Rico.createFormField(entry,'input','text',name,name);
356         }
357         if (typeof fmt.min=='string') fmt.min=parseInt(fmt.min,10);
358         if (typeof fmt.max=='string') fmt.max=parseInt(fmt.max,10);
359         this.initField(field,fmt);
360         break;
361       case 'F':
362         if (!fmt.isNullable) fmt.required=true;
363         if (!fmt.pattern) fmt.pattern='float-signed';
364         field=Rico.createFormField(entry,'input','text',name,name);
365         this.initField(field,fmt);
366         if (typeof fmt.min=='string') fmt.min=parseFloat(fmt.min);
367         if (typeof fmt.max=='string') fmt.max=parseFloat(fmt.max);
368         break;
369       default:
370         field=Rico.createFormField(entry,'input','text',name,name);
371         if (!fmt.isNullable && fmt.EntryType!='T') fmt.required=true;
372         this.initField(field,fmt);
373         break;
374     }
375     if (field && fmt.SelectCtl) {
376       Rico.EditControls.applyTo(column,field);
377     }
378     var hdrSuffix='';
379     hdr.className='ricoEditLabel';
380     if (fmt.Help) {
381       hdr.title=fmt.Help;
382       hdrSuffix="&nbsp;<span class='rico-icon rico-info'></span>";
383     }
384     var hdrText=fmt.EntryType.length>1 && fmt.EntryType.charAt(1)=='L' ? column.next.displayName : column.displayName;
385     hdr.innerHTML=hdrText+hdrSuffix;
386   },
387
388   addSelectNone: function(field) {
389     this.addSelectOption(field,this.options.TableSelectNone,Rico.getPhraseById("selectNone"));
390   },
391
392   initField: function(field,fmt) {
393     if (fmt.Length) {
394       field.maxLength=fmt.Length;
395       field.size=Math.min(fmt.Length, this.options.maxDisplayLen);
396     }
397     field.value=fmt.ColData;
398   },
399   
400   selectClick: function(e) {
401     var SelObj=Rico.eventElement(e);
402     if (SelObj.readOnly) {
403       Rico.eventStop(e);
404       return false;
405     }
406     if (SelObj.RicoUpdate) {
407       var opt=SelObj.options[SelObj.selectedIndex];
408       Rico.$(SelObj.RicoUpdate).value=opt.innerHTML;
409     }
410   },
411   
412   radioClick: function(e) {
413     var ChkBoxObj=Rico.eventElement(e);
414     if (ChkBoxObj.readOnly) {
415       Rico.eventStop(e);
416       return false;
417     }
418     var container=Rico.getParentByTagName(ChkBoxObj,'div');
419     if (container.RicoUpdate) {
420       Rico.$(container.RicoUpdate).value=ChkBoxObj.nextSibling.innerHTML;
421     }
422   },
423
424   checkSelectNew: function(e) {
425     this.updateSelectNew(Rico.eventElement(e));
426   },
427
428   updateSelectNew: function(SelObj) {
429     var vis=(SelObj.value==this.options.TableSelectNew) ? "" : "hidden";
430     Rico.$("labelnew__" + SelObj.id).style.visibility=vis;
431     Rico.$("textnew__" + SelObj.id).style.visibility=vis;
432   },
433
434   selectValuesRequest: function(elem,column) {
435     var fldSpec=column.format;
436     if (fldSpec.SelectValues) {
437       var valueList=fldSpec.SelectValues.split(',');
438       for (var i=0; i<valueList.length; i++)
439         this.addSelectOption(elem,valueList[i],valueList[i],i);
440     } else {
441       this.requestCount++;
442       var options={}, self=this;
443       Rico.extend(options, this.grid.buffer.ajaxOptions);
444       options.parameters = {id: this.grid.tableId, offset: '0', page_size: '-1', edit: column.index};
445       options.parameters[this.grid.actionId]="query";
446       options.onComplete = function(request) { self.selectValuesUpdate(elem,request); };
447       new Rico.ajaxRequest(this.grid.buffer.dataSource, options);
448       Rico.log("selectValuesRequest: "+fldSpec.FieldName);
449     }
450   },
451
452   selectValuesUpdate: function(elem,request) {
453     var response = request.responseXML.getElementsByTagName("ajax-response");
454     Rico.log("selectValuesUpdate: "+request.status);
455     if (response == null || response.length != 1) return;
456     response=response[0];
457     var error = response.getElementsByTagName('error');
458     if (error.length > 0) {
459       var errmsg=Rico.getContentAsString(error[0],this.grid.buffer.isEncoded);
460       Rico.log("Data provider returned an error:\n"+errmsg);
461       alert(Rico.getPhraseById("requestError",errmsg));
462       return;
463     }
464     response=response.getElementsByTagName('response')[0];
465     var rowsElement = response.getElementsByTagName('rows')[0];
466     var rows = this.grid.buffer.dom2jstable(rowsElement);
467     Rico.log("selectValuesUpdate: id="+elem.id+' rows='+rows.length);
468     for (var i=0; i<rows.length; i++) {
469       if (rows[i].length>0) {
470         var c0=rows[i][0];
471         var c1=(rows[i].length>1) ? rows[i][1] : c0;
472         this.addSelectOption(elem,c0,c1,i);
473       }
474     }
475     if (Rico.$('textnew__'+elem.id))
476       this.addSelectOption(elem,this.options.TableSelectNew,Rico.getPhraseById("selectNewVal"));
477     if (this.panelGroup)
478       Rico.runLater(50,this,'initPanelGroup');
479   },
480
481   addSelectOption: function(elem,value,text,idx) {
482     switch (elem.tagName.toLowerCase()) {
483       case 'div':
484         var opt=Rico.createFormField(elem,'input', Rico.hasClass(elem, 'MultiSelect') ? 'checkbox' : 'radio', elem.id+'_'+idx, elem.id);
485         opt.value=value;
486         var lbl=document.createElement('label');
487         lbl.innerHTML=text;
488         lbl.htmlFor=opt.id;
489         elem.appendChild(lbl);
490         Rico.eventBind(opt,"click", Rico.eventHandle(this,'radioClick'), false);
491         break;
492       case 'select':
493         Rico.addSelectOption(elem,value,text);
494         break;
495     }
496   },
497
498   clearSaveMsg: function() {
499     if (this.saveMsg) this.saveMsg.innerHTML="";
500   },
501
502   addMenuItem: function(menuText,menuAction,enabled) {
503     this.extraMenuItems.push({menuText:menuText,menuAction:menuAction,enabled:enabled});
504   },
505
506   editMenu: function(grid,r,c,onBlankRow) {
507     this.clearSaveMsg();
508     if (this.grid.buffer.sessionExpired==true || this.grid.buffer.startPos<0) return false;
509     this.rowIdx=r;
510     var elemTitle=Rico.$('pageTitle');
511     var pageTitle=elemTitle ? elemTitle.innerHTML : document.title;
512     this.menu.addMenuHeading(pageTitle);
513     var self=this;
514     if (onBlankRow==false) {
515       for (var i=0; i<this.extraMenuItems.length; i++) {
516         this.menu.addMenuItem(this.extraMenuItems[i].menuText,this.extraMenuItems[i].menuAction,this.extraMenuItems[i].enabled);
517       }
518       this.menu.addMenuItem(this.editText, function() { self.editRecord(); },this.canEdit(r));
519       this.menu.addMenuItem(this.delText, function() { self.deleteRecord(); },this.canDelete(r));
520       if (this.options.canClone) {
521         this.menu.addMenuItem(this.cloneText, function() { self.cloneRecord(); },this.canAdd(r) && this.canEdit(r));
522       }
523     }
524     this.menu.addMenuItem(this.addText, function() { self.addRecord(); },this.canAdd(r));
525     return true;
526   },
527   
528   canAdd: function(r) {
529     return (typeof this.options.canAdd=='function') ? this.options.canAdd(r) : this.options.canAdd;
530   },
531
532   canEdit: function(r) {
533     return (typeof this.options.canEdit=='function') ? this.options.canEdit(r) : this.options.canEdit;
534   },
535
536   canDelete: function(r) {
537     return (typeof this.options.canDelete=='function') ? this.options.canDelete(r) : this.options.canDelete;
538   },
539
540   cancelEdit: function(e) {
541     Rico.eventStop(e);
542     this.makeFormInvisible();
543     this.grid.highlightEnabled=true;
544     this.menu.cancelmenu();
545     return false;
546   },
547
548   setField: function(fldnum,fldvalue) {
549     var fldSpec=this.grid.columns[fldnum].format;
550     var e=Rico.$(fldSpec.FieldName);
551     var a,i,o,elems,opts,txt;
552     if (!e) return;
553     Rico.log('setField: '+fldSpec.FieldName+'='+fldvalue);
554     switch (e.tagName.toUpperCase()) {
555       case 'DIV':
556         elems=e.getElementsByTagName('INPUT');
557         o={}
558         if (fldSpec.MultiSelect && fldvalue) {
559           a=fldvalue.split(',');
560           for (var i=0; i<a.length; i++) o[a[i]]=1;
561         } else {
562           o[fldvalue]=1;
563         }
564         for (i=0; i<elems.length; i++)
565           elems[i].checked=o[elems[i].value]==1;
566         break;
567       case 'INPUT':
568         if (fldSpec.EntryType=='D' && fldvalue!=fldSpec.ColData) {
569           // remove time data if it exists
570           a=fldvalue.split(/\s|T/);
571           fldvalue=a[0];
572           if (this.isTextInput(e)) {
573             var d=Rico.setISO8601(fldvalue);
574             if (d) fldvalue=Rico.formatDate(d,fldSpec.dateFmt);
575           }
576         }
577         e.value=fldvalue;
578         break;
579       case 'SELECT':
580         opts=e.options;
581         //alert('setField SELECT: id='+e.id+'\nvalue='+fldvalue+'\nopt cnt='+opts.length)
582         o={}
583         if (fldSpec.MultiSelect && fldvalue) {
584           a=fldvalue.split(',');
585           for (var i=0; i<a.length; i++) o[a[i]]=1;
586           for (i=0; i<opts.length; i++)
587             opts[i].selected=o[opts[i].value]==1;
588         } else {
589           for (i=0; i<opts.length; i++) {
590             if (opts[i].value==fldvalue) {
591               e.selectedIndex=i;
592               break;
593             }
594           }
595         }
596         if (fldSpec.EntryType=='N') {
597           txt=Rico.$('textnew__'+e.id);
598           if (!txt) alert('Warning: unable to find id "textnew__'+e.id+'"');
599           txt.value=fldvalue;
600           if (e.selectedIndex!=i) e.selectedIndex=opts.length-1;
601           this.updateSelectNew(e);
602         }
603         return;
604       case 'TEXTAREA':
605         e.value=fldvalue;
606         if (fldSpec.EntryType=='tinyMCE' && typeof(tinyMCE)!='undefined' && this.initialized) {
607           if (tinyMCE.updateContent) {
608             tinyMCE.updateContent(e.id);  // version 2.x
609           } else {
610             tinyMCE.execInstanceCommand(e.id, 'mceSetContent', false, fldvalue);  // version 3.x
611           }
612         }
613         return;
614     }
615   },
616
617   setReadOnly: function(action) {
618     for (var ro,i=0; i<this.grid.columns.length; i++) {
619       var fldSpec=this.grid.columns[i].format;
620       if (!fldSpec) continue;
621       var e=Rico.$(fldSpec.FieldName);
622       if (!e) continue;
623       switch (action) {
624         case 'ins': ro=!fldSpec.Writeable || fldSpec.ReadOnly || fldSpec.UpdateOnly; break;
625         case 'upd': ro=!fldSpec.Writeable || fldSpec.ReadOnly || fldSpec.InsertOnly; break;
626         default:    ro=false; break;
627       }
628       switch (e.tagName.toUpperCase()) {
629         case 'DIV':
630           var elems=e.getElementsByTagName('INPUT');
631           for (var j=0; j<elems.length; j++) {
632             elems[j].disabled=ro;
633           }
634           break;
635         case 'SELECT':
636           if (fldSpec.EntryType=='N') {
637             var txt=Rico.$('textnew__'+e.id);
638             txt.disabled=ro;
639           }
640           e.disabled=ro;
641           break;
642         case 'TEXTAREA':
643         case 'INPUT':
644           e.disabled=ro;
645           if (fldSpec.selectIcon) fldSpec.selectIcon.style.display=ro ? 'none' : '';
646           break;
647       }
648     }
649   },
650
651   hideResponse: function(msg) {
652     this.responseDiv.innerHTML=msg;
653     this.responseDialog.style.display='none';
654   },
655
656   showResponse: function() {
657     var offset=Rico.cumulativeOffset(this.grid.outerDiv);
658     offset.top+=Rico.docScrollTop();
659     this.responseDialog.style.top=offset.top+"px";
660     this.responseDialog.style.left=offset.left+"px";
661     this.responseDialog.style.display='';
662   },
663
664   processResponse: function(xhr) {
665     var responseText,success=true;
666     Rico.log('Processing response from form submittal: '+typeof(xhr));
667     this.responseDiv.innerHTML=xhr.responseText;
668     var respNodes=Rico.select('.ricoFormResponse',this.responseDiv);
669     if (respNodes) {
670       // generate a translated response
671       Rico.log('Found ricoFormResponse');
672       var phraseId=Rico.trim(respNodes[0].className).split(/\s+/)[1];
673       responseText=Rico.getPhraseById(phraseId,this.options.RecordName);
674     } else {
675       // present the response as sent from the server (untranslated)
676       Rico.log('Processing response text');
677       var ch=this.responseDiv.childNodes;
678       for (var i=ch.length-1; i>=0; i--) {
679         if (ch[i].nodeType==1 && ch[i].nodeName!='P' && ch[i].nodeName!='DIV' && ch[i].nodeName!='BR')
680           this.responseDiv.removeChild(ch[i]);
681       }
682       responseText=Rico.stripTags(this.responseDiv.innerHTML);
683       success=(responseText.toLowerCase().indexOf('error')==-1);
684     }
685     if (success && this.options.showSaveMsg!='full') {
686       this.hideResponse('');
687       this.grid.resetContents();
688       this.grid.buffer.foundRowCount = false;
689       this.grid.buffer.fetch(this.grid.lastRowPos || 0);
690       if (this.saveMsg) this.saveMsg.innerHTML='&nbsp;'+responseText+'&nbsp;';
691     }
692     this.processCallback(this.options.onSubmitResponse);
693     Rico.log('Processing response completed');
694   },
695
696   processCallback: function(callback) {
697     switch (typeof callback) {
698       case 'string': return eval(callback);
699       case 'function': return callback();
700     }
701   },
702
703   // called when ok pressed on error response message
704   ackResponse: function(e) {
705     this.hideResponse('');
706     this.grid.highlightEnabled=true;
707   },
708
709   cloneRecord: function() {
710     this.formPopup.setTitle(this.cloneText);
711     this.displayEditForm("ins");
712   },
713
714   editRecord: function() {
715     this.formPopup.setTitle(this.editText);
716     this.displayEditForm("upd");
717   },
718
719   displayEditForm: function(action) {
720     this.grid.highlightEnabled=false;
721     this.menu.cancelmenu();
722     this.hideResponse(Rico.getPhraseById('saving'));
723     this.grid.outerDiv.style.cursor = 'auto';
724     this.action.value=action;
725     for (var i=0; i<this.grid.columns.length; i++) {
726       var c=this.grid.columns[i];
727       if (c.format) {
728         var v=c.getValue(this.rowIdx);
729         this.setField(i,v);
730         if (c.format.selectDesc) {
731           if (c.format.EntryType.length>1 && c.format.EntryType.charAt(1)=='L')
732             v=this.grid.columns[i+1].getValue(this.rowIdx);
733           v=c._format(v);
734           if (v==='') v='&nbsp;';
735           c.format.selectDesc.innerHTML=v;
736         }
737         if (c.format.SelectCtl)
738           Rico.EditControls.displayClrImg(c, !c.format.InsertOnly);
739       }
740     }
741     this.setReadOnly(action);
742     for (var k=0; k<this.keys.length; k++) {
743       this.keys[k].keyField.value = this.grid.buffer.getWindowValue(this.rowIdx,this.keys[k].colidx);
744     }
745     this.makeFormVisible(this.rowIdx);
746   },
747   
748   addPrepare: function() {
749     this.hideResponse(Rico.getPhraseById('saving'));
750     this.form.reset();
751     this.setReadOnly("ins");
752     this.action.value="ins";
753     for (var i=0; i<this.grid.columns.length; i++) {
754       var c=this.grid.columns[i];
755       if (c.format) {
756         this.setField(i,c.format.ColData);
757         if (c.format.SelectCtl) {
758           Rico.EditControls.resetValue(c);
759           Rico.EditControls.displayClrImg(c, !c.format.UpdateOnly);
760         }
761       }
762     }
763   },
764
765   addRecord: function() {
766     this.menu.cancelmenu();
767     this.formPopup.setTitle(this.addText);
768     this.addPrepare();
769     this.makeFormVisible(-1);
770     if (this.formPanels) this.formPanels.select(0);
771   },
772
773   drillDown: function(e,masterColNum,detailColNum) {
774     return this.grid.drillDown.apply(this.grid, arguments);
775   },
776
777   // set filter on a detail grid that is in a master-detail relationship
778   setDetailFilter: function(colNumber,filterValue) {
779     this.grid.setDetailFilter(colNumber,filterValue);
780   },
781
782   makeFormVisible: function(row) {
783     this.formPopup.container.style.display='block';
784
785     // set left position
786     var editWi=this.formPopup.container.offsetWidth;
787     var odOffset=Rico.cumulativeOffset(this.grid.outerDiv);
788     var winWi=Rico.windowWidth();
789     this.formPopup.container.style.left=editWi+odOffset.left > winWi ? (winWi-editWi)+'px' : (odOffset.left+1)+'px';
790
791     // set top position
792     var scrTop=Rico.docScrollTop();
793     var editHt=this.formPopup.container.offsetHeight;
794     var newTop=odOffset.top+this.grid.hdrHt+scrTop;
795     var bottom=Rico.windowHeight()+scrTop;
796     if (row >= 0) {
797       newTop+=(row+1)*this.grid.rowHeight;
798       if (newTop+editHt>bottom) newTop-=(editHt+this.grid.rowHeight);
799     } else {
800       if (newTop+editHt>bottom) newTop=bottom-editHt-2;
801     }
802
803     if (this.processCallback(this.options.formOpen) === false) return;
804     this.formPopup.openPopup(null,Math.max(newTop,scrTop));
805     this.formPopup.container.style.visibility='visible';
806     Rico.EditControls.setZ(Rico.getStyle(this.formPopup.container,'zIndex'));
807     if (this.initialized) return;
808
809     var i, spec;
810     for (i = 0; i < this.grid.columns.length; i++) {
811       spec=this.grid.columns[i].format;
812       if (!spec || !spec.EntryType || !spec.FieldName) continue;
813       switch (spec.EntryType) {
814         case 'tinyMCE':
815           if (typeof tinyMCE!='undefined') tinyMCE.execCommand('mceAddControl', true, spec.FieldName);
816           break;
817       }
818     }
819     this.initialized=true;
820   },
821
822   makeFormInvisible: function() {
823     for (var i=0; i<this.grid.columns.length; i++) {
824       if (this.grid.columns[i].format && this.grid.columns[i].format.SelectCtl)
825         Rico.EditControls.close(this.grid.columns[i].format.SelectCtl);
826     }
827     this.formPopup.container.style.visibility='hidden';
828     this.formPopup.closePopup();
829     this.processCallback(this.options.formClose);
830   },
831
832   getConfirmDesc: function(rowIdx) {
833     return Rico.stripTags(this.grid.cell(rowIdx,this.options.ConfirmDeleteCol).innerHTML).replace('&nbsp;',' '); //.unescapeHTML();
834   },
835
836   deleteRecord: function() {
837     this.menu.cancelmenu();
838     var desc;
839     switch(this.options.ConfirmDeleteCol){
840       case -1 :
841         desc=Rico.getPhraseById("thisRecord",this.options.RecordName);
842         break;
843       case -2 : // Use key/column header to identify the row
844         for (var k=0; k<this.keys.length; k++) {
845           var i=this.keys[k].colidx;
846           var fmt=this.grid.columns[i].format;
847           if (fmt.EntryType.length>1 && fmt.EntryType.charAt(1)=='L') i++;
848           var value=Rico.stripTags(this.grid.cell(rowIdx,i).innerHTML).replace(/&nbsp;/g,' ');
849           if (desc) desc+=', ';
850           desc+=this.grid.columns[i].displayName+" "+value;
851         }
852         break;
853       default   :
854         desc='\"' + Rico.truncate(this.getConfirmDesc(this.rowIdx),50) + '\"';
855         break;
856     }
857     if (!this.options.ConfirmDelete.valueOf || confirm(Rico.getPhraseById("confirmDelete",desc))) {
858       this.hideResponse(Rico.getPhraseById('deleting'));
859       this.showResponse();
860       var parms={};
861       parms[this.grid.actionId]="del";
862       for (var k=0; k<this.keys.length; k++) {
863         var i=this.keys[k].colidx;
864         var value=this.grid.columns[i].getValue(this.rowIdx);
865         parms['_k'+i]=value;  // prototype does the encoding automatically
866         //parms['_k'+i]=encodeURIComponent(value);
867       }
868       new Rico.ajaxRequest(this.options.updateURL, {parameters:parms,method:'post',onComplete:this.responseHandler});
869     }
870     this.menu.cancelmenu();
871   },
872
873   validationMsg: function(elem,colnum,phraseId) {
874     var col=this.grid.columns[colnum];
875     if (this.formPanels) this.formPanels.select(this.panelActualIdx[col.format.ColGroupIdx]);
876     var label=Rico.stripTags(col.formLabel.innerHTML).replace(/&nbsp;/g,' ');
877     var msg=Rico.getPhraseById(phraseId," \"" + label + "\"");
878     Rico.log(' Validation error: '+msg);
879     if (col.format.Help) msg+="\n\n"+col.format.Help;
880     alert(msg);
881     setTimeout(function() { try { elem.focus(); elem.select(); } catch(e) {}; }, 10);
882     return false;
883   },
884   
885   isTextInput: function(elem) {
886     if (!elem) return false;
887     if (elem.tagName.toLowerCase()!='input') return false;
888     if (elem.type.toLowerCase()!='text') return false;
889     if (elem.readOnly) return false;
890     if (!Rico.visible(elem)) return false;
891     return true;
892   },
893   
894   parseDate: function(v, dateFmt) {
895     dateParts={};
896     if (!this.dateRegExp.exec(dateFmt)) return NaN;
897     dateParts[RegExp.$1]=0;
898     dateParts[RegExp.$3]=1;
899     dateParts[RegExp.$5]=2;
900     var aDate = v.split(/\D/);
901     var d=new Date();
902     var curyr=d.getFullYear();
903     if (aDate.length==2 && dateParts.yyyy==2) aDate.push(curyr);
904     if (aDate.length!=3) return NaN;
905     var dd=parseInt(aDate[dateParts.dd], 10);
906     if (dd==0 || dd>31) return NaN;
907     var mm=parseInt(aDate[dateParts.mm], 10) - 1;
908     if (mm > 11) return NaN;
909     var yy=parseInt(aDate[dateParts.yyyy], 10);
910     if (yy < 100) {
911       // apply a century to 2-digit years
912       yy+=curyr - (curyr % 100);
913     }
914     d.setFullYear(yy,mm,dd);
915     return d;
916   },
917
918   TESubmit: function(e) {
919     var i,ro,lbl,spec,elem,n,dateValues=[];
920
921     Rico.eventStop(e);
922     Rico.log('Event: TESubmit called to validate input');
923
924     // check fields that are supposed to be non-blank
925
926     for (i = 0; i < this.grid.columns.length; i++) {
927       spec=this.grid.columns[i].format;
928       if (!spec || !spec.EntryType || !spec.FieldName) continue;
929       elem=Rico.$(spec.FieldName);
930       if (!this.isTextInput(elem)) continue;
931       switch (this.action.value) {
932         case 'ins': ro=!spec.Writeable || spec.ReadOnly || spec.UpdateOnly; break;
933         case 'upd': ro=!spec.Writeable || spec.ReadOnly || spec.InsertOnly; break;
934         default:    ro=false; break;
935       }
936       if (ro) continue;  // readonly, so don't validate
937       Rico.log(' Validating field #'+i+' EntryType='+spec.EntryType+' ('+spec.FieldName+')');
938
939       // check for blanks
940       if (elem.value.length == 0) {
941         if (spec.required)
942           return this.validationMsg(elem,i,"formPleaseEnter");
943         else
944           continue;
945       }
946
947       // check pattern
948       if (elem.value.length > 0 && spec.regexp && !spec.regexp.test(elem.value))
949         return this.validationMsg(elem,i,"formInvalidFmt");
950
951       // check min/max and date values
952       switch (spec.EntryType.charAt(0)) {
953         case 'I': n=parseInt(elem.value,10); break;
954         case 'F': n=parseFloat(elem.value); break;
955         case 'D': 
956           n=this.parseDate(elem.value,spec.dateFmt);
957           if (isNaN(n)) return this.validationMsg(elem,i,"formInvalidFmt");
958           dateValues.push({e:elem,v:n});
959           break;
960         default:  n=NaN; break;
961       }
962       if (typeof spec.min!='undefined' && !isNaN(n) && n < spec.min)
963         return this.validationMsg(elem,i,"formOutOfRange");
964       if (typeof spec.max!='undefined' && !isNaN(n) && n > spec.max)
965         return this.validationMsg(elem,i,"formOutOfRange");
966     }
967     if (this.processCallback(this.options.formSubmit) === false) return false;
968
969     // update drop-down for any columns with entry type of N
970
971     for (i = 0; i < this.grid.columns.length; i++) {
972       spec=this.grid.columns[i].format;
973       if (!spec || !spec.EntryType || !spec.FieldName) continue;
974       if (spec.EntryType.charAt(0) != 'N') continue;
975       var SelObj=Rico.$(spec.FieldName);
976       if (!SelObj || SelObj.value!=this.options.TableSelectNew) continue;
977       var newtext=Rico.$("textnew__" + SelObj.id).value;
978       this.addSelectOption(SelObj,newtext,newtext);
979     }
980     
981     // set date values to ISO format
982     for (i = 0; i < dateValues.length; i++) {
983       dateValues[i].e.value = Rico.formatDate(dateValues[i].v,'yyyy-mm-dd');
984     }
985
986     if (typeof tinyMCE!='undefined') tinyMCE.triggerSave();
987     this.makeFormInvisible();
988     this.sendForm();
989     this.menu.cancelmenu();
990     return false;
991   },
992   
993   sendForm: function() {
994     this.setReadOnly("reset");  // reset disabled flag so that all fields are sent to server
995     this.showResponse();
996     Rico.log("sendForm: "+this.grid.tableId);
997     Rico.ajaxSubmit(this.form, this.options.updateURL, {method:'post',onComplete:this.responseHandler});
998   }
999 };
1000
1001
1002 /**
1003  * @namespace Registers custom popup widgets to fill in a text box (e.g. ricoCalendar and ricoTree)
1004  * <pre>
1005  * Custom widget must implement:
1006  *   open() method (make control visible)
1007  *   close() method (hide control)
1008  *   container property (div element that contains the control)
1009  *   id property (uniquely identifies the widget class)
1010  *
1011  * widget calls returnValue method to return a value to the caller
1012  *
1013  * this object handles clicks on the control's icon and positions the control appropriately.
1014  * </pre>
1015  */
1016 Rico.EditControls = {
1017   widgetList : {},
1018   elemList   : {},
1019   zIndex     : 0,
1020
1021   register: function(widget, imgsrc) {
1022     this.widgetList[widget.id] = {imgsrc:imgsrc, widget:widget, currentEl:''};
1023     var self=this;
1024     widget.returnValue=function(newVal,newDesc) { self.setValue(widget,newVal,newDesc); };
1025     Rico.log("Rico.EditControls.register:"+widget.id);
1026   },
1027   
1028   setZ: function(z) {
1029     this.zIndex=Math.max(this.zIndex,z+10);
1030   },
1031
1032   atLoad: function() {
1033     for (var id in this.widgetList) {
1034       var widget=this.widgetList[id].widget;
1035       if (widget.atLoad && !widget.atLoadComplete) {
1036         Rico.log("Rico.EditControls.atLoad: "+id);
1037         widget.atLoad();
1038         widget.atLoadComplete=true;
1039       }
1040     }
1041   },
1042
1043   applyTo: function(column,inputCtl) {
1044     var wInfo=this.widgetList[column.format.SelectCtl];
1045     if (!wInfo) return;
1046     Rico.log('Rico.EditControls.applyTo: '+column.displayName+' : '+column.format.SelectCtl);
1047     var newimg, descSpan = document.createElement('span');
1048     if (wInfo.imgsrc.indexOf('.')==-1 && wInfo.imgsrc.indexOf('/')==-1) {
1049       // treat imgsrc as a class name
1050       newimg = document.createElement('span');
1051       newimg.className=wInfo.imgsrc;
1052     } else {
1053       // treat imgsrc as an image uri
1054       newimg = document.createElement('img');
1055       newimg.src=wInfo.imgsrc;
1056     }
1057     newimg.style.verticalAlign='top';
1058     newimg.style.marginLeft='4px';
1059     newimg.style.cursor='pointer';
1060     newimg.id=this.imgId(column.format.FieldName);
1061     Rico.eventBind(newimg,"click", Rico.eventHandle(this,'processClick'));
1062     inputCtl.parentNode.appendChild(descSpan);
1063     inputCtl.parentNode.appendChild(newimg);
1064     inputCtl.style.display='none';    // comment out this line for debugging
1065     var clr;
1066     if (column.format.isNullable) {
1067       clr=Rico.clearButton(Rico.eventHandle(this,'processClear'));
1068       clr.id=newimg.id+'_clear';
1069       inputCtl.parentNode.appendChild(clr);
1070     }
1071     this.elemList[newimg.id] = {descSpan:descSpan, inputCtl:inputCtl, widget:wInfo.widget, listObj:wInfo, column:column, clrimg:clr};
1072     column.format.selectIcon=newimg;
1073     column.format.selectDesc=descSpan;
1074   },
1075
1076   displayClrImg: function(column,bShow) {
1077     var el=this.elemList[this.imgId(column.format.FieldName)];
1078     //alert(column.format.FieldName+': '+bShow+' '+el.clrimg.id);
1079     if (el && el.clrimg) el.clrimg.style.display=bShow ? 'inline-block' : 'none';
1080   },
1081
1082   processClear: function(e) {
1083     var elem=Rico.eventElement(e);
1084     var el=this.elemList[elem.id.slice(0,-6)];
1085     if (!el) return;
1086     el.inputCtl.value='';
1087     el.descSpan.innerHTML=el.column._format('');
1088   },
1089
1090   processClick: function(e) {
1091     var elem=Rico.eventElement(e);
1092     var el=this.elemList[elem.id];
1093     if (!el) return;
1094     if (el.listObj.currentEl==elem.id && el.widget.container.style.display!='none') {
1095       el.widget.close();
1096       el.listObj.currentEl='';
1097     } else {
1098       el.listObj.currentEl=elem.id;
1099       Rico.log('Rico.EditControls.processClick: '+el.widget.id+' : '+el.inputCtl.value);
1100       el.widget.container.style.zIndex=this.zIndex;
1101       el.widget.open(el.inputCtl.value,el.column);     // this may change the size of the widget
1102       Rico.positionCtlOverIcon(el.widget.container,elem);
1103     }
1104   },
1105
1106   imgId: function(fieldname) {
1107     return 'icon_'+fieldname;
1108   },
1109
1110   resetValue: function(column) {
1111     var el=this.elemList[this.imgId(column.format.FieldName)];
1112     if (!el) return;
1113     el.inputCtl.value=column.format.ColData;
1114     var v=column._format(column.format.ColData);
1115     if (v==='') v='&nbsp;';
1116     el.descSpan.innerHTML=v;
1117   },
1118
1119   setValue: function(widget,newVal,newDesc) {
1120     var wInfo=this.widgetList[widget.id];
1121     if (!wInfo) return null;
1122     var id=wInfo.currentEl;
1123     if (!id) return null;
1124     var el=this.elemList[id];
1125     if (!el) return null;
1126     el.inputCtl.value=newVal;
1127     if (!newDesc) newDesc=el.column._format(newVal);
1128     el.descSpan.innerHTML=newDesc;
1129     if (el.column.format.DescriptionField)
1130       Rico.$(el.column.format.DescriptionField).value = newDesc;
1131     //alert(widget.id+':'+id+':'+el.inputCtl.id+':'+el.inputCtl.value+':'+newDesc);
1132   },
1133
1134   close: function(id) {
1135     var wInfo=this.widgetList[id];
1136     if (!wInfo) return;
1137     if (wInfo.widget.container.style.display!='none')
1138       wInfo.widget.close();
1139   }
1140 };