com.sun.webui.jsf.renderkit.html.MarkupRenderer 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.Markup;
import com.sun.webui.jsf.util.RenderingUtilities;
import java.io.IOException;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
/**
* This class is responsible for rendering any type of XML tag markup.
*/
@Renderer(@Renderer.Renders(componentFamily = "com.sun.webui.jsf.Markup"))
public class MarkupRenderer extends AbstractRenderer {
// -------------------------------------------------------- Static Variables
/**
* The set of String pass-through attributes to be rendered.
*/
// no pass throughs.
// -------------------------------------------------------- Renderer Methods
@Override
public boolean getRendersChildren() {
return true;
}
/**
* Render the start of an Link (Link) 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 {
//intentionally empty
Markup markup = (Markup) component;
String tagName = markup.getTag();
if (tagName == null) {
return; //TODO: write out log message
}
if (!markup.isSingleton()) {
// Markup is a singleton
writeInsides(markup, context, writer);
}
}
/**
* Render the attributes for the Markup.
* @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 {
Markup markup = (Markup) component;
}
@Override
public void encodeChildren(FacesContext context, UIComponent component)
throws IOException {
Markup markup = (Markup) component;
if (!markup.isSingleton()) {
super.encodeChildren(context, component);
}
}
/**
* Write out the Markup.
* @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
Markup markup = (Markup) component;
String tagName = markup.getTag();
if (tagName == null) {
return; //TODO: write out log message
}
if (markup.isSingleton()) {
// Markup is a singleton
writeInsides(markup, context, writer);
}
writer.endElement(tagName);
}
// --------------------------------------------------------- Private Methods
private void writeInsides(Markup markup,
FacesContext context, ResponseWriter writer) throws IOException {
String tagName = markup.getTag();
writer.startElement(tagName, markup);
writeId(markup, context, writer);
writeStyles(markup, context, writer);
writeExtraAttributes(markup, context, writer);
}
private void writeId(Markup markup,
FacesContext context, ResponseWriter writer) throws IOException {
String id = markup.getClientId(context);
if (id != null) {
writer.writeAttribute("id", id, null); //NO18N
}
}
private void writeStyles(Markup markup,
FacesContext context, ResponseWriter writer) throws IOException {
String style = markup.getStyle();
String styleClass = markup.getStyleClass();
if (style != null) {
writer.writeAttribute("style", style, null); //NO18N
}
if (styleClass != null) {
writer.writeAttribute("class", styleClass, "styleClass"); //NO18N
}
}
private void writeExtraAttributes(Markup markup,
FacesContext context, ResponseWriter writer) throws IOException {
String extra = markup.getExtraAttributes();
if (extra != null) {
RenderingUtilities.renderExtraHtmlAttributes(writer, extra);
}
Map attributes = markup.getAttributes();
Set keys = attributes.keySet();
Iterator listOfKeys = keys.iterator();
while (listOfKeys.hasNext()) {
String key = (String) listOfKeys.next();
Object value = attributes.get(key);
// Only take strings (their is a private arraylist that I need to
// avoid
if (value != null && value instanceof String) {
writer.writeAttribute(key, value, null);
}
}
}
}