com.flexive.faces.javascript.FxJavascriptUtils.java Source code

Introduction

Here is the source code for com.flexive.faces.javascript.FxJavascriptUtils.java

Source

/***************************************************************
 *  This file is part of the [fleXive](R) framework.
 *
 *  Copyright (c) 1999-2014
 *  UCS - unique computing solutions gmbh (http://www.ucs.at)
 *  All rights reserved
 *
 *  The [fleXive](R) project is free software; you can redistribute
 *  it and/or modify it under the terms of the GNU Lesser General Public
 *  License version 2.1 or higher as published by the Free Software Foundation.
 *
 *  The GNU Lesser General Public License can be found at
 *  http://www.gnu.org/licenses/lgpl.html.
 *  A copy is found in the textfile LGPL.txt and important notices to the
 *  license from the author are found in LICENSE.txt distributed with
 *  these libraries.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  For further information about UCS - unique computing solutions gmbh,
 *  please see the company website: http://www.ucs.at
 *
 *  For further information about [fleXive](R), please see the
 *  project website: http://www.flexive.org
 *
 *
 *  This copyright notice MUST APPEAR in all copies of the file!
 ***************************************************************/
package com.flexive.faces.javascript;

import org.apache.commons.lang.StringUtils;

import javax.faces.context.ResponseWriter;
import java.io.IOException;
import java.io.Writer;

/**
 * Utility functions for handling/creating javascript code.
 *
 * @author Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
 * @version $Rev$
 */
public class FxJavascriptUtils {

    /**
     * Private c'tor to avoid instantiation
     */
    private FxJavascriptUtils() {
    }

    /**
     * Start a javascript block.
     *
     * @param out the response writer
     * @throws IOException if the code could not be written
     * @since 3.1.4
     */
    public static void beginJavascript(ResponseWriter out) throws IOException {

        // Rely on JSF to determine if an enclosing CDATA block needs to be rendered.
        // This may lead to validation errors if JSF is not rendering in XHTML mode,
        // but improves compatibility in JSF2 for AJAX updates, where nested CDATA sections cause problems.

        out.startElement("script", null);
        out.writeAttribute("type", "text/javascript", null);
    }

    /**
     * End a javascript block.
     *
     * @param out the response writer
     * @throws IOException if the code could not be written
     * @since 3.1.4
     */
    public static void endJavascript(ResponseWriter out) throws IOException {
        out.endElement("script");
    }

    /**
     * Starts an inline stylesheet tag.
     *
     * @param out the output writer
     * @throws IOException if the code could not be written
     */
    public static void beginStyleSheet(Writer out) throws IOException {
        out.write("<style type=\"text/css\">\n");
    }

    /**
     * Ends an inline stylesheet tag.
     *
     * @param out the output writer
     * @throws IOException if the code could not be written
     */
    public static void endStyleSheet(Writer out) throws IOException {
        out.write("\n</style>\n");
    }

    /**
     * Write dojo "require" calls for all requested components.
     *
     * @param out      the output writer
     * @param packages array of packages to be written (e.g. "dojo.widget.*")
     * @throws IOException if the code could not be written
     */
    public static void writeDojoRequires(Writer out, String... packages) throws IOException {
        for (String pkg : packages) {
            out.write("dojo.require(\"" + pkg + "\");\n");
        }
    }

    /**
     * Converts the given fully qualified widget name (e.g. dojo.widget.Menu2) to
     * the widget name used createWidget. The package prefix "flexive.widget" is converted
     * to the namespace prefix "flexive:".
     *
     * @param fqn a fully qualified widget name, e.g. "dojo.widget.Menu2"
     * @return the widget name for dojo.widget.createWidget
     */
    public static String getWidgetName(String fqn) {
        return StringUtils.replace(StringUtils.replace(fqn, "flexive.widget.", "flexive:"), "dojo.widget.", "");
    }

    /**
     * Write Yahoo require calls for all requested components.
     *
     * @param out      the output writer
     * @param packages array of componentsto be written (e.g. "button")
     * @throws IOException if the code could not be written
     */
    public static void writeYahooRequires(Writer out, String... packages) throws IOException {
        for (String pkg : packages) {
            out.write("flexive.yui.require(\"" + pkg + "\");\n");
        }
    }

    /**
     * Renders a function to be called when Yahoo UI has been loaded.
     *
     * @param out the output writer
     * @param fn  the javascript function, either a reference or an anonymous function
     * @throws IOException if the code could not be written
     */
    public static void onYahooLoaded(Writer out, String fn) throws IOException {
        out.write("flexive.yui.onYahooLoaded(" + fn + ");\n");
    }

    /**
     * Add YUI's Resizable control to the given DOM ID.
     *
     * @param writer        the output writer
     * @param elementId     the target DOM element
     * @throws IOException  if the code could not be written
     * @since 3.1
     */
    public static void makeResizable(ResponseWriter writer, String elementId) throws IOException {
        beginJavascript(writer);
        writeYahooRequires(writer, "resize");
        onYahooLoaded(writer, "function() { " + "new YAHOO.util.Resize(\"" + elementId + "\");" + " }");
        endJavascript(writer);
    }
}