org.wicketstuff.push.dojo.DojoPackagedTextTemplate.java Source code

Introduction

Here is the source code for org.wicketstuff.push.dojo.DojoPackagedTextTemplate.java

Source

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with this
 * work for additional information regarding copyright ownership. The ASF
 * licenses this file to You under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law
 * or agreed to in writing, software distributed under the License is
 * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package org.wicketstuff.push.dojo;

import org.apache.wicket.Component;
//import org.apache.wicket.util.template.PackagedTextTemplate;
import org.apache.wicket.util.template.PackageTextTemplate;

/**
 * Used to externalized js in templates
 * 
 * @author Vincent Demay
 */
public class DojoPackagedTextTemplate extends PackageTextTemplate {
    private static final long serialVersionUID = 1L;

    private final String fileName;
    private final Class<?> clazz;

    /**
     * Constructor.
     * 
     * @param clazz
     *            The clazz to be used for retrieving the classloader for
     *            loading the packaged template.
     * @param fileName
     *            the name of the file, relative to the clazz position
     * @param contentType
     *            The mime type of this resource, such as "image/jpeg" or
     *            "text/html"
     * @param encoding
     *            The file's encoding, e.g. 'UTF-8'
     */
    public DojoPackagedTextTemplate(final Class<?> clazz, final String fileName, final String contentType,
            final String encoding) {
        super(clazz, fileName, contentType, encoding);
        this.clazz = clazz;
        this.fileName = fileName;
    }

    /**
     * Constructor.
     * 
     * @param clazz
     *            The clazz to be used for retrieving the classloader for
     *            loading the packaged template.
     * @param fileName
     *            the name of the file, relative to the clazz position
     * @param contentType
     *            The mime type of this resource, such as "image/jpeg" or
     *            "text/html"
     */
    public DojoPackagedTextTemplate(final Class<?> clazz, final String fileName, final String contentType) {
        this(clazz, fileName, contentType, null);
    }

    /**
     * Constructor.
     * 
     * @param component
     *            The component to be used for retrieving the classloader for
     *            loading the packaged template.
     * @param fileName
     *            The name of the file, relative to the clazz position
     */
    public DojoPackagedTextTemplate(final Class<?> clazz, final String fileName) {
        this(clazz, fileName, "text");
    }

    /**
     * Return a key to use in renderJavascript. A Static Key is a Key <b>Unique
     * for all widget of the same class</b>. So if there are n widget on the
     * same page, a resource rendered with a StaticKey will be displayed once.
     * 
     * @return a key to use in renderJavascript
     */
    public String getStaticKey() {
        return clazz.getName() + fileName;
    }

    /**
     * Return a key to use in renderJavascript. A WidgetUnique Key is a Key
     * <b>Unique for <u>one</u> widget of the class</b>. So if there are n
     * widget on the same page, a resource rendered with a WidgetUniqueKey will
     * be displayed n times. But if a same widget is render m times, this
     * resource wil render once
     * 
     * @param component
     *            component for which the uniqueKey will be generated
     * @return a key to use in renderJavascript
     */
    public String getWidgetUniqueKey(final Component component) {
        // use memory address to generate key
        return component.toString() + fileName;
    }

}