com.sun.webui.jsf.renderkit.html.FrameRenderer 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.
*/
/*
* $Id: FrameRenderer.java,v 1.1.16.1 2009-12-29 04:52:46 jyeary Exp $
*/
package com.sun.webui.jsf.renderkit.html;
import com.sun.faces.annotation.Renderer;
import java.io.IOException;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import com.sun.webui.jsf.component.Frame;
import com.sun.webui.jsf.util.RenderingUtilities;
/**
* Renderer for a {@link Frame} component.
*/
@Renderer(@Renderer.Renders(componentFamily = "com.sun.webui.jsf.Frame"))
public class FrameRenderer extends AbstractRenderer {
// ======================================================== Static Variables
/**
* The set of String pass-through attributes to be rendered.
*/
private static final String stringAttributes[] = {"name", "scrolling"}; //NOI18N
// -------------------------------------------------------- Renderer Methods
/**
* Render the appropriate element start for the outermost
* element.
*
* @param context FacesContext for the current request
* @param component component 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 {
Frame frame = (Frame) component;
// I don't think this is the correct way to write the XML
// header /avk
if (!RenderingUtilities.isPortlet(context)) {
writer.startElement("frame", component);
}
}
/**
* Render the appropriate element attributes, followed by the
* nested <head> element, plus the beginning
* of a nested <body> element.
*
* @param context FacesContext for the current request
* @param component component 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 renderAttributes(FacesContext context, UIComponent component,
ResponseWriter writer) throws IOException {
Frame frame = (Frame) component;
// Render a nested "head" element
if (!RenderingUtilities.isPortlet(context)) {
//id
String id = frame.getClientId(context);
if (id != null) {
writer.writeAttribute("id", id, null); //NOI18N
}
//url
String url = frame.getUrl();
if (url != null) {
// Append context path to relative URLs -- bugtraq #6338307.
url = context.getApplication().getViewHandler().
getResourceURL(context, url);
RenderingUtilities.renderURLAttribute(context,
writer,
component,
"src", //NOI18N
url,
null); //NOI18N
}
//class
String styleClass = frame.getStyleClass();
if (styleClass != null) {
writer.writeAttribute("class", styleClass, null); //NOI18N
}
//style
String style = frame.getStyle();
if (style != null) {
writer.writeAttribute("style", style, null); //NOI18N
}
//write out the rest of the attributes
addStringAttributes(context, component, writer, stringAttributes);
//frameborder
boolean border = frame.isFrameBorder();
if (border) {
writer.writeAttribute("frameborder", "1", null); //NOI18N
} else {
writer.writeAttribute("frameborder", "0", null); //NOI18N
}
//longdesc
String longdesc = frame.getLongDesc();
if (longdesc != null) {
writer.writeAttribute("longdesc", longdesc, null); //NOI18N
}
//marginWidth
Integer marginWidth = new Integer(frame.getMarginWidth());
if (frame.getMarginWidth() >= 0) {
writer.writeAttribute("marginwidth", marginWidth.toString(), null); //NOI18N
}
//marginHeight
Integer marginHeight = new Integer(frame.getMarginHeight());
if (frame.getMarginHeight() >= 0) {
writer.writeAttribute("marginheight", marginHeight.toString(), null); //NOI18N
}
renderResizeAttribute(writer, component);
//tooltip
String toolTip = frame.getToolTip();
if (toolTip != null) {
writer.writeAttribute("title", toolTip, "toolTip"); //NOI18N
}
}
}
/**
* Render the appropriate element end.
*
* @param context FacesContext for the current request
* @param component component 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 renderEnd(FacesContext context, UIComponent component,
ResponseWriter writer) throws IOException {
Frame frame = (Frame) component;
// End the outermost "html" element
if (!RenderingUtilities.isPortlet(context)) {
writer.write(" />"); //NOI18N
writer.write("\n"); //NOI18N
}
}
// ---------------------------------------------------s- protected Methods
protected void renderResizeAttribute(ResponseWriter writer, UIComponent comp)
throws IOException {
//noresize
boolean noresize = ((Frame) comp).isNoResize();
if (noresize) {
writer.writeAttribute("noresize", "noresize", null); //NOI18N
}
}
}