source: trunk/grails-app/taglib/dbnp/studycapturing/WizardTagLib.groovy @ 571

Last change on this file since 571 was 571, checked in by duh, 10 years ago
  • fixed bug where sampling templates could not be editted
  • Property svn:keywords set to Date Author Rev
File size: 33.4 KB
Line 
1package dbnp.studycapturing
2
3import org.codehaus.groovy.grails.plugins.web.taglib.JavascriptTagLib
4import dbnp.studycapturing.*
5import dbnp.data.*
6import cr.co.arquetipos.crypto.Blowfish
7
8/**
9 * Wizard tag library
10 *
11 * @author Jeroen Wesbeek
12 * @since 20100113
13 * @package wizard
14 *
15 * Revision information:
16 * $Rev: 571 $
17 * $Author: duh $
18 * $Date: 2010-06-16 13:36:04 +0000 (wo, 16 jun 2010) $
19 */
20class WizardTagLib extends JavascriptTagLib {
21        // define the tag namespace (e.g.: <wizard:action ... />
22        static namespace = "wizard"
23
24        // define the AJAX provider to use
25        static ajaxProvider = "jquery"
26
27        // define default text field width
28        static defaultTextFieldSize = 25;
29
30        /**
31         * ajaxButton tag, this is a modified version of the default
32         * grails submitToRemote tag to work with grails webflows.
33         * Usage is identical to submitToRemote with the only exception
34         * that a 'name' form element attribute is required. E.g.
35         * <wizard:ajaxButton name="myAction" value="myButton ... />
36         *
37         * you can also provide a javascript function to execute after
38         * success. This behaviour differs from the default 'after'
39         * action which always fires after a button press...
40         *
41         * @see http://blog.osx.eu/2010/01/18/ajaxifying-a-grails-webflow/
42         * @see http://www.grails.org/WebFlow
43         * @see http://www.grails.org/Tag+-+submitToRemote
44         * @todo perhaps some methods should be moved to a more generic
45         *        'webflow' taglib or plugin
46         * @param Map attributes
47         * @param Closure body
48         */
49        def ajaxButton = { attrs, body ->
50                // get the jQuery version
51                def jQueryVersion = grailsApplication.getMetadata()['plugins.jquery']
52
53                // fetch the element name from the attributes
54                def elementName = attrs['name'].replaceAll(/ /, "_")
55
56                // javascript function to call after success
57                def afterSuccess = attrs['afterSuccess']
58
59                // src parameter?
60                def src = attrs['src']
61                def alt = attrs['alt']
62
63                // generate a normal submitToRemote button
64                def button = submitToRemote(attrs, body)
65
66                /**
67                 * as of now (grails 1.2.0 and jQuery 1.3.2.4) the grails webflow does
68                 * not properly work with AJAX as the submitToRemote button does not
69                 * handle and submit the form properly. In order to support webflows
70                 * this method modifies two parts of a 'normal' submitToRemote button:
71                 *
72                 * 1) replace 'this' with 'this.form' as the 'this' selector in a button
73                 *    action refers to the button and / or the action upon that button.
74                 *    However, it should point to the form the button is part of as the
75                 *    the button should submit the form data.
76                 * 2) prepend the button name to the serialized data. The default behaviour
77                 *    of submitToRemote is to remove the element name altogether, while
78                 *    the grails webflow expects a parameter _eventId_BUTTONNAME to execute
79                 *    the appropriate webflow action. Hence, we are going to prepend the
80                 *    serialized formdata with an _eventId_BUTTONNAME parameter.
81                 */
82                if (jQueryVersion =~ /^1.([1|2|3]).(.*)/) {
83                        // fix for older jQuery plugin versions
84                        button = button.replaceFirst(/data\:jQuery\(this\)\.serialize\(\)/, "data:\'_eventId_${elementName}=1&\'+jQuery(this.form).serialize()")
85                } else {
86                        // as of jQuery plugin version 1.4.0.1 submitToRemote has been modified and the
87                        // this.form part has been fixed. Consequently, our wrapper has changed as well...
88                        button = button.replaceFirst(/data\:jQuery/, "data:\'_eventId_${elementName}=1&\'+jQuery")
89                }
90
91                // add an after success function call?
92                // usefull for performing actions on success data (hence on refreshed
93                // wizard pages, such as attaching tooltips)
94                if (afterSuccess) {
95                        button = button.replaceFirst(/\.html\(data\)\;/, '.html(data);' + afterSuccess + ';')
96                }
97
98                // got an src parameter?
99                if (src) {
100                        def replace = 'type="image" src="' + src + '"'
101
102                        if (alt) replace = replace + ' alt="' + alt + '"'
103
104                        button = button.replaceFirst(/type="button"/, replace)
105                }
106
107                // replace double semi colons
108                button = button.replaceAll(/;{2,}/, ';')
109
110                // render button
111                out << button
112        }
113
114        /**
115         * generate a ajax submit JavaScript
116         * @see WizardTagLib::ajaxFlowRedirect
117         * @see WizardTagLib::baseElement (ajaxSubmitOnChange)
118         */
119        def ajaxSubmitJs = { attrs, body ->
120                // define AJAX provider
121                setProvider([library: ajaxProvider])
122
123                // got a function name?
124                def functionName = attrs.remove('functionName')
125                if (functionName && !attrs.get('name')) {
126                        attrs.name = functionName
127                }
128
129                // generate an ajax button
130                def button = this.ajaxButton(attrs, body)
131
132                // strip the button part to only leave the Ajax call
133                button = button.replaceFirst(/<[^\"]*onclick=\"/, '')
134                button = button.replaceFirst(/return false.*/, '')
135
136                // change form if a form attribute is present
137                if (attrs.get('form')) {
138            button = button.replace(
139                                "jQuery(this).parents('form:first')",
140                                "\$('" + attrs.get('form') + "')"
141                        )
142                }
143
144                out << button
145        }
146
147        /**
148         * generate ajax webflow redirect javascript
149         *
150         * As we have an Ajaxified webflow, the initial wizard page
151         * cannot contain a wizard form, as upon a failing submit
152         * (e.g. the form data does not validate) the form should be
153         * shown again. However, the Grails webflow then renders the
154         * complete initial wizard page into the success div. As this
155         * ruins the page layout (a page within a page) we want the
156         * initial page to redirect to the first wizard form to enter
157         * the webflow correctly. We do this by emulating an ajax post
158         * call which updates the wizard content with the first wizard
159         * form.
160         *
161         * Usage: <wizard:ajaxFlowRedirect form="form#wizardForm" name="next" url="[controller:'wizard',action:'pages']" update="[success:'wizardPage',failure:'wizardError']" />
162         * form = the form identifier
163         * name = the action to execute in the webflow
164         * update = the divs to update upon success or error
165         *
166         * OR: to generate a JavaScript function you can call yourself, use 'functionName' instead of 'name'
167         *
168         * Example initial webflow action to work with this javascript:
169         * ...
170         * mainPage {
171         *      render(view: "/wizard/index")
172         *      onRender {
173         *              flow.page = 1
174         *  }
175         *      on("next").to "pageOne"
176         * }
177         * ...
178         *
179         * @param Map attributes
180         * @param Closure body
181         */
182        def ajaxFlowRedirect = { attrs, body ->
183                // generate javascript
184                out << '<script type="text/javascript">'
185                out << '$(document).ready(function() {'
186                out << ajaxSubmitJs(attrs, body)
187                out << '});'
188                out << '</script>'
189        }
190
191        /**
192         * render the content of a particular wizard page
193         * @param Map attrs
194         * @param Closure body  (help text)
195         */
196        def pageContent = { attrs, body ->
197                // define AJAX provider
198                setProvider([library: ajaxProvider])
199
200                // render new body content
201                //      - this JavaScript variable is used by baseElement to workaround an IE
202                //        specific issue (double submit on onchange events). The hell with IE!
203                //        @see baseElement
204                out << '<script type="text/javascript">var lastRequestTime = 0;</script>'
205                out << render(template: "/wizard/common/tabs")
206                out << '<div class="content">'
207                out << body()
208                out << '</div>'
209                out << render(template: "/wizard/common/navigation")
210                out << render(template: "/wizard/common/error")
211        }
212
213        /**
214         * generate a base form element
215         * @param String inputElement name
216         * @param Map attributes
217         * @param Closure help content
218         */
219        def baseElement = { inputElement, attrs, help ->
220println ".rendering [" + inputElement + "] with name [" + attrs.get('name') + "] and value [" + ((attrs.value) ? attrs.get('value').toString() : "-") + "]"
221                // work variables
222                def internetExplorer = (request.getHeader("User-Agent") =~ /MSIE/)
223                def description = attrs.remove('description')
224                def addExampleElement = attrs.remove('addExampleElement')
225                def addExample2Element = attrs.remove('addExample2Element')
226                def helpText = help().trim()
227
228                // got an ajax onchange action?
229                def ajaxOnChange = attrs.remove('ajaxOnChange')
230                if (ajaxOnChange) {
231                        if (!attrs.onChange) attrs.onChange = ''
232
233                        // add onChange AjaxSubmit javascript
234                        if (internetExplorer) {
235                                //              - somehow IE submits these onchanges twice which messes up some parts of the wizard
236                                //                (especially the events page). In order to bypass this issue I have introduced an
237                                //                if statement utilizing the 'before' and 'after' functionality of the submitToRemote
238                                //                function. This check expects lastRequestTime to be in the global Javascript scope,
239                                //                (@see pageContent) and calculates the time difference in miliseconds between two
240                                //                onChange executions. If this is more than 100 miliseconds the request is executed,
241                                //                otherwise it will be ignored... --> 20100527 - Jeroen Wesbeek
242                                attrs.onChange += ajaxSubmitJs(
243                                        [
244                                                before: "var execute=true;try { var currentTime=new Date().getTime();execute = ((currentTime-lastRequestTime) > 100);lastRequestTime=currentTime;  } catch (e) {};if (execute) { 1",
245                                                after: "}",
246                                                functionName: ajaxOnChange,
247                                                url: attrs.get('url'),
248                                                update: attrs.get('update'),
249                                                afterSuccess: attrs.get('afterSuccess')
250                                        ],
251                                        ''
252                                )
253                        } else {
254                                // this another W3C browser that actually behaves as expected... damn you IE, DAMN YOU!
255                                attrs.onChange += ajaxSubmitJs(
256                                        [
257                                                functionName: ajaxOnChange,
258                                                url: attrs.get('url'),
259                                                update: attrs.get('update'),
260                                                afterSuccess: attrs.get('afterSuccess')
261                                        ],
262                                        ''
263                                )
264                        }
265                }
266
267                // execute inputElement call
268                def renderedElement = "$inputElement"(attrs)
269
270                // if false, then we skip this element
271                if (!renderedElement) return false
272
273                // render a form element
274                if (attrs.get('elementId')) {
275                out << '<div class="element" id="'+ attrs.remove('elementId') +'">'
276                } else {
277                        out << '<div class="element">'
278                }
279                out << ' <div class="description">'
280                out << description
281                out << ' </div>'
282                out << ' <div class="input">'
283                out << renderedElement
284                if (helpText.size() > 0) {
285                        out << '        <div class="helpIcon"></div>'
286                }
287
288                // add an disabled input box for feedback purposes
289                // @see dateElement(...)
290                if (addExampleElement) {
291                        def exampleAttrs = new LinkedHashMap()
292                        exampleAttrs.name = attrs.get('name') + 'Example'
293                        exampleAttrs.class = 'isExample'
294                        exampleAttrs.disabled = 'disabled'
295                        exampleAttrs.size = 30
296                        out << textField(exampleAttrs)
297                }
298
299                // add an disabled input box for feedback purposes
300                // @see dateElement(...)
301                if (addExample2Element) {
302                        def exampleAttrs = new LinkedHashMap()
303                        exampleAttrs.name = attrs.get('name') + 'Example2'
304                        exampleAttrs.class = 'isExample'
305                        exampleAttrs.disabled = 'disabled'
306                        exampleAttrs.size = 30
307                        out << textField(exampleAttrs)
308                }
309
310                out << ' </div>'
311
312                // add help content if it is available
313                if (helpText.size() > 0) {
314                        out << '  <div class="helpContent">'
315                        out << '    ' + helpText
316                        out << '  </div>'
317                }
318
319                out << '</div>'
320        }
321
322        /**
323         * render an ajaxButtonElement
324         * @param Map attrs
325         * @param Closure body  (help text)
326         */
327        def ajaxButtonElement = { attrs, body ->
328                baseElement.call(
329                        'ajaxButton',
330                        attrs,
331                        body
332                )
333        }
334
335        /**
336         * render a textFieldElement
337         * @param Map attrs
338         * @param Closure body  (help text)
339         */
340        def textFieldElement = { attrs, body ->
341                // set default size, or scale to max length if it is less than the default size
342                if (!attrs.get("size")) {
343                        if (attrs.get("maxlength")) {
344                                attrs.size = ((attrs.get("maxlength") as int) > defaultTextFieldSize) ? defaultTextFieldSize : attrs.get("maxlength")
345                        } else {
346                                attrs.size = defaultTextFieldSize
347                        }
348                }
349
350                // render template element
351                baseElement.call(
352                        'textField',
353                        attrs,
354                        body
355                )
356        }
357
358        /**
359         * render a textAreaElement
360         * @param Map attrs
361         * @param Closure body  (help text)
362         */
363        def textAreaElement = { attrs, body ->
364                // set default size, or scale to max length if it is less than the default size
365
366                // render template element
367                baseElement.call(
368                        'textArea',
369                        attrs,
370                        body
371                )
372        }
373
374
375        /**
376         * render a select form element
377         * @param Map attrs
378         * @param Closure body  (help text)
379         */
380        def selectElement = { attrs, body ->
381                baseElement.call(
382                        'select',
383                        attrs,
384                        body
385                )
386        }
387
388        /**
389         * render a checkBox form element
390         * @param Map attrs
391         * @param Closure body  (help text)
392         */
393        def checkBoxElement = { attrs, body ->
394                baseElement.call(
395                        'checkBox',
396                        attrs,
397                        body
398                )
399        }
400
401        /**
402         * render a set of radio form elements
403         * @param Map attrs
404         * @param Closure body  (help text)
405         */
406        def radioElement = { attrs, body ->
407                baseElement.call(
408                        'radioList',
409                        attrs,
410                        body
411                )
412        }
413
414        /**
415         * render a set of radio elements
416         * @param Map attrs
417         * @param Closure body  (help text)
418         */
419        def radioList = { attrs ->
420                def checked = true
421
422                attrs.elements.each {
423                        out << radio(
424                                name: attrs.name,
425                                value: it,
426                                checked: (attrs.value == it || (!attrs.value && checked))
427                        )
428                        out << it
429                        checked = false
430                }
431        }
432
433        /**
434         * render a dateElement
435         * NOTE: datepicker is attached through wizard.js!
436         * @param Map attrs
437         * @param Closure body  (help text)
438         */
439        def dateElement = { attrs, body ->
440                // transform value?
441                if (attrs.value instanceof Date) {
442                        // transform date instance to formatted string (dd/mm/yyyy)
443                        attrs.value = String.format('%td/%<tm/%<tY', attrs.value)
444                }
445
446                // add 'rel' field to identity the datefield using javascript
447                attrs.rel = 'date'
448
449                // set some textfield values
450                attrs.maxlength = (attrs.maxlength) ? attrs.maxlength : 10
451                attrs.addExampleElement = true
452
453                // render a normal text field
454                //out << textFieldElement(attrs,body)
455                textFieldElement.call(
456                        attrs,
457                        body
458                )
459        }
460
461        /**
462         * render a dateElement
463         * NOTE: datepicker is attached through wizard.js!
464         * @param Map attrs
465         * @param Closure body  (help text)
466         */
467        def timeElement = { attrs, body ->
468                // transform value?
469                if (attrs.value instanceof Date) {
470                        // transform date instance to formatted string (dd/mm/yyyy)
471                        attrs.value = String.format('%td/%<tm/%<tY %<tH:%<tM', attrs.value)
472                }
473
474                // add 'rel' field to identity the field using javascript
475                attrs.rel = 'datetime'
476
477                attrs.addExampleElement = true
478                attrs.addExample2Element = true
479                attrs.maxlength = 16
480
481                // render a normal text field
482                //out << textFieldElement(attrs,body)
483                textFieldElement.call(
484                        attrs,
485                        body
486                )
487        }
488
489        /**
490         * Button form element
491         * @param Map attributes
492         * @param Closure help content
493         */
494        def buttonElement = { attrs, body ->
495                // render template element
496                baseElement.call(
497                        'ajaxButton',
498                        attrs,
499                        body
500                )
501        }
502
503
504        /**
505         * Term form element
506         * @param Map attributes
507         * @param Closure help content
508         */
509        def termElement = { attrs, body ->
510                // render term element
511                baseElement.call(
512                        'termSelect',
513                        attrs,
514                        body
515                )
516        }
517
518        /**
519         * Term select element
520         * @param Map attributes
521         */
522        def termSelect = { attrs ->
523                def from = []
524
525                // got ontologies?
526                if (attrs.ontologies) {
527                        // are the ontologies a string?
528                        if (attrs.ontologies instanceof String) {
529                                attrs.ontologies.split(/\,/).each() { ncboId ->
530                                        // trim the id
531                                        ncboId.trim()
532
533                                        // fetch all terms for this ontology
534                                        def ontology = Ontology.findAllByNcboId(ncboId)
535
536                                        // does this ontology exist?
537                                        if (ontology) {
538                                                ontology.each() {
539                                                        Term.findAllByOntology(it).each() {
540                                                                // key = ncboId:concept-id
541                                                                from[ from.size() ] = it.name
542                                                        }
543                                                }
544                                        }
545                                }
546                        } else if (attrs.ontologies instanceof Set) {
547                                // are they a set instead?
548                                def ontologyList = ""
549
550                                // iterate through set
551                                attrs.ontologies.each() { ontology ->
552                                        if (ontology) {
553                                                ontologyList += ontology.ncboId + ","
554
555                                                Term.findAllByOntology(ontology).each() {
556                                                        from[ from.size() ] = it.name
557                                                }
558
559                                                // strip trailing comma
560                                                attrs.ontologies = ontologyList[0..-2]
561                                        }
562                                }
563                        }
564
565                        // sort alphabetically
566                        from.sort()
567
568                        // add a dummy field?
569                        if (attrs.remove('addDummy')) {
570                                from.add(0,'')
571                        }
572
573                        // define 'from'
574                        attrs.from = from
575
576                        // add 'rel' attribute
577                        attrs.rel = 'term'
578
579                        out << select(attrs)
580                } else {
581                        out << "<b>ontologies missing!</b>"
582                }
583        }
584
585        /**
586         * Ontology form element
587         * @param Map attributes
588         * @param Closure help content
589         */
590        def ontologyElement = { attrs, body ->
591                // @see http://www.bioontology.org/wiki/index.php/NCBO_Widgets#Term-selection_field_on_a_form
592                // @see ontology-chooser.js, table-editor.js
593                baseElement.call(
594                        'textField',
595                        [
596                            name: attrs.name,
597                                value: attrs.value,
598                                description: attrs.description,
599                                rel: 'ontology-' + ((attrs.ontology) ? attrs.ontology : 'all'),
600                                size: 25
601                        ],
602                        body
603                )
604                out << hiddenField(
605                        name: attrs.name + '-concept_id'
606                )
607                out << hiddenField(
608                        name: attrs.name + '-ontology_id'
609                )
610                out << hiddenField(
611                        name: attrs.name + '-full_id'
612                )
613        }
614
615        /**
616         * Study form element
617         * @param Map attributes
618         * @param Closure help content
619         */
620        def studyElement = { attrs, body ->
621                // render study element
622                baseElement.call(
623                        'studySelect',
624                        attrs,
625                        body
626                )
627        }
628
629        /**
630         * render a study select element
631         * @param Map attrs
632         */
633        def studySelect = { attrs ->
634                // for now, just fetch all studies
635                attrs.from = Study.findAll()
636
637                // got a name?
638                if (!attrs.name) {
639                        attrs.name = "study"
640                }
641
642                // got result?
643                if (attrs.from.size() > 0) {
644                        out << select(attrs)
645                } else {
646                        // no, return false to make sure this element
647                        // is not rendered in the template
648                        return false
649                }
650        }
651
652        /**
653         * Template form element
654         * @param Map attributes
655         * @param Closure help content
656         */
657        def templateElement = { attrs, body ->
658                // add a rel element if it does not exist
659                if (!attrs.rel) {
660                        attrs.rel = 'template'
661                }
662               
663                // render template element
664                baseElement.call(
665                        'templateSelect',
666                        attrs,
667                        body
668                )
669        }
670
671        /**
672         * render a template select element
673         * @param Map attrs
674         */
675        def templateSelect = { attrs ->
676                def entity = attrs.remove('entity')
677
678                // add the entity class name to the element
679                // do we have crypto information available?
680                if (grailsApplication.config.crypto) {
681                        // generate a Blowfish encrypted and Base64 encoded string.
682                        attrs['entity'] = URLEncoder.encode(
683                                Blowfish.encryptBase64(
684                                        entity.toString().replaceAll(/^class /, ''),
685                                        grailsApplication.config.crypto.shared.secret
686                                )
687                        )
688                } else {
689                        // base64 only; this is INSECURE! As this class
690                        // is instantiated elsewehere. Possibly exploitable!
691                        attrs['entity'] = URLEncoder.encode(entity.toString().replaceAll(/^class /, '').bytes.encodeBase64())
692                }
693               
694                // fetch templates
695                attrs.from = (entity) ? Template.findAllByEntity(entity) : Template.findAll()
696
697                // got a name?
698                if (!attrs.name) {
699                        attrs.name = 'template'
700                }
701
702                // got result?
703                if (attrs.from.size() > 0 || attrs.get('addDummy')) {
704                        // transform all values into strings
705                        def from = []
706                        attrs.from.each { from[ from.size() ] = it.toString() }
707
708                        // sort alphabetically
709                        from.sort()
710
711                        // add a dummy field?
712                        if (attrs.remove('addDummy')) {
713                                from.add(0,'')
714                        }
715
716                        // set attributes
717                        attrs.from = from
718                        attrs.value = (attrs.value) ? attrs.value.toString() : ''
719
720                        // output select element
721                        out << select(attrs)
722                } else {
723                        // no, return false to make sure this element
724                        // is not rendered in the template
725                        return false
726                }
727        }
728
729
730        /**
731         * File form element
732         * @param Map attributes
733         * @param Closure help content
734         */
735        def fileFieldElement = { attrs, body ->
736                // render term element
737                baseElement.call(
738                        'fileField',
739                        attrs,
740                        body
741                )
742        }
743
744        /**
745         * file field.
746         * @param attributes
747         */
748        def fileField = { attrs ->
749                /*
750                out << '<input type="file" name="' + attrs.name + '"/>'
751                if( attrs.value ) {
752                        out << '<a href="' + resource(dir: '') + '/file/get/' + attrs.value + '" class="isExample">Now contains: ' + attrs.value + '</a>'
753                }
754                */
755
756                out << '<div id="upload_button_' + attrs.name + '" class="upload_button">Upload</div>';
757                out << '<input type="hidden" name="' + attrs.name + '" id="' + attrs.name + '" value="' + attrs.value + '">';
758                out << '<div id="' + attrs.name + 'Example" class="upload_info"></div>';
759                out << '<script type="text/javascript">';
760                out << '  $(document).ready( function() { ';
761                out << '    var filename = "' + attrs.value + '";';
762                out << '    fileUploadField( "' + attrs.name + '" );';
763                out << '    if( filename != "" ) {';
764                out << '      $("#' + attrs.name + 'Example").html("Current file: " + createFileHTML( filename ) )';
765                out << '    }';
766                out << '  } );';
767                out << "</script>\n";
768        }
769
770        /**
771         * Protocol form element
772         * @param Map attributes
773         * @param Closure help content
774         */
775        def protocolElement = { attrs, body ->
776                // render protocol element
777                baseElement.call(
778                        'protocolSelect',
779                        attrs,
780                        body
781                )
782        }
783
784        /**
785         * render a protocol select element
786         * @param Map attrs
787         */
788        def protocolSelect = { attrs ->
789                // fetch all protocold
790                attrs.from = Protocol.findAll() // for now, all protocols
791
792                // got a name?
793                if (!attrs.name) {
794                        attrs.name = 'protocol'
795                }
796
797                out << select(attrs)
798        }
799
800        def show = { attrs ->
801                // is object parameter set?
802                def o = attrs.object
803
804                println o.getProperties();
805                o.getProperties().each {
806                        println it
807                }
808
809                out << "!! test version of 'show' tag !!"
810        }
811
812        /**
813         * render table headers for all subjectFields in a template
814         * @param Map attributes
815         */
816        def templateColumnHeaders = { attrs ->
817                def entity              = (attrs.get('entity'))
818                def template    = (entity && entity instanceof TemplateEntity) ? entity.template : null
819
820                // got a template?
821                if (template) {
822                        // render template fields
823                        entity.giveFields().each() {
824                                def ucName              = it.name[0].toUpperCase() + it.name.substring(1)
825
826                                out << '<div class="' + attrs.get('class') + '">' + ucName + (it.unit ? " (${it.unit})" : '')
827                                if (it.comment) {
828                                        out << '<div class="helpIcon"></div>'
829                                        out << '<div class="helpContent">' + it.comment + '</div>'
830                                }
831                                out << '</div>'
832                        }
833                }
834        }
835
836        def templateColumns = { attrs ->
837                // render template fields as columns
838                attrs.renderType = 'column'
839                out << renderTemplateFields(attrs)
840        }
841
842        def templateElements = { attrs ->
843                // render template fields as form elements
844                attrs.renderType = 'element'
845                out << renderTemplateFields(attrs)
846        }
847
848        /**
849         * render form elements based on an entity's template
850         * @param Map attributes
851         * @param String body
852         */
853        def renderTemplateFields = { attrs ->
854                def renderType  = attrs.remove('renderType')
855                def entity              = (attrs.get('entity'))
856                def prependName = (attrs.get('name')) ? attrs.remove('name')+'_' : ''
857                def template    = (entity && entity instanceof TemplateEntity) ? entity.template : null
858                def inputElement= null
859                def addDummy    = (attrs.get('addDummy')) ? true : false
860
861                // got a template?
862                if (template) {
863                        // render template fields
864                        entity.giveFields().each() {
865                                def fieldValue  = entity.getFieldValue(it.name)
866                                def helpText    = (it.comment && renderType == 'element') ? it.comment : ''
867                                def ucName              = it.name[0].toUpperCase() + it.name.substring(1)
868
869                                // output column opening element?
870                                if (renderType == 'column') {
871                                        out << '<div class="' + attrs.get('class') + '">'
872                                }
873
874                                switch (it.type.toString()) {
875                                        case ['STRING', 'INTEGER', 'FLOAT', 'DOUBLE']:
876                                                inputElement = (renderType == 'element') ? 'textFieldElement' : 'textField'
877                                                out << "$inputElement"(
878                                                        description: ucName,
879                                                        name: prependName + it.escapedName(),
880                                                        value: fieldValue
881                                                ){helpText}
882                                                break
883                                        case 'TEXT':
884                                                inputElement = (renderType == 'element') ? 'textAreaElement' : 'textField'
885                                                out << "$inputElement"(
886                                                        description: ucName,
887                                                        name: prependName + it.escapedName(),
888                                                        value: fieldValue
889                                                ){helpText}
890                                                break
891                                        case 'STRINGLIST':
892                                                inputElement = (renderType == 'element') ? 'selectElement' : 'select'
893                                                if (!it.listEntries.isEmpty()) {
894                                                        out << "$inputElement"(
895                                                                description: ucName,
896                                                                name: prependName + it.escapedName(),
897                                                                from: it.listEntries,
898                                                                value: fieldValue
899                                                        ){helpText}
900                                                } else {
901                                                        out << '<span class="warning">no values!!</span>'
902                                                }
903                                                break
904                                        case 'ONTOLOGYTERM':
905                                                // @see http://www.bioontology.org/wiki/index.php/NCBO_Widgets#Term-selection_field_on_a_form
906                                                // @see ontology-chooser.js
907                                                inputElement = (renderType == 'element') ? 'termElement' : 'termSelect'
908
909                                                if (it.ontologies) {
910                                                        out << "$inputElement"(
911                                                                description     : ucName,
912                                                                name            : prependName + it.escapedName(),
913                                                                value           : fieldValue.toString(),
914                                                                ontologies      : it.ontologies,
915                                                                addDummy        : addDummy
916                                                        ){helpText}
917                                                } else {
918                                                        out << "$inputElement"(
919                                                                description     : ucName,
920                                                                name            : prependName + it.escapedName(),
921                                                                value           : fieldValue.toString(),
922                                                                addDummy        : addDummy
923                                                        ){helpText}
924                                                }
925                                                break
926                                        case 'ONTOLOGYTERM-old':
927                                                // @see http://www.bioontology.org/wiki/index.php/NCBO_Widgets#Term-selection_field_on_a_form
928                                                // @see ontology-chooser.js
929                                                inputElement = (renderType == 'element') ? 'textFieldElement' : 'textField'
930                                                out << "$inputElement"(
931                                                        name: prependName + it.escapedName(),
932                                                        value: fieldValue,
933                                                        rel: 'ontology-all',
934                                                        size: 100
935                                                )
936                                                out << hiddenField(
937                                                        name: prependName + it.name + '-concept_id',
938                                                        value: fieldValue
939                                                )
940                                                out << hiddenField(
941                                                        name: prependName + it.escapedName() + '-ontology_id',
942                                                        value: fieldValue
943                                                )
944                                                out << hiddenField(
945                                                        name: prependName + it.escapedName() + '-full_id',
946                                                        value: fieldValue
947                                                )
948                                                break
949                                        case 'DATE':
950                                                inputElement = (renderType == 'element') ? 'dateElement' : 'textField'
951
952                                                // transform value?
953                                                if (fieldValue instanceof Date) {
954                                                        if (fieldValue.getHours() == 0 && fieldValue.getMinutes() == 0) {
955                                                                // transform date instance to formatted string (dd/mm/yyyy)
956                                                                fieldValue = String.format('%td/%<tm/%<tY', fieldValue)
957                                                        } else {
958                                                                // transform to date + time
959                                                                fieldValue = String.format('%td/%<tm/%<tY %<tH:%<tM', fieldValue)
960                                                        }
961                                                }
962
963                                                // render element
964                                                out << "$inputElement"(
965                                                        description: ucName,
966                                                        name: prependName + it.escapedName(),
967                                                        value: fieldValue,
968                                                        rel: 'date'
969                                                ){helpText}
970                                                break
971                                        case ['RELTIME']:
972                                                inputElement = (renderType == 'element') ? 'textFieldElement' : 'textField'
973                                                out << "$inputElement"(
974                                                        description: ucName,
975                                                        name: prependName + it.escapedName(),
976                                                        value: new RelTime( fieldValue ).toString(),
977                            addExampleElement: true,
978                            onBlur: 'showExampleReltime(this)'
979                                                ){helpText}
980                                                break
981                                        case ['FILE']:
982                                                inputElement = (renderType == 'element') ? 'fileFieldElement' : 'fileField'
983                                                out << "$inputElement"(
984                                                        description: ucName,
985                                                        name: prependName + it.escapedName(),
986                                                        value: fieldValue ? fieldValue : "",
987                            addExampleElement: true
988                                                ){helpText}
989                                                break
990                                        case ['BOOLEAN']:
991                                                inputElement = (renderType == 'element') ? 'checkBoxElement' : 'checkBox'
992                                                out << "$inputElement"(
993                                                        description: ucName,
994                                                        name: prependName + it.escapedName(),
995                                                        value: fieldValue
996                                                ){helpText}
997                                                break
998                                        default:
999                                                // unsupported field type
1000                                                out << '<span class="warning">!' + it.type + '</span>'
1001                                                break
1002                                }
1003
1004                                // output column closing element?
1005                                if (renderType == 'column') {
1006                                        out << '</div>'
1007                                }
1008                        }
1009                }
1010        }
1011
1012        def PublicationSelectElement = { attrs, body ->
1013                attrs.description = 'Publications';
1014                // render list with publications currently available
1015                baseElement.call(
1016                        '_publicationList',
1017                        attrs,
1018                        body
1019                )
1020
1021                attrs.description = '';
1022
1023                // render 'Add publication button'
1024                baseElement.call(
1025                        '_publicationAddButton',
1026                        attrs,
1027                        body
1028                )
1029        }
1030
1031        /**
1032         * Renders a input box for publications
1033         */
1034        def publicationSelect = { attrs, body ->
1035                if (attrs.get('value') == null) {
1036                        attrs.value = [];
1037                }
1038                if (attrs.get('description') == null) {
1039                        attrs.description = '';
1040                }
1041                out << '<form id="' + attrs.name + '_form" onSubmit="return false;">';
1042                out << textField(
1043                        name: attrs.get("name"),
1044                        value: '',
1045                        rel: 'publication-pubmed',
1046                        style: 'width: 400px;'
1047                );
1048                out << '</form>';
1049                out << '<script type="text/javascript">';
1050                out << '  var onSelect = function( chooserObject, inputElement, event, ui ) { selectPubMedAdd( chooserObject, inputElement, event, ui ); enableButton( ".' + attrs.name + '_publication_dialog", "Add", true ); };'
1051                out << '  iField = $( "#' + attrs.get('name') + '" );';
1052                out << '  new PublicationChooser().initAutocomplete( iField, { "select" : onSelect } );';
1053                out << '</script>';
1054        }
1055
1056        def _publicationList = { attrs, body ->
1057                def display_none = 'none';
1058                if (!attrs.get('value') || attrs.get('value').size() == 0) {
1059                        display_none = 'inline';
1060                }
1061
1062                // Add a unordered list
1063                out << '<ul class="publication_list" id="' + attrs.name + '_list">';
1064
1065                out << '<li>';
1066                out << '<span class="publication_none" id="' + attrs.name + '_none" style="display: ' + display_none + ';">';
1067                out << 'No publications selected';
1068                out << '</span>';
1069                out << '</li>';
1070
1071                out << '</ul>';
1072
1073                // Add the publications using javascript
1074                out << '<script type="text/javascript">'
1075                if (attrs.get('value') && attrs.get('value').size() > 0) {
1076                        def i = 0;
1077                        attrs.get('value').each {
1078                                out << 'showPublication( ';
1079                                out << '  "' + attrs.name + '",';
1080                                out << '  ' + it.id + ',';
1081                                out << '  "' + it.title + '",';
1082                                out << '  "' + it.authorsList + '",';
1083                                out << '  ' + i++;
1084                                out << ');';
1085                        }
1086                }
1087                out << '</script>';
1088
1089                def ids;
1090                if (attrs.get('value') && attrs.get('value').size() > 0) {
1091                        ids = attrs.get('value').id.join(',')
1092                } else {
1093                        ids = '';
1094                }
1095                out << '<input type="hidden" name="' + attrs.name + '_ids" value="' + ids + '" id="' + attrs.name + '_ids">';
1096        }
1097
1098        def _publicationAddButton = { attrs, body ->
1099
1100                // Output the dialog for the publications
1101                out << '<div id="' + attrs.name + '_dialog">';
1102                out << '<p>Search for a publication on pubmed. You can search on a part of the title or authors. </p>';
1103                out << publicationSelect(attrs, body);
1104                out << '</div>';
1105                out << '<script type="text/javascript">';
1106                out << '  createPublicationDialog( "' + attrs.name + '" );'
1107                out << '</script>';
1108
1109                out << '<input type="button" onClick="openPublicationDialog(\'' + attrs.name + '\' );" value="Add Publication">';
1110        }
1111
1112        def ContactSelectElement = { attrs, body ->
1113
1114                attrs.description = 'Contacts';
1115                // render list with publications currently available
1116                baseElement.call(
1117                        '_contactList',
1118                        attrs,
1119                        body
1120                )
1121
1122                attrs.description = '';
1123
1124                // render 'publications list'
1125                out << '<div id="' + attrs.name + '_dialog" class="contacts_dialog" style="display: none;">'
1126                baseElement.call(
1127                        '_personSelect',
1128                        attrs,
1129                        body
1130                )
1131                baseElement.call(
1132                        '_roleSelect',
1133                        attrs,
1134                        body
1135                )
1136                baseElement.call(
1137                        '_contactAddButtonAddition',
1138                        attrs,
1139                        body
1140                )
1141                out << '</div>';
1142
1143                // render 'Add contact button'
1144                baseElement.call(
1145                        '_contactAddDialogButton',
1146                        attrs,
1147                        body
1148                )
1149        }
1150
1151        def _contactList = { attrs, body ->
1152                def display_none = 'none';
1153                if (!attrs.get('value') || attrs.get('value').size() == 0) {
1154                        display_none = 'inline';
1155                }
1156
1157                // Add a unordered list
1158                out << '<ul class="contact_list" id="' + attrs.name + '_list">';
1159
1160                out << '<li>';
1161                out << '<span class="contacts_none" id="' + attrs.name + '_none" style="display: ' + display_none + ';">';
1162                out << 'No contacts selected';
1163                out << '</span>';
1164                out << '</li>';
1165
1166                out << '</ul>';
1167
1168                // Add the contacts using javascript
1169                out << '<script type="text/javascript">'
1170                if (attrs.get('value') && attrs.get('value').size() > 0) {
1171                        def i = 0;
1172                        attrs.get('value').each {
1173                                out << 'showContact( ';
1174                                out << '  "' + attrs.name + '",';
1175                                out << '  "' + it.person.id + '-' + it.role.id + '",';
1176                                out << '  "' + it.person.lastName + ', ' + it.person.firstName + (it.person.prefix ? ' ' + it.person.prefix : '') + '",';
1177                                out << '  "' + it.role.name + '",';
1178                                out << '  ' + i++;
1179                                out << ');';
1180                        }
1181                }
1182                out << '</script>';
1183
1184                def ids = '';
1185                if (attrs.get('value') && attrs.get('value').size() > 0) {
1186                        ids = attrs.get('value').collect { it.person.id + '-' + it.role.id }
1187                        ids = ids.join(',');
1188                }
1189                out << '<input type="hidden" name="' + attrs.name + '_ids" value="' + ids + '" id="' + attrs.name + '_ids">';
1190        }
1191
1192        def _contactAddSelect = { attrs, body ->
1193                out << _personSelect(attrs) + _roleSelect(attrs);
1194        }
1195
1196        def _contactAddButtonAddition = { attrs, body ->
1197                out << '<input type="button" onClick="addContact ( \'' + attrs.name + '\' ); $(\'#' + attrs.name + '_dialog\').hide(); $( \'#' + attrs.name + '_dialogButton\' ).show();" value="Add">';
1198                out << '<input type="button" onClick="$(\'#' + attrs.name + '_dialog\').hide(); $( \'#' + attrs.name + '_dialogButton\' ).show();" value="Close">';
1199        }
1200
1201        def _contactAddDialogButton = { attrs, body ->
1202                out << '<input type="button" onClick="$( \'#' + attrs.name + '_dialog\' ).show(); $(this).hide();" id="' + attrs.name + '_dialogButton" value="Add Contact">';
1203        }
1204        /**
1205         * Person select element
1206         * @param Map attributes
1207         */
1208        def _personSelect = { attrs ->
1209                def selectAttrs = new LinkedHashMap();
1210
1211                // define 'from'
1212                def persons = Person.findAll().sort({ a, b -> a.lastName == b.lastName ? (a.firstName <=> b.firstName) : (a.lastName <=> b.lastName) } as Comparator);
1213                selectAttrs.from = persons.collect { it.lastName + ', ' + it.firstName + (it.prefix ? ' ' + it.prefix : '') }
1214                selectAttrs.keys = persons.id;
1215
1216                // add 'rel' attribute
1217                selectAttrs.rel = 'person'
1218                selectAttrs.name = attrs.name + '_person';
1219
1220                // add a dummy field
1221                selectAttrs.from.add(0,'')
1222
1223                out << "Person: " + select(selectAttrs)
1224        }
1225
1226        /**
1227         * Role select element
1228         * @param Map attributes
1229         */
1230        def _roleSelect = { attrs ->
1231                println(attrs);
1232                def selectAttrs = new LinkedHashMap();
1233
1234                // define 'from'
1235                def roles = PersonRole.findAll();
1236                selectAttrs.from = roles.collect { it.name };
1237                selectAttrs.keys = roles.id;
1238
1239                // add 'rel' attribute
1240                selectAttrs.rel = 'role'
1241                selectAttrs.name = attrs.name + '_role';
1242
1243                // add a dummy field
1244                selectAttrs.from.add(0,'')
1245
1246                out << "Role: " + select(selectAttrs)
1247        }
1248}
Note: See TracBrowser for help on using the repository browser.