org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlGridRendererBase Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tomahawk21 Show documentation
Show all versions of tomahawk21 Show documentation
JSF components and utilities that can be used with any JSF implementation.
This library is based on the JSF1.1 version of Tomahawk, but with minor source code and build
changes to take advantage of JSF2.1 features. A JSF2.1 implementation is required to use this
version of the Tomahawk library.
The newest version!
/*
* 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 org.apache.myfaces.shared_tomahawk.renderkit.html;
import java.io.IOException;
import java.util.List;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.faces.application.ProjectStage;
import javax.faces.component.UIComponent;
import javax.faces.component.UIPanel;
import javax.faces.component.behavior.ClientBehavior;
import javax.faces.component.behavior.ClientBehaviorHolder;
import javax.faces.component.html.HtmlPanelGrid;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import org.apache.myfaces.shared_tomahawk.renderkit.JSFAttr;
import org.apache.myfaces.shared_tomahawk.renderkit.RendererUtils;
import org.apache.myfaces.shared_tomahawk.renderkit.html.util.JavascriptUtils;
import org.apache.myfaces.shared_tomahawk.renderkit.html.util.ResourceUtils;
import org.apache.myfaces.shared_tomahawk.util.ArrayUtils;
import org.apache.myfaces.shared_tomahawk.util.StringUtils;
/**
* @author Martin Marinschek
* @version $Revision: 1239799 $ $Date: 2012-02-02 15:00:42 -0500 (Thu, 02 Feb 2012) $
*
* $Log: $
*/
public class HtmlGridRendererBase
extends HtmlRenderer
{
//private static final Log log = LogFactory.getLog(HtmlGridRendererBase.class);
private static final Logger log = Logger.getLogger(HtmlGridRendererBase.class.getName());
private static final Integer[] ZERO_INT_ARRAY = new Integer[]{0};
public boolean getRendersChildren()
{
return true;
}
@Override
public void decode(FacesContext context, UIComponent component)
{
// Check for npe
super.decode(context, component);
HtmlRendererUtils.decodeClientBehaviors(context, component);
}
public void encodeBegin(FacesContext facesContext, UIComponent component)
throws IOException
{
// all work done in encodeEnd()
}
public void encodeChildren(FacesContext context, UIComponent component)
throws IOException
{
// all work done in encodeEnd()
}
public void encodeEnd(FacesContext facesContext, UIComponent component)
throws IOException
{
RendererUtils.checkParamValidity(facesContext, component, UIPanel.class);
int columns;
if (component instanceof HtmlPanelGrid)
{
columns = ((HtmlPanelGrid)component).getColumns();
}
else
{
Integer i = (Integer)component.getAttributes().get(
org.apache.myfaces.shared_tomahawk.renderkit.JSFAttr.COLUMNS_ATTR);
columns = i != null ? i.intValue() : 0;
}
if (columns <= 0)
{
if (log.isLoggable(Level.SEVERE))
{
log.severe("Wrong columns attribute for PanelGrid " +
component.getClientId(facesContext) + ": " + columns);
}
columns = 1;
}
ResponseWriter writer = facesContext.getResponseWriter();
Map> behaviors = null;
if (component instanceof ClientBehaviorHolder)
{
behaviors = ((ClientBehaviorHolder) component).getClientBehaviors();
}
if (behaviors != null && !behaviors.isEmpty())
{
ResourceUtils.renderDefaultJsfJsInlineIfNecessary(facesContext, writer);
}
writer.startElement(HTML.TABLE_ELEM, component);
if (component instanceof ClientBehaviorHolder && JavascriptUtils.isJavascriptAllowed(
facesContext.getExternalContext()))
{
if (!behaviors.isEmpty())
{
HtmlRendererUtils.writeIdAndName(writer, component, facesContext);
}
else
{
HtmlRendererUtils.writeIdIfNecessary(writer, component, facesContext);
}
long commonPropertiesMarked = 0L;
if (isCommonPropertiesOptimizationEnabled(facesContext))
{
commonPropertiesMarked = CommonPropertyUtils.getCommonPropertiesMarked(component);
}
if (behaviors.isEmpty() && isCommonPropertiesOptimizationEnabled(facesContext))
{
CommonPropertyUtils.renderEventProperties(writer,
commonPropertiesMarked, component);
}
else
{
if (isCommonEventsOptimizationEnabled(facesContext))
{
CommonEventUtils.renderBehaviorizedEventHandlers(facesContext, writer,
commonPropertiesMarked,
CommonEventUtils.getCommonEventsMarked(component), component, behaviors);
}
else
{
HtmlRendererUtils.renderBehaviorizedEventHandlers(facesContext, writer, component, behaviors);
}
}
if (isCommonPropertiesOptimizationEnabled(facesContext))
{
HtmlRendererUtils.renderHTMLAttributes(writer, component, HTML.TABLE_ATTRIBUTES);
CommonPropertyUtils.renderCommonPassthroughPropertiesWithoutEvents(writer,
commonPropertiesMarked, component);
}
else
{
HtmlRendererUtils.renderHTMLAttributes(writer, component,
HTML.TABLE_PASSTHROUGH_ATTRIBUTES_WITHOUT_EVENTS);
}
}
else
{
HtmlRendererUtils.writeIdIfNecessary(writer, component, facesContext);
if (isCommonPropertiesOptimizationEnabled(facesContext))
{
HtmlRendererUtils.renderHTMLAttributes(writer, component, HTML.TABLE_ATTRIBUTES);
CommonPropertyUtils.renderCommonPassthroughProperties(writer,
CommonPropertyUtils.getCommonPropertiesMarked(component), component);
}
else
{
HtmlRendererUtils.renderHTMLAttributes(writer, component, HTML.TABLE_PASSTHROUGH_ATTRIBUTES);
}
}
writer.flush();
HtmlRendererUtils.renderTableCaption(facesContext, writer, component);
// theader and tfooter are rendered before the tbody
renderHeaderOrFooter(facesContext, writer, component, columns, true); //Header facet
renderHeaderOrFooter(facesContext, writer, component, columns, false); //Footer facet
renderChildren(facesContext, writer, component, columns);
writer.endElement(HTML.TABLE_ELEM);
}
protected void renderHeaderOrFooter(FacesContext context,
ResponseWriter writer,
UIComponent component,
int columns,
boolean header)
throws IOException
{
UIComponent facet = component.getFacet(header ? "header" : "footer");
if (facet == null)
{
return;
}
HtmlRendererUtils.writePrettyLineSeparator(context);
writer.startElement(
header ? org.apache.myfaces.shared_tomahawk.renderkit.html.HTML.THEAD_ELEM : HTML.TFOOT_ELEM, component);
writer.startElement(HTML.TR_ELEM, component);
writer.startElement(header ? HTML.TH_ELEM : HTML.TD_ELEM, component);
String styleClass = (component instanceof HtmlPanelGrid)
? (header ?
((HtmlPanelGrid)component).getHeaderClass() :
((HtmlPanelGrid)component).getFooterClass())
: (header ?
(String)component.getAttributes().get(JSFAttr.HEADER_CLASS_ATTR) :
(String)component.getAttributes().get(
org.apache.myfaces.shared_tomahawk.renderkit.JSFAttr.FOOTER_CLASS_ATTR));
if (styleClass != null)
{
writer.writeAttribute(HTML.CLASS_ATTR, styleClass,
header ? JSFAttr.HEADER_CLASS_ATTR :
org.apache.myfaces.shared_tomahawk.renderkit.JSFAttr.FOOTER_CLASS_ATTR);
}
if (header)
{
writer.writeAttribute(HTML.SCOPE_ATTR, HTML.SCOPE_COLGROUP_VALUE, null);
}
writer.writeAttribute(HTML.COLSPAN_ATTR, Integer.toString(columns), null);
HtmlRendererUtils.writePrettyLineSeparator(context);
//RendererUtils.renderChild(context, facet);
facet.encodeAll(context);
HtmlRendererUtils.writePrettyLineSeparator(context);
writer.endElement(header ? HTML.TH_ELEM : HTML.TD_ELEM);
writer.endElement(HTML.TR_ELEM);
writer.endElement(header ? HTML.THEAD_ELEM : HTML.TFOOT_ELEM);
}
protected int childAttributes(FacesContext context,
ResponseWriter writer,
UIComponent component,
int columnIndex)
throws IOException
{
// subclasses can override this method to add attributes to the table cell tag
return columnIndex;
}
protected void renderChildren(FacesContext context,
ResponseWriter writer,
UIComponent component,
int columns)
throws IOException
{
String columnClasses;
String rowClasses;
if (component instanceof HtmlPanelGrid)
{
columnClasses = ((HtmlPanelGrid)component).getColumnClasses();
rowClasses = ((HtmlPanelGrid)component).getRowClasses();
}
else
{
columnClasses = (String)component.getAttributes().get(
org.apache.myfaces.shared_tomahawk.renderkit.JSFAttr.COLUMN_CLASSES_ATTR);
rowClasses = (String)component.getAttributes().get(JSFAttr.ROW_CLASSES_ATTR);
}
String[] columnClassesArray = (columnClasses == null)
? ArrayUtils.EMPTY_STRING_ARRAY
: StringUtils.trim(StringUtils.splitShortString(columnClasses, ','));
int columnClassesCount = columnClassesArray.length;
String[] rowClassesArray = (rowClasses == null)
? org.apache.myfaces.shared_tomahawk.util.ArrayUtils.EMPTY_STRING_ARRAY
: StringUtils.trim(StringUtils.splitShortString(rowClasses, ','));
int rowClassesCount = rowClassesArray.length;
int childCount = getChildCount(component);
if (childCount > 0)
{
// get the row indizes for which a new TBODY element should be created
Integer[] bodyrows = null;
String bodyrowsAttr = (String) component.getAttributes().get(JSFAttr.BODYROWS_ATTR);
if(bodyrowsAttr != null && !"".equals(bodyrowsAttr))
{
String[] bodyrowsString = StringUtils.trim(StringUtils.splitShortString(bodyrowsAttr, ','));
// parsing with no exception handling, because of JSF-spec:
// "If present, this must be a comma separated list of integers."
bodyrows = new Integer[bodyrowsString.length];
for(int i = 0; i < bodyrowsString.length; i++)
{
bodyrows[i] = new Integer(bodyrowsString[i]);
}
}
else
{
bodyrows = ZERO_INT_ARRAY;
}
int bodyrowsCount = 0;
int rowIndex = -1;
int columnIndex = 0;
int rowClassIndex = 0;
boolean rowStarted = false;
for (int i = 0, size = component.getChildCount(); i < size; i++)
{
UIComponent child = component.getChildren().get(i);
if (child.isRendered())
{
if (columnIndex == 0)
{
rowIndex++;
if (rowStarted)
{
//do we have to close the last row?
writer.endElement(HTML.TR_ELEM);
HtmlRendererUtils.writePrettyLineSeparator(context);
}
// is the current row listed in the bodyrows attribute
if(ArrayUtils.contains(bodyrows, rowIndex))
{
// close any preopened TBODY element first
if(bodyrowsCount != 0)
{
writer.endElement(HTML.TBODY_ELEM);
HtmlRendererUtils.writePrettyLineSeparator(context);
}
writer.startElement(HTML.TBODY_ELEM, component);
HtmlRendererUtils.writePrettyLineSeparator(context);
bodyrowsCount++;
}
//start of new/next row
writer.startElement(HTML.TR_ELEM, component);
if (rowClassIndex < rowClassesCount)
{
writer.writeAttribute(HTML.CLASS_ATTR, rowClassesArray[rowClassIndex], null);
}
rowStarted = true;
rowClassIndex++;
if (rowClassIndex == rowClassesCount)
{
rowClassIndex = 0;
}
}
writer.startElement(HTML.TD_ELEM, component);
if (columnIndex < columnClassesCount)
{
writer.writeAttribute(HTML.CLASS_ATTR, columnClassesArray[columnIndex], null);
}
columnIndex = childAttributes(context, writer, child, columnIndex);
//RendererUtils.renderChild(context, child);
child.encodeAll(context);
writer.endElement(HTML.TD_ELEM);
columnIndex++;
if (columnIndex >= columns)
{
columnIndex = 0;
}
}
}
if (rowStarted)
{
if (columnIndex > 0)
{
Level level = context.isProjectStage(ProjectStage.Production) ? Level.FINE : Level.WARNING;
if (log.isLoggable(level))
{
log.log(level, "PanelGrid " + RendererUtils.getPathToComponent(component)
+ " has not enough children. Child count should be a "
+ "multiple of the columns attribute.");
}
//Render empty columns, so that table is correct
for ( ; columnIndex < columns; columnIndex++)
{
writer.startElement(HTML.TD_ELEM, component);
if (columnIndex < columnClassesCount)
{
writer.writeAttribute(HTML.CLASS_ATTR, columnClassesArray[columnIndex], null);
}
writer.endElement(HTML.TD_ELEM);
}
}
writer.endElement(HTML.TR_ELEM);
HtmlRendererUtils.writePrettyLineSeparator(context);
// close any preopened TBODY element first
if(bodyrowsCount != 0)
{
writer.endElement(HTML.TBODY_ELEM);
HtmlRendererUtils.writePrettyLineSeparator(context);
}
}
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy