com.sun.webui.jsf.renderkit.html.ScriptRenderer Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2007-2018 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.webui.jsf.renderkit.html;
import com.sun.faces.annotation.Renderer;
import com.sun.webui.jsf.component.Script;
import com.sun.webui.jsf.util.RenderingUtilities;
import java.io.IOException;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
/**
* This class is responsible for rendering the script component for the
* HTML Render Kit.
The script component can be used as an Script
*/
@Renderer(@Renderer.Renders(componentFamily = "com.sun.webui.jsf.Script"))
public class ScriptRenderer extends AbstractRenderer {
// -------------------------------------------------------- Static Variables
/**
* The set of String pass-through attributes to be rendered.
*/
private static final String stringAttributes[] = {"charset", "type"}; //NOI18N
// -------------------------------------------------------- Renderer Methods
/**
* Render the start of an Script (Script) tag.
* @param context FacesContext for the current request
* @param component UIComponent to be rendered
* @param writer ResponseWriter to which the element
* start should be rendered
* @exception IOException if an input/output error occurs
*/
@Override
protected void renderStart(FacesContext context, UIComponent component,
ResponseWriter writer) throws IOException {
writer.startElement("script", component);
}
/**
* Render the attributes for an Script tag. The onclick attribute will contain
* extra javascript that will appropriately submit the form if the URL field is
* not set.
* @param context FacesContext for the current request
* @param component UIComponent to be rendered
* @param writer ResponseWriter to which the element
* attributes should be rendered
* @exception IOException if an input/output error occurs
*/
@Override
protected void renderAttributes(FacesContext context, UIComponent component,
ResponseWriter writer) throws IOException {
Script script = (Script) component;
addCoreAttributes(context, component, writer, null);
addStringAttributes(context, component, writer, stringAttributes);
// the URL is the tough thing because it needs to be encoded:
String url = script.getUrl();
if (url != null) {
// Get resource URL -- bugtraq #6305522.
RenderingUtilities.renderURLAttribute(context, writer, script, "src", //NO18N
context.getApplication().getViewHandler().getResourceURL(context, url),
"url"); //NO18N
}
}
/**
* Close off the Script tag.
* @param context FacesContext for the current request
* @param component UIComponent to be rendered
* @param writer ResponseWriter to which the element
* end should be rendered
* @exception IOException if an input/output error occurs
*/
@Override
protected void renderEnd(FacesContext context, UIComponent component,
ResponseWriter writer) throws IOException {
// End the appropriate element
Script script = (Script) component;
writer.endElement("script"); //NOI18N
writer.write("\n"); //NOI18N
}
// --------------------------------------------------------- Private Methods
}