(no commit message)
[utils] / wicket / components / src / main / java / org / wamblee / wicket / jquery / JQueryUtils.java
1 /*
2  * Copyright 2005-2010 the original author or authors.
3  * 
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  * 
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  * 
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.wamblee.wicket.jquery;
17
18 import org.apache.wicket.Component;
19
20 /**
21  * JQueryUtilities to be used for creating JQuery javascript functions from java.
22  * 
23  * @author Erik Brakkee
24  *
25  */
26 public class JQueryUtils {
27     
28     /**
29      * Creates a jQuery ready handler that invokes a given javascript function with the id of 
30      * a component.  
31      * @param aFunction Javascript function to invoke.
32      * @param aComponent Component to invoke the id for. 
33      * @return
34      */
35     public static String createReadyFunction(String aFunction, Component aComponent) {
36         if ( !aComponent.getOutputMarkupId()) { 
37             throw new IllegalStateException("The component " + aComponent + 
38                 " does not have its markup id set so this ready handler will not have any effect");
39         }
40         StringBuffer js = new StringBuffer(); 
41         js.append("$(function(){");
42         js.append("org.wamblee." + aFunction + "(\"#" + aComponent.getMarkupId() + "\");");
43         js.append("});");
44         String jsString = js.toString();
45         return jsString;
46     }
47 }