com.gmail.volodymyrdotsenko.jqxwicket.core.JQueryAbstractBehavior.java Source code

Introduction

Here is the source code for com.gmail.volodymyrdotsenko.jqxwicket.core.JQueryAbstractBehavior.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 com.gmail.volodymyrdotsenko.jqxwicket.core;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import org.apache.wicket.Application;
import org.apache.wicket.Component;
import org.apache.wicket.ajax.AjaxRequestTarget;
import org.apache.wicket.behavior.Behavior;
import org.apache.wicket.markup.head.CssHeaderItem;
import org.apache.wicket.markup.head.IHeaderResponse;
import org.apache.wicket.markup.head.JavaScriptHeaderItem;
import org.apache.wicket.markup.head.PriorityHeaderItem;
import org.apache.wicket.request.resource.CssResourceReference;
import org.apache.wicket.request.resource.JavaScriptResourceReference;
import org.apache.wicket.request.resource.ResourceReference;
import org.apache.wicket.resource.JQueryPluginResourceReference;
import org.apache.wicket.settings.IJavaScriptLibrarySettings;

import com.gmail.volodymyrdotsenko.jqxwicket.core.settings.JQueryLibrarySettings;
import com.gmail.volodymyrdotsenko.jqxwicket.core.utils.RequestCycleUtils;

/**
 * Provides the base class for every jQuery behavior.
 * 
 * @author Sebastien Briquet - sebfz1
 * 
 */
public abstract class JQueryAbstractBehavior extends Behavior {
    private static final long serialVersionUID = 1L;

    /**
     * Gets the {@link JQueryLibrarySettings}
     * 
     * @return The {@link JQueryLibrarySettings} or <tt>null</tt> if
     *         {@link Application}'s {@link IJavaScriptLibrarySettings} is not
     *         an instance of {@link JQueryLibrarySettings}
     */
    public static JQueryLibrarySettings getJQueryLibrarySettings() {
        if (Application.exists()
                && (Application.get().getJavaScriptLibrarySettings() instanceof JQueryLibrarySettings)) {
            return (JQueryLibrarySettings) Application.get().getJavaScriptLibrarySettings();
        }

        return null;
    }

    /** Behavior name */
    private final String name;

    /** Additional references */
    private final List<ResourceReference> references;

    /**
     * Constructor.
     * 
     * @param name
     *            the name of the behavior. It is used in the token so the
     *            behavior can be identified in the generated page.
     */
    public JQueryAbstractBehavior(final String name) {
        this.name = name;
        this.references = new ArrayList<ResourceReference>();
    }

    /**
     * Adds a reference to be rendered at
     * {@link #renderHead(Component, IHeaderResponse)} time.
     * 
     * @param reference
     *            a {@link CssResourceReference}, a
     *            {@link JavaScriptResourceReference} or a
     *            {@link JQueryPluginResourceReference}
     * @return <tt>true</tt> (as specified by {@link Collection#add})
     */
    public boolean add(ResourceReference reference) {
        return this.references.add(reference);
    }

    @Override
    public void renderHead(Component component, IHeaderResponse response) {
        // Gets the library settings //
        JQueryLibrarySettings settings = getJQueryLibrarySettings();

        // jQuery Globalize resource reference //
        if (settings != null && settings.getJQueryGlobalizeReference() != null) {
            response.render(new PriorityHeaderItem(
                    JavaScriptHeaderItem.forReference(settings.getJQueryGlobalizeReference())));
        }

        // Additional resource references //
        for (ResourceReference reference : this.references) {
            if (reference instanceof CssResourceReference) {
                response.render(new PriorityHeaderItem(CssHeaderItem.forReference(reference)));
            }

            if (reference instanceof JavaScriptResourceReference) {
                response.render(new PriorityHeaderItem(JavaScriptHeaderItem.forReference(reference)));
            }
        }

        // Adds the statement //
        AjaxRequestTarget target = RequestCycleUtils.getAjaxRequestTarget();

        if (target != null) {
            target.appendJavaScript(this.$());
        } else {
            this.renderScript(JavaScriptHeaderItem.forScript(this.toString(), this.getToken()), response);
        }
    }

    /**
     * Renders the {@link Behavior}'s javascript<br/>
     * This can be overridden to provides a priority:<br/>
     * <code>response.render(new PriorityHeaderItem(script));</code>
     * 
     * @param script
     *            the {@link JavaScriptHeaderItem}
     * @param response
     *            the {@link IHeaderResponse}
     */
    protected void renderScript(JavaScriptHeaderItem script, IHeaderResponse response) {
        response.render(script);
    }

    /**
     * Gets the jQuery statement.
     * 
     * @return the jQuery statement
     */
    protected abstract String $();

    // Properties //

    /**
     * Get the unique behavior token that act as the script id.
     * 
     * @return the token
     */
    protected String getToken() {
        return String.format("jquery-%s-%d", this.name, this.hashCode());
    }

    /**
     * Gets the jQuery statement.
     * 
     * @return statement like 'jQuery(function() { ... });'
     */
    @Override
    public String toString() {
        return String.format("jQuery(function() { %s });", this.$());
    }
}