Changeset 322 for trunk/grails-app/services/JsUtilService.groovy

Timestamp:

Feb 8, 2010, 2:51:23 AM (14 years ago)

Author:

gav

Message:

Move JavascriptService to JsUtilService.
Consolidate similar JsUtilService methods.
Create JsUtilTagLib?.
Disable pulsing of asset tree loading image.

File:

• trunk/grails-app/services/JsUtilService.groovy (moved) (moved from trunk/grails-app/services/JavascriptService.groovy) (4 diffs)

trunk/grails-app/services/JsUtilService.groovy

@@ -1 +1 @@
 /**
 * Provides some javascript utility methods.
-* To use include the following in the gsp head:
-* <!--
-* <g:javascript src="util.js" />
-* -->
-* @todo: util.js could be placed a taglib resources closure.
+* For use with JsUtilTagLib.
 */
-class JavascriptService {
+class JsUtilService {
 
     boolean transactional = false
@@ -16 +12 @@
     * Toggle the visibility of an html element.
     * @param id The html id of the element.
-    * @returns A javascript string that can be assigned to an onclick action.
+    * @param type The type of html action the javascript will be applied to e.g 'onclick', defaults to 'href'.
+    * @returns A javascript string that can be assigned for example to an anchor href or onclick action.
     */
-    def onclickToggle(id) {
-        'return toggleUtil(\"' + id + '\");'
+    def toggle(id, type="href") {
+        def s = 'toggleUtil(\"' + id + '\");'
+        if(type == "onclick")
+            s + ' return false;'
+        else
+            'javascript: ' + s
     }
 
     /**
-    * Toggle the visibility of an html element.
-    * @param id The html id of the element.
-    * @returns A javascript string that can be assigned to an anchor href.
+    * Toggle the visibility of an html element and update an image.
+    * @param toggleId The html id of the element to toggle.
+    * @param imageid The html id of the image to update.
+    * @param openImgUrl The url to apply as the image src when toggled element is visible.
+    * @param closedImgUrl The url to apply as the image src when toggled element is hidden.
+    * @param type The type of html action the javascript will be applied to e.g 'onclick', defaults to 'href'.
+    * @returns A javascript string that can be assigned for example to an anchor href or onclick action.
     */
-    def hrefToggle(id) {
-        'javascript: toggleUtil(\"' + id + '\");'
+    def toggleWithImg(toggleId, imageid, openImgUrl, closedImgUrl, type="href") {
+
+        def s = 'toggleWithImgUtil(\"' + toggleId +'\", \"' + imageid +'\", \"' + openImgUrl +'\", \"' + closedImgUrl +'\");'
+        if(type == "onclick")
+            s + ' return false;'
+        else
+            'javascript: ' + s
+
     }
 
@@ -34 +45 @@
     * Show an html element by slowly increasing the visibility.
     * @param id The html id of the element.
-    * @returns A javascript string that can be assigned to an onclick action.
+    * @param type The type of html action the javascript will be applied to e.g 'onclick', defaults to 'href'.
+    * @returns A javascript string that can be assigned for example to an anchor href or onclick action.
     */
-    def onclickShow(id) {
-        'return showUtil(\"' + id + '\");'
-    }
-
-    /**
-    * Show an html element by slowly increasing the visibility.
-    * @param id The html id of the element.
-    * @returns A javascript string that can be assigned to an anchor href.
-    */
-    def hrefShow(id) {
-        'javascript: showUtil(\"' + id + '\");'
+    def show(id) {
+        def s = 'showUtil(\"' + id + '\");'
+        if(type == "onclick")
+            s + ' return false;'
+        else
+            'javascript: ' + s
     }
 
@@ -52 +59 @@
     * Hide an html element by slowly decreasing the visibility.
     * @param id The html id of the element.
-    * @returns A javascript string that can be assigned to an onclick action.
+    * @param type The type of html action the javascript will be applied to e.g 'onclick', defaults to 'href'.
+    * @returns A javascript string that can be assigned for example to an anchor href or onclick action.
     */
-    def onclickHide(id) {
-        'return hideUtil(\"' + id + '\");'
-    }
-
-    /**
-    * Hide an html element by slowly decreasing the visibility.
-    * @param id The html id of the element.
-    * @returns A javascript string that can be assigned to an anchor href.
-    */
-    def hrefHide(id) {
-        'javascript: hideUtil(\"' + id + '\");'
+    def hide(id) {
+        def s = 'hideUtil(\"' + id + '\");'
+        if(type == "onclick")
+            s + ' return false;'
+        else
+            'javascript: ' + s
     }