wamblee.org Git - utils/blob - wicket/components/src/main/java/org/wamblee/wicket/jquery/JQueryHeaderContributor.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.Application;
  19 import org.apache.wicket.behavior.HeaderContributor;
  20 import org.apache.wicket.markup.html.IHeaderContributor;
  21 import org.apache.wicket.markup.html.IHeaderResponse;
  22 import org.apache.wicket.markup.html.JavascriptPackageResource;
  23
  24 /**
  25  * JQuery header contribution that adds the jquery javascript and sets jQuery to
  26  * no-conflict mode so the <code>$</code> identifier is freed. Also, it checks
  27  * the current configuration and uses the development mode jQuery library when run in
  28  * development mode and used the minimalized jQuery code when running in deployment mode.
  29  *
  30  * @author Erik Brakkee
  31  */
  32 public class JQueryHeaderContributor extends HeaderContributor {
  33
  34     static final String JQUERY_DEPLOYMENT = "jquery-1.4.2.min.js";
  35     static final String JQUERY_DEVELOPMENT = "jquery-1.4.2.js";
  36     static final String JQUERY_NOCONFLICT = "jquery-noconflict.js";
  37
  38     private static HeaderContributor JQUERY_CONTRIBUTOR;
  39     private static HeaderContributor JQUERY_NOCONFLICT_CONTRIBUTOR =
  40         JavascriptPackageResource.getHeaderContribution(
  41             JQueryHeaderContributor.class, JQUERY_NOCONFLICT);
  42
  43     /**
  44      * Constructs the behavior.
  45      */
  46     public JQueryHeaderContributor() {
  47         super(getContributor());
  48     }
  49
  50     /**
  51      * Resets the cached value of the header contribution. Used typically for test only.
  52      */
  53     public static void clear() {
  54         JQUERY_CONTRIBUTOR = null;
  55     }
  56
  57     private static IHeaderContributor getContributor() {
  58         if (JQUERY_CONTRIBUTOR == null) {
  59             JQUERY_CONTRIBUTOR = JavascriptPackageResource.getHeaderContribution(
  60                 JQueryHeaderContributor.class, getJQueryJavascript());
  61         }
  62         return new IHeaderContributor() {
  63             @Override
  64             public void renderHead(IHeaderResponse aResponse) {
  65                 JQUERY_CONTRIBUTOR.renderHead(aResponse);
  66                 JQUERY_NOCONFLICT_CONTRIBUTOR.renderHead(aResponse);
  67             }
  68         };
  69     }
  70
  71     private static String getJQueryJavascript() {
  72         return Application.get().getConfigurationType().equals(
  73             Application.DEVELOPMENT) ? JQUERY_DEVELOPMENT : JQUERY_DEPLOYMENT;
  74     }
  75 }