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

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