/*
* 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.tobago.renderkit.html.scarborough.standard.tag;
import org.apache.myfaces.tobago.component.Attributes;
import org.apache.myfaces.tobago.component.ComponentTypes;
import org.apache.myfaces.tobago.component.Facets;
import org.apache.myfaces.tobago.component.RendererTypes;
import org.apache.myfaces.tobago.component.SupportsMarkup;
import org.apache.myfaces.tobago.component.UIColumnSelector;
import org.apache.myfaces.tobago.component.UICommand;
import org.apache.myfaces.tobago.component.UILink;
import org.apache.myfaces.tobago.component.UIMenu;
import org.apache.myfaces.tobago.component.UIMenuCommand;
import org.apache.myfaces.tobago.component.UIOut;
import org.apache.myfaces.tobago.component.UIReload;
import org.apache.myfaces.tobago.component.UISheet;
import org.apache.myfaces.tobago.component.UIToolBar;
import org.apache.myfaces.tobago.config.Configurable;
import org.apache.myfaces.tobago.context.ClientProperties;
import org.apache.myfaces.tobago.context.Markup;
import org.apache.myfaces.tobago.context.ResourceManager;
import org.apache.myfaces.tobago.context.ResourceManagerUtils;
import org.apache.myfaces.tobago.event.PageAction;
import org.apache.myfaces.tobago.internal.component.AbstractUIColumn;
import org.apache.myfaces.tobago.internal.component.AbstractUIColumnNode;
import org.apache.myfaces.tobago.internal.component.AbstractUIData;
import org.apache.myfaces.tobago.internal.component.AbstractUIMenu;
import org.apache.myfaces.tobago.internal.component.AbstractUIOut;
import org.apache.myfaces.tobago.internal.component.AbstractUISheet;
import org.apache.myfaces.tobago.internal.context.ResourceManagerFactory;
import org.apache.myfaces.tobago.internal.layout.Cell;
import org.apache.myfaces.tobago.internal.layout.Grid;
import org.apache.myfaces.tobago.internal.layout.OriginCell;
import org.apache.myfaces.tobago.internal.util.StringUtils;
import org.apache.myfaces.tobago.layout.Display;
import org.apache.myfaces.tobago.layout.LayoutBase;
import org.apache.myfaces.tobago.layout.Measure;
import org.apache.myfaces.tobago.layout.TextAlign;
import org.apache.myfaces.tobago.model.ExpandedState;
import org.apache.myfaces.tobago.model.SheetState;
import org.apache.myfaces.tobago.model.TreePath;
import org.apache.myfaces.tobago.renderkit.LayoutComponentRendererBase;
import org.apache.myfaces.tobago.renderkit.css.Classes;
import org.apache.myfaces.tobago.renderkit.css.Style;
import org.apache.myfaces.tobago.renderkit.html.Command;
import org.apache.myfaces.tobago.renderkit.html.CommandMap;
import org.apache.myfaces.tobago.renderkit.html.DataAttributes;
import org.apache.myfaces.tobago.renderkit.html.HtmlAttributes;
import org.apache.myfaces.tobago.renderkit.html.HtmlElements;
import org.apache.myfaces.tobago.renderkit.html.HtmlInputTypes;
import org.apache.myfaces.tobago.renderkit.html.JsonUtils;
import org.apache.myfaces.tobago.renderkit.html.util.HtmlRendererUtils;
import org.apache.myfaces.tobago.renderkit.util.RenderUtils;
import org.apache.myfaces.tobago.util.ComponentUtils;
import org.apache.myfaces.tobago.util.CreateComponentUtils;
import org.apache.myfaces.tobago.util.FacetUtils;
import org.apache.myfaces.tobago.webapp.TobagoResponseWriter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.faces.application.Application;
import javax.faces.component.UIColumn;
import javax.faces.component.UIComponent;
import javax.faces.component.UISelectOne;
import javax.faces.context.FacesContext;
import java.io.IOException;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Locale;
import java.util.Map;
public class SheetRenderer extends LayoutComponentRendererBase {
private static final Logger LOG = LoggerFactory.getLogger(SheetRenderer.class);
public static final String WIDTHS_POSTFIX = ComponentUtils.SUB_SEPARATOR + "widths";
public static final String SCROLL_POSTFIX = ComponentUtils.SUB_SEPARATOR + "scrollPosition";
public static final String SELECTED_POSTFIX = ComponentUtils.SUB_SEPARATOR + "selected";
private static final Integer HEIGHT_0 = 0;
@Override
public void prepareRender(FacesContext facesContext, UIComponent component) throws IOException {
super.prepareRender(facesContext, component);
ensureHeader(facesContext, (UISheet) component);
}
private void ensureHeader(FacesContext facesContext, UISheet sheet) {
UIComponent header = sheet.getHeader();
if (header == null) {
header = CreateComponentUtils.createComponent(facesContext, ComponentTypes.PANEL, null, "_header");
// XXX ??? what about input, etc.?
// header.setTransient(true);
final List<AbstractUIColumn> columns = sheet.getRenderedColumns();
int i = 0;
for (AbstractUIColumn column : columns) {
final AbstractUIOut out = (AbstractUIOut) CreateComponentUtils.createComponent(
facesContext, ComponentTypes.OUT, RendererTypes.OUT, "_col" + i);
// out.setValue(column.getLabel());
out.setValue(column.getAttributes().get(Attributes.LABEL));
header.getChildren().add(out);
i++;
}
sheet.setHeader(header);
}
}
@Override
public void encodeEnd(FacesContext facesContext, UIComponent uiComponent) throws IOException {
UISheet sheet = (UISheet) uiComponent;
Style style = new Style(facesContext, sheet);
final String sheetId = sheet.getClientId(facesContext);
TobagoResponseWriter writer = HtmlRendererUtils.getTobagoResponseWriter(facesContext);
// Outer sheet div
writer.startElement(HtmlElements.DIV, sheet);
writer.writeIdAttribute(sheetId);
HtmlRendererUtils.writeDataAttributes(facesContext, writer, sheet);
writer.writeClassAttribute(Classes.create(sheet));
writer.writeStyleAttribute(style);
UIComponent facetReload = sheet.getFacet(Facets.RELOAD);
if (facetReload != null && facetReload instanceof UIReload && facetReload.isRendered()) {
UIReload update = (UIReload) facetReload;
writer.writeAttribute(DataAttributes.RELOAD, update.getFrequency());
}
writer.writeAttribute(DataAttributes.PARTIALLY,
HtmlRendererUtils.getRenderedPartiallyJavascriptArray(facesContext, sheet, sheet), false);
writer.writeAttribute(DataAttributes.SELECTION_MODE, sheet.getSelectable(), false);
writer.writeAttribute(DataAttributes.FIRST, Integer.toString(sheet.getFirst()), false);
boolean rowAction = HtmlRendererUtils.renderSheetCommands(sheet, facesContext, writer);
renderSheet(facesContext, sheet, rowAction, style);
writer.endElement(HtmlElements.DIV);
}
private void renderSheet(FacesContext facesContext, UISheet sheet, boolean hasClickAction, Style style)
throws IOException {
final TobagoResponseWriter writer = HtmlRendererUtils.getTobagoResponseWriter(facesContext);
final ResourceManager resourceManager = ResourceManagerFactory.getResourceManager(facesContext);
final String contextPath = facesContext.getExternalContext().getRequestContextPath();
final String sheetId = sheet.getClientId(facesContext);
Measure sheetHeight;
if (style.getHeight() == null) {
// FIXME: nullpointer if height not defined
LOG.error("no height in parent container, setting to 100");
sheetHeight = Measure.valueOf(100);
} else {
sheetHeight = style.getHeight();
}
final Measure footerHeight = getFooterHeight(facesContext, sheet);
final Measure headerHeight = getHeaderHeight(facesContext, sheet);
final String selectable = sheet.getSelectable();
final Application application = facesContext.getApplication();
final SheetState state = sheet.getSheetState(facesContext);
final List<Integer> columnWidths = sheet.getWidthList();
final List<Integer> selectedRows = getSelectedRows(sheet, state);
final List<AbstractUIColumn> renderedColumnList = sheet.getRenderedColumns();
writer.startElement(HtmlElements.INPUT, null);
writer.writeIdAttribute(sheetId + WIDTHS_POSTFIX);
writer.writeNameAttribute(sheetId + WIDTHS_POSTFIX);
writer.writeAttribute(HtmlAttributes.TYPE, HtmlInputTypes.HIDDEN, false);
writer.writeAttribute(HtmlAttributes.VALUE, StringUtils.joinWithSurroundingSeparator(columnWidths), false);
writer.endElement(HtmlElements.INPUT);
writer.startElement(HtmlElements.INPUT, null);
writer.writeIdAttribute(sheetId + SCROLL_POSTFIX);
writer.writeNameAttribute(sheetId + SCROLL_POSTFIX);
writer.writeAttribute(HtmlAttributes.TYPE, HtmlInputTypes.HIDDEN, false);
Integer[] scrollPosition = sheet.getScrollPosition();
if (scrollPosition != null) {
String scroll = scrollPosition[0] + ";" + scrollPosition[1];
writer.writeAttribute(HtmlAttributes.VALUE, scroll, false);
} else {
writer.writeAttribute(HtmlAttributes.VALUE, "", false);
}
writer.endElement(HtmlElements.INPUT);
if (!UISheet.NONE.equals(selectable)) {
writer.startElement(HtmlElements.INPUT, null);
writer.writeIdAttribute(sheetId + SELECTED_POSTFIX);
writer.writeNameAttribute(sheetId + SELECTED_POSTFIX);
writer.writeAttribute(HtmlAttributes.TYPE, HtmlInputTypes.HIDDEN, false);
writer.writeAttribute(
HtmlAttributes.VALUE, StringUtils.joinWithSurroundingSeparator(selectedRows), true);
writer.endElement(HtmlElements.INPUT);
}
ExpandedState expandedState = null;
StringBuilder expandedValue = null;
if (sheet.isTreeModel()) {
expandedState = sheet.getExpandedState();
expandedValue = new StringBuilder(",");
}
final boolean showHeader = sheet.isShowHeader();
final boolean ie6SelectOneFix = showHeader
&& ClientProperties.getInstance(facesContext).getUserAgent().isMsie6()
&& ComponentUtils.findDescendant(sheet, UISelectOne.class) != null;
// BEGIN RENDER BODY CONTENT
Style bodyStyle = new Style();
/*
bodyStyle.setPosition(Position.RELATIVE);
*/
Measure tableBodyWidth = sheet.getCurrentWidth().subtractNotNegative(getContentBorder(facesContext, sheet));
bodyStyle.setWidth(tableBodyWidth);
if (sheet.isPagingVisible()) {
sheetHeight = sheetHeight.subtract(footerHeight);
}
if (ie6SelectOneFix) {
bodyStyle.setTop(headerHeight);
}
if (showHeader) {
sheetHeight = sheetHeight.subtract(headerHeight);
}
bodyStyle.setHeight(sheetHeight);
if (showHeader) {
renderColumnHeaders(
facesContext, sheet, writer, resourceManager, contextPath, sheetId, renderedColumnList, tableBodyWidth);
}
writer.startElement(HtmlElements.DIV, null);
writer.writeIdAttribute(sheetId + ComponentUtils.SUB_SEPARATOR + "data_div");
writer.writeClassAttribute(Classes.create(sheet, "body"));
/*
bodyStyle.setPaddingTop(ie6SelectOneFix ? Measure.ZERO : headerHeight);
*/
writer.writeStyleAttribute(bodyStyle);
bodyStyle.setHeight(null);
bodyStyle.setTop(null);
Style sheetBodyStyle = new Style(bodyStyle);
// is null, in AJAX case.
if (sheet.getNeedVerticalScrollbar() == Boolean.TRUE) {
tableBodyWidth = tableBodyWidth.subtractNotNegative(getVerticalScrollbarWeight(facesContext, sheet));
}
sheetBodyStyle.setWidth(tableBodyWidth);
writer.startElement(HtmlElements.TABLE, null);
writer.writeAttribute(HtmlAttributes.CELLSPACING, "0", false);
writer.writeAttribute(HtmlAttributes.CELLPADDING, "0", false);
writer.writeAttribute(HtmlAttributes.SUMMARY, "", false);
writer.writeClassAttribute(Classes.create(sheet, "bodyTable"));
writer.writeStyleAttribute(sheetBodyStyle);
if (columnWidths != null) {
writer.startElement(HtmlElements.COLGROUP, null);
for (Integer columnWidth : columnWidths) {
writer.startElement(HtmlElements.COL, null);
writer.writeAttribute(HtmlAttributes.WIDTH, columnWidth);
writer.endElement(HtmlElements.COL);
}
writer.endElement(HtmlElements.COLGROUP);
}
// Print the Content
if (LOG.isDebugEnabled()) {
LOG.debug("first = " + sheet.getFirst() + " rows = " + sheet.getRows());
}
final String var = sheet.getVar();
boolean odd = false;
boolean emptySheet = true;
// rows = 0 means: show all
final int last = sheet.isRowsUnlimited() ? Integer.MAX_VALUE : sheet.getFirst() + sheet.getRows();
for (int rowIndex = sheet.getFirst(); rowIndex < last; rowIndex++) {
sheet.setRowIndex(rowIndex);
if (!sheet.isRowAvailable()) {
break;
}
Object rowRendered = sheet.getAttributes().get("rowRendered");
if (rowRendered instanceof Boolean && !((Boolean) rowRendered)) {
continue;
}
emptySheet = false;
odd = !odd;
if (LOG.isDebugEnabled()) {
LOG.debug("var " + var);
LOG.debug("list " + sheet.getValue());
}
if (sheet.isTreeModel()) {
final TreePath path = sheet.getPath();
if (sheet.isFolder() && expandedState.isExpanded(path)) {
expandedValue.append(rowIndex);
expandedValue.append(",");
}
}
writer.startElement(HtmlElements.TR, null);
if (rowRendered instanceof Boolean) {
// if rowRendered attribute is set we need the rowIndex on the client
writer.writeAttribute(DataAttributes.ROW_INDEX, rowIndex);
}
Markup rowMarkup = odd ? Markup.ODD : Markup.EVEN;
final boolean selected = selectedRows.contains(rowIndex);
if (selected) {
rowMarkup = rowMarkup.add(Markup.SELECTED);
}
String[] rowMarkups = (String[]) sheet.getAttributes().get("rowMarkup");
if (rowMarkups != null) {
rowMarkup = rowMarkup.add(Markup.valueOf(rowMarkups));
}
writer.writeClassAttribute(Classes.create(sheet, "row", rowMarkup));
if (!sheet.isRowVisible()) {
Style rowStyle = new Style();
rowStyle.setDisplay(Display.NONE);
writer.writeStyleAttribute(rowStyle);
}
final String parentId = sheet.getRowParentClientId();
if (parentId != null) {
writer.writeAttribute(DataAttributes.TREE_PARENT, parentId, false);
}
int columnIndex = -1;
for (UIColumn column : renderedColumnList) {
columnIndex++;
writer.startElement(HtmlElements.TD, column);
Markup markup = column instanceof SupportsMarkup ? ((SupportsMarkup) column).getMarkup() : Markup.NULL;
if (markup == null) {
markup = Markup.NULL;
}
if (columnIndex == 0) {
markup = markup.add(Markup.FIRST);
}
if (hasClickAction) {
markup = markup.add(Markup.CLICKABLE);
}
if (isPure(column)) {
markup = markup.add(Markup.PURE);
}
writer.writeClassAttribute(Classes.create(sheet, "cell", markup));
final TextAlign align = TextAlign.parse((String) column.getAttributes().get(Attributes.ALIGN));
if (align != null) {
Style alignStyle = new Style();
alignStyle.setTextAlign(align);
writer.writeStyleAttribute(alignStyle);
}
if (column instanceof UIColumnSelector) {
final boolean disabled = ComponentUtils.getBooleanAttribute(column, Attributes.DISABLED);
writer.startElement(HtmlElements.INPUT, null);
writer.writeAttribute(HtmlAttributes.TYPE, HtmlInputTypes.CHECKBOX, false);
writer.writeAttribute(HtmlAttributes.CHECKED, selected);
writer.writeAttribute(HtmlAttributes.DISABLED, disabled);
writer.writeIdAttribute(sheetId + "_data_row_selector_" + rowIndex);
writer.writeClassAttribute(Classes.create(sheet, "columnSelector"));
writer.endElement(HtmlElements.INPUT);
} else if (column instanceof AbstractUIColumnNode) {
RenderUtils.prepareRendererAll(facesContext, column);
RenderUtils.encode(facesContext, column);
} else {
List<UIComponent> children = sheet.getRenderedChildrenOf(column);
for (UIComponent grandKid : children) {
// set height to 0 to prevent use of layoutheight from parent
grandKid.getAttributes().put(Attributes.LAYOUT_HEIGHT, HEIGHT_0);
// XXX hotfix
if (grandKid instanceof LayoutBase) {
LayoutBase base = (LayoutBase) grandKid;
if (base.getLeft() != null) {
base.setLeft(null);
}
if (base.getTop() != null) {
base.setTop(null);
}
}
RenderUtils.prepareRendererAll(facesContext, grandKid);
RenderUtils.encode(facesContext, grandKid);
}
}
writer.endElement(HtmlElements.TD);
}
writer.startElement(HtmlElements.TD, null);
writer.writeClassAttribute(Classes.create(sheet, "cell", Markup.FILLER));
// writer.write(" ");
writer.startElement(HtmlElements.DIV, null);
writer.endElement(HtmlElements.DIV);
writer.endElement(HtmlElements.TD);
writer.endElement(HtmlElements.TR);
}
sheet.setRowIndex(-1);
if (emptySheet && showHeader) {
writer.startElement(HtmlElements.TR, null);
int columnIndex = -1;
for (UIColumn ignored : renderedColumnList) {
columnIndex++;
writer.startElement(HtmlElements.TD, null);
writer.startElement(HtmlElements.DIV, null);
Integer divWidth = sheet.getWidthList().get(columnIndex);
Style divStyle = new Style();
divStyle.setWidth(Measure.valueOf(divWidth));
writer.writeStyleAttribute(divStyle);
writer.endElement(HtmlElements.DIV);
writer.endElement(HtmlElements.TD);
}
writer.startElement(HtmlElements.TD, null);
writer.writeClassAttribute(Classes.create(sheet, "cell", Markup.FILLER));
// writer.write(" ");
writer.startElement(HtmlElements.DIV, null);
writer.endElement(HtmlElements.DIV);
writer.endElement(HtmlElements.TD);
writer.endElement(HtmlElements.TR);
}
writer.endElement(HtmlElements.TABLE);
writer.endElement(HtmlElements.DIV);
// END RENDER BODY CONTENT
if (sheet.isPagingVisible()) {
Style footerStyle = new Style();
footerStyle.setWidth(sheet.getCurrentWidth());
if (ie6SelectOneFix) {
footerStyle.setTop(headerHeight);
}
writer.startElement(HtmlElements.DIV, sheet);
writer.writeClassAttribute(Classes.create(sheet, "footer"));
writer.writeStyleAttribute(footerStyle);
// show row range
final Markup showRowRange = markupForLeftCenterRight(sheet.getShowRowRange());
if (showRowRange != Markup.NULL) {
UICommand pagerCommand = (UICommand) sheet.getFacet(Facets.PAGER_ROW);
if (pagerCommand == null) {
pagerCommand = createPagingCommand(application, PageAction.TO_ROW, false);
sheet.getFacets().put(Facets.PAGER_ROW, pagerCommand);
}
final String pagerCommandId = pagerCommand.getClientId(facesContext);
writer.startElement(HtmlElements.SPAN, null);
writer.writeClassAttribute(Classes.create(sheet, "pagingOuter", showRowRange));
writer.writeAttribute(HtmlAttributes.TITLE,
ResourceManagerUtils.getPropertyNotNull(facesContext, "tobago", "sheetPagingInfoRowPagingTip"), true);
writer.flush(); // is needed in some cases, e. g. TOBAGO-1094
writer.write(createSheetPagingInfo(sheet, facesContext, pagerCommandId, true));
writer.endElement(HtmlElements.SPAN);
}
// show direct links
final Markup showDirectLinks = markupForLeftCenterRight(sheet.getShowDirectLinks());
if (showDirectLinks != Markup.NULL) {
writer.startElement(HtmlElements.SPAN, null);
writer.writeClassAttribute(Classes.create(sheet, "pagingOuter", showDirectLinks));
writer.writeIdAttribute(sheetId + ComponentUtils.SUB_SEPARATOR + "pagingLinks");
writeDirectPagingLinks(writer, facesContext, application, sheet);
writer.endElement(HtmlElements.SPAN);
}
// show page range
final Markup showPageRange = markupForLeftCenterRight(sheet.getShowPageRange());
if (showPageRange != Markup.NULL) {
UICommand pagerCommand = (UICommand) sheet.getFacet(Facets.PAGER_PAGE);
if (pagerCommand == null) {
pagerCommand = createPagingCommand(application, PageAction.TO_PAGE, false);
sheet.getFacets().put(Facets.PAGER_PAGE, pagerCommand);
}
final String pagerCommandId = pagerCommand.getClientId(facesContext);
writer.startElement(HtmlElements.SPAN, null);
writer.writeClassAttribute(Classes.create(sheet, "pagingOuter", showPageRange));
writer.writeIdAttribute(sheetId + ComponentUtils.SUB_SEPARATOR + "pagingPages");
writer.writeText("");
boolean atBeginning = sheet.isAtBeginning();
link(facesContext, application, atBeginning, PageAction.FIRST, sheet);
link(facesContext, application, atBeginning, PageAction.PREV, sheet);
writer.startElement(HtmlElements.SPAN, null);
writer.writeClassAttribute(Classes.create(sheet, "pagingText"));
writer.writeAttribute(HtmlAttributes.TITLE,
ResourceManagerUtils.getPropertyNotNull(facesContext, "tobago", "sheetPagingInfoPagePagingTip"), true);
writer.flush(); // is needed in some cases, e. g. TOBAGO-1094
writer.write(createSheetPagingInfo(sheet, facesContext, pagerCommandId, false));
writer.endElement(HtmlElements.SPAN);
boolean atEnd = sheet.isAtEnd();
link(facesContext, application, atEnd, PageAction.NEXT, sheet);
link(facesContext, application, atEnd || !sheet.hasRowCount(), PageAction.LAST, sheet);
writer.endElement(HtmlElements.SPAN);
}
writer.endElement(HtmlElements.DIV);
}
if (sheet.isTreeModel()) {
writer.startElement(HtmlElements.INPUT, sheet);
writer.writeAttribute(HtmlAttributes.TYPE, HtmlInputTypes.HIDDEN, false);
final String expandedId = sheetId + ComponentUtils.SUB_SEPARATOR + AbstractUIData.SUFFIX_EXPANDED;
writer.writeNameAttribute(expandedId);
writer.writeIdAttribute(expandedId);
writer.writeClassAttribute(Classes.create(sheet, AbstractUIData.SUFFIX_EXPANDED));
writer.writeAttribute(HtmlAttributes.VALUE, expandedValue.toString(), false);
writer.endElement(HtmlElements.INPUT);
}
}
/**
* Differ between simple content and complex content.
* Decide if the content of a cell needs usually the whole possible space or
* is the character of the content like flowing text.
* In the second case, the style usually sets a padding.<br/>
* Pure is needed for <tc:panel>, <tc:in>, etc.<br/>
* Pure is not needed for <tc:out> and <tc:link>
*/
private boolean isPure(UIColumn column) {
for (UIComponent child : column.getChildren()) {
if (!(child instanceof UIOut) && !(child instanceof UILink)) {
return true;
}
}
return false;
}
private String createSheetPagingInfo(UISheet sheet, FacesContext facesContext, String pagerCommandId, boolean row) {
String sheetPagingInfo;
if (sheet.getRowCount() != 0) {
Locale locale = facesContext.getViewRoot().getLocale();
int first = row ? sheet.getFirst() + 1 : sheet.getCurrentPage() + 1;
int last = sheet.hasRowCount()
? row ? sheet.getLastRowIndexOfCurrentPage() : sheet.getPages()
: -1;
final boolean unknown = !sheet.hasRowCount();
final String key = "sheetPagingInfo"
+ (unknown ? "Undefined" : "")
+ (first == last ? "Single" : "")
+ (row ? "Row" : "Page")
+ (first == last ? "" : "s"); // plural
final String message = ResourceManagerUtils.getPropertyNotNull(facesContext, "tobago", key);
final MessageFormat detail = new MessageFormat(message, locale);
Object[] args = {
first,
last == -1 ? "?" : last,
unknown ? "" : sheet.getRowCount(),
pagerCommandId + ComponentUtils.SUB_SEPARATOR + "text"
};
sheetPagingInfo = detail.format(args);
} else {
sheetPagingInfo =
ResourceManagerUtils.getPropertyNotNull(facesContext, "tobago",
"sheetPagingInfoEmpty" + (row ? "Row" : "Page"));
}
return sheetPagingInfo;
}
@Override
public void decode(FacesContext facesContext, UIComponent component) {
super.decode(facesContext, component);
UISheet sheet = (UISheet) component;
String key = sheet.getClientId(facesContext) + WIDTHS_POSTFIX;
Map requestParameterMap = facesContext.getExternalContext().getRequestParameterMap();
if (requestParameterMap.containsKey(key)) {
String widths = (String) requestParameterMap.get(key);
if (widths.trim().length() > 0) {
sheet.getAttributes().put(Attributes.WIDTH_LIST_STRING, widths);
}
}
key = sheet.getClientId(facesContext) + SELECTED_POSTFIX;
if (requestParameterMap.containsKey(key)) {
String selected = (String) requestParameterMap.get(key);
if (LOG.isDebugEnabled()) {
LOG.debug("selected = " + selected);
}
List<Integer> selectedRows;
try {
selectedRows = StringUtils.parseIntegerList(selected);
} catch (NumberFormatException e) {
LOG.warn(selected, e);
selectedRows = Collections.emptyList();
}
sheet.getAttributes().put(Attributes.SELECTED_LIST_STRING, selectedRows);
}
key = sheet.getClientId(facesContext) + SCROLL_POSTFIX;
String value = (String) requestParameterMap.get(key);
if (value != null) {
Integer[] scrollPosition = SheetState.parseScrollPosition(value);
if (scrollPosition != null) {
//noinspection unchecked
sheet.getAttributes().put(Attributes.SCROLL_POSITION, scrollPosition);
}
}
RenderUtils.decodedStateOfTreeData(facesContext, sheet);
}
private Measure getHeaderHeight(FacesContext facesContext, UISheet sheet) {
int rows = sheet.getHeaderGrid() != null ? sheet.getHeaderGrid().getRowCount() : 0;
return sheet.isShowHeader()
? getResourceManager().getThemeMeasure(facesContext, sheet, "headerHeight").multiply(rows)
: Measure.ZERO;
}
private Measure getRowHeight(FacesContext facesContext, UISheet sheet) {
return getResourceManager().getThemeMeasure(facesContext, sheet, "rowHeight");
}
private Measure getFooterHeight(FacesContext facesContext, UISheet sheet) {
return sheet.isPagingVisible()
? getResourceManager().getThemeMeasure(facesContext, sheet, "footerHeight")
: Measure.ZERO;
}
private Markup markupForLeftCenterRight(String name) {
if ("left".equals(name)) {
return Markup.LEFT;
}
if ("center".equals(name)) {
return Markup.CENTER;
}
if ("right".equals(name)) {
return Markup.RIGHT;
}
return Markup.NULL;
}
private String checkPagingAttribute(String name) {
if (isNotNone(name)) {
return name;
} else {
if (!"none".equals(name)) {
LOG.warn("Illegal value in sheets paging attribute: '" + name + "'");
}
return "none";
}
}
private boolean isNotNone(String value) {
// todo: use enum type instead of string
return "left".equals(value) || "center".equals(value) || "right".equals(value);
}
@Override
public boolean getRendersChildren() {
return true;
}
private List<Integer> getSelectedRows(UISheet data, SheetState state) {
List<Integer> selected = (List<Integer>)
data.getAttributes().get(Attributes.SELECTED_LIST_STRING);
if (selected == null && state != null) {
selected = state.getSelectedRows();
}
if (selected == null) {
selected = Collections.emptyList();
}
return selected;
}
private void link(FacesContext facesContext, Application application,
boolean disabled, PageAction command, UISheet data)
throws IOException {
UICommand link = createPagingCommand(application, command, disabled);
data.getFacets().put(command.getToken(), link);
String tip = ResourceManagerUtils.getPropertyNotNull(facesContext, "tobago",
"sheet" + command.getToken());
String image = ResourceManagerUtils.getImageWithPath(facesContext,
"image/sheet" + command.getToken() + (disabled ? "Disabled" : "") + ".gif");
TobagoResponseWriter writer = HtmlRendererUtils.getTobagoResponseWriter(facesContext);
writer.startElement(HtmlElements.IMG, null);
writer.writeIdAttribute(data.getClientId(facesContext)
+ ComponentUtils.SUB_SEPARATOR + "pagingPages" + ComponentUtils.SUB_SEPARATOR + command.getToken());
Classes pagerClasses = Classes.create(data, "footerPagerButton", disabled ? Markup.DISABLED : null);
writer.writeClassAttribute(pagerClasses);
writer.writeAttribute(HtmlAttributes.SRC, image, false);
writer.writeAttribute(HtmlAttributes.TITLE, tip, true);
writer.writeAttribute(HtmlAttributes.ALT, "", false);
writer.writeAttribute(DataAttributes.DISABLED, disabled);
writer.endElement(HtmlElements.IMG);
}
// TODO sheet.getColumnLayout() liefert ggf. eine falsche Anzahl von Spalten
// TODO
// TODO
private void renderColumnHeaders(
FacesContext facesContext, UISheet sheet, TobagoResponseWriter writer, ResourceManager resourceManager,
String contextPath, String sheetId, List<AbstractUIColumn> renderedColumnList, Measure headerWidth)
throws IOException {
final Grid grid = sheet.getHeaderGrid();
final List<Integer> columnWidths = sheet.getWidthList();
if (LOG.isDebugEnabled()) {
LOG.debug("*****************************************************");
LOG.debug("" + grid);
LOG.debug("*****************************************************");
}
writer.startElement(HtmlElements.DIV, sheet);
writer.writeClassAttribute(Classes.create(sheet, "headerDiv"));
writer.startElement(HtmlElements.TABLE, sheet);
writer.writeAttribute(HtmlAttributes.CELLSPACING, "0", false);
writer.writeAttribute(HtmlAttributes.CELLPADDING, "0", false);
writer.writeAttribute(HtmlAttributes.SUMMARY, "", false);
writer.writeClassAttribute(Classes.create(sheet, "headerTable"));
if (columnWidths != null) {
writer.startElement(HtmlElements.COLGROUP, null);
for (Integer columnWidth : columnWidths) {
writer.startElement(HtmlElements.COL, null);
writer.writeAttribute(HtmlAttributes.WIDTH, columnWidth);
writer.endElement(HtmlElements.COL);
}
writer.endElement(HtmlElements.COLGROUP);
}
writer.startElement(HtmlElements.TBODY, sheet);
for (int i = 0; i < grid.getRowCount(); i++) {
writer.startElement(HtmlElements.TR, null);
for (int j = 0; j < grid.getColumnCount(); j++) {
final Cell cell = grid.getCell(j, i);
if (cell instanceof OriginCell) {
writer.startElement(HtmlElements.TD, null);
if (cell.getColumnSpan() > 1) {
writer.writeAttribute(HtmlAttributes.COLSPAN, cell.getColumnSpan());
}
if (cell.getRowSpan() > 1) {
writer.writeAttribute(HtmlAttributes.ROWSPAN, cell.getRowSpan());
}
final UIComponent cellComponent = (UIComponent) cell.getComponent();
final boolean pure = !(cellComponent instanceof UIOut);
writer.startElement(HtmlElements.DIV, null);
writer.writeClassAttribute(Classes.create(sheet, "headerCell"));
writer.startElement(HtmlElements.SPAN, null);
Style headerStyle = new Style();
Measure headerHeight = Measure.valueOf(20).multiply(cell.getRowSpan());
if (!pure) {
headerHeight = headerHeight.subtract(6); // XXX todo
}
headerStyle.setHeight(headerHeight);
writer.writeStyleAttribute(headerStyle);
final AbstractUIColumn column = renderedColumnList.get(j);
String sorterImage = null;
Markup markup = Markup.NULL;
String tip = (String) column.getAttributes().get(Attributes.TIP);
if (cell.getColumnSpan() == 1) {
final boolean sortable = ComponentUtils.getBooleanAttribute(column, Attributes.SORTABLE);
if (sortable) {
UICommand sortCommand = (UICommand) column.getFacet(Facets.SORTER);
if (sortCommand == null) {
final String columnId = column.getClientId(facesContext);
final String sorterId = columnId.substring(columnId.lastIndexOf(":") + 1) + "_" + UISheet.SORTER_ID;
sortCommand = (UICommand) CreateComponentUtils.createComponent(
facesContext, UICommand.COMPONENT_TYPE, RendererTypes.LINK, sorterId);
column.getFacets().put(Facets.SORTER, sortCommand);
}
final CommandMap map = new CommandMap();
final Command click = new Command(sortCommand.getClientId(facesContext),
null, null, null, new String[]{sheet.getClientId(facesContext)}, null, null, null, null, null);
map.setClick(click);
writer.writeAttribute(DataAttributes.COMMANDS, JsonUtils.encode(map), true);
if (tip == null) {
tip = "";
} else {
tip += " - ";
}
tip += ResourceManagerUtils.getPropertyNotNull(facesContext, "tobago", "sheetTipSorting");
markup = markup.add(Markup.SORTABLE);
SheetState sheetState = sheet.getSheetState(facesContext);
if (column.getId().equals(sheetState.getSortedColumnId())) {
String sortTitle;
if (sheetState.isAscending()) {
sorterImage = contextPath + resourceManager.getImage(facesContext, "image/ascending.gif");
sortTitle = ResourceManagerUtils.getPropertyNotNull(facesContext, "tobago", "sheetAscending");
markup = markup.add(Markup.ASCENDING);
} else {
sorterImage = contextPath + resourceManager.getImage(facesContext, "image/descending.gif");
sortTitle = ResourceManagerUtils.getPropertyNotNull(facesContext, "tobago", "sheetDescending");
markup = markup.add(Markup.DESCENDING);
}
if (sortTitle != null) {
tip += " - " + sortTitle;
}
}
}
}
if (j == 0) {
markup = markup.add(Markup.FIRST);
}
if (pure) {
markup = markup.add(Markup.PURE);
}
writer.writeClassAttribute(Classes.create(sheet, "header", markup));
writer.writeAttribute(HtmlAttributes.TITLE, tip, true);
if (column instanceof UIColumnSelector) {
renderColumnSelectorHeader(facesContext, writer, sheet);
} else {
RenderUtils.encode(facesContext, cellComponent);
AbstractUIMenu dropDownMenu = FacetUtils.getDropDownMenu(column);
// render sub menu popup button
if (dropDownMenu != null && dropDownMenu.isRendered()) {
writer.startElement(HtmlElements.SPAN, column);
writer.writeClassAttribute(Classes.create(column, "menu"));
writer.startElement(HtmlElements.IMG, column);
String menuImage = ResourceManagerUtils.getImageWithPath(facesContext, "image/sheetSelectorMenu.gif");
writer.writeAttribute(HtmlAttributes.TITLE, "", false);
writer.writeAttribute(HtmlAttributes.SRC, menuImage, false);
writer.endElement(HtmlElements.IMG);
ToolBarRendererBase.renderDropDownMenu(facesContext, writer, dropDownMenu);
writer.endElement(HtmlElements.SPAN);
}
}
if (sorterImage != null) {
writer.startElement(HtmlElements.IMG, null);
writer.writeAttribute(HtmlAttributes.SRC, sorterImage, false);
writer.writeAttribute(HtmlAttributes.ALT, "", false);
writer.endElement(HtmlElements.IMG);
}
writer.endElement(HtmlElements.SPAN);
if (renderedColumnList.get(j).isResizable()) {
encodeResizing(writer, sheet, j + cell.getColumnSpan() - 1);
}
writer.endElement(HtmlElements.DIV);
writer.endElement(HtmlElements.TD);
}
}
// add a filler column
writer.startElement(HtmlElements.TD, null);
writer.startElement(HtmlElements.DIV, null);
// todo: is the filler class needed here?
writer.writeClassAttribute(Classes.create(sheet, "headerCell", Markup.FILLER));
writer.endElement(HtmlElements.DIV);
writer.endElement(HtmlElements.TD);
writer.endElement(HtmlElements.TR);
}
writer.endElement(HtmlElements.TBODY);
writer.endElement(HtmlElements.TABLE);
writer.endElement(HtmlElements.DIV);
}
private void encodeResizing(TobagoResponseWriter writer, AbstractUISheet sheet, int columnIndex) throws IOException {
writer.startElement(HtmlElements.SPAN, null);
writer.writeClassAttribute(Classes.create(sheet, "headerResize"));
writer.writeAttribute(DataAttributes.COLUMN_INDEX, Integer.toString(columnIndex), false);
writer.write(" "); // is needed for IE
writer.endElement(HtmlElements.SPAN);
}
protected void renderColumnSelectorHeader(
FacesContext facesContext, TobagoResponseWriter writer, UISheet sheet)
throws IOException {
final UIToolBar toolBar = createToolBar(facesContext, sheet);
writer.startElement(HtmlElements.DIV, null);
writer.writeClassAttribute(Classes.create(sheet, "toolBar"));
if (UISheet.MULTI.equals(sheet.getSelectable())) {
RenderUtils.prepareRendererAll(facesContext, toolBar);
RenderUtils.encode(facesContext, toolBar);
}
writer.endElement(HtmlElements.DIV);
}
private UIToolBar createToolBar(FacesContext facesContext, UISheet sheet) {
final Application application = facesContext.getApplication();
final UICommand dropDown = (UICommand) CreateComponentUtils.createComponent(
facesContext, UICommand.COMPONENT_TYPE, null, "dropDown");
final UIMenu menu = (UIMenu) CreateComponentUtils.createComponent(
facesContext, UIMenu.COMPONENT_TYPE, RendererTypes.MENU, "menu");
FacetUtils.setDropDownMenu(dropDown, menu);
final String sheetId = sheet.getClientId(facesContext);
createMenuItem(facesContext, menu, "sheetMenuSelect", Markup.SHEET_SELECT_ALL, sheetId);
createMenuItem(facesContext, menu, "sheetMenuUnselect", Markup.SHEET_DESELECT_ALL, sheetId);
createMenuItem(facesContext, menu, "sheetMenuToggleselect", Markup.SHEET_TOGGLE_ALL, sheetId);
final UIToolBar toolBar = (UIToolBar) application.createComponent(UIToolBar.COMPONENT_TYPE);
toolBar.setId(facesContext.getViewRoot().createUniqueId());
toolBar.setRendererType("TabGroupToolBar");
toolBar.setTransient(true);
toolBar.getChildren().add(dropDown);
sheet.getFacets().put(Facets.TOOL_BAR, toolBar);
return toolBar;
}
private void createMenuItem(
final FacesContext facesContext, UIMenu menu, String label, Markup markup, String sheetId) {
final String id = markup.toString();
final UIMenuCommand menuItem = (UIMenuCommand) CreateComponentUtils.createComponent(
facesContext, UIMenuCommand.COMPONENT_TYPE, RendererTypes.MENU_COMMAND, id);
menuItem.setLabel(ResourceManagerUtils.getPropertyNotNull(facesContext, "tobago", label));
menuItem.setMarkup(markup);
menuItem.setOnclick("/**/"); // XXX avoid submit
ComponentUtils.putDataAttributeWithPrefix(menuItem, DataAttributes.SHEET_ID, sheetId);
menu.getChildren().add(menuItem);
}
private void writeDirectPagingLinks(
TobagoResponseWriter writer, FacesContext facesContext, Application application, UISheet sheet)
throws IOException {
UICommand pagerCommand = (UICommand) sheet.getFacet(Facets.PAGER_PAGE);
if (pagerCommand == null) {
pagerCommand = createPagingCommand(application, PageAction.TO_PAGE, false);
sheet.getFacets().put(Facets.PAGER_PAGE, pagerCommand);
}
String pagerCommandId = pagerCommand.getClientId(facesContext);
int linkCount = ComponentUtils.getIntAttribute(sheet, Attributes.DIRECT_LINK_COUNT);
linkCount--; // current page needs no link
ArrayList<Integer> prevs = new ArrayList<Integer>(linkCount);
int page = sheet.getCurrentPage() + 1;
for (int i = 0; i < linkCount && page > 1; i++) {
page--;
if (page > 0) {
prevs.add(0, page);
}
}
ArrayList<Integer> nexts = new ArrayList<Integer>(linkCount);
page = sheet.getCurrentPage() + 1;
final int pages = sheet.hasRowCount() || sheet.isRowsUnlimited() ? sheet.getPages() : Integer.MAX_VALUE;
for (int i = 0; i < linkCount && page < pages; i++) {
page++;
if (page > 1) {
nexts.add(page);
}
}
if (prevs.size() > (linkCount / 2)
&& nexts.size() > (linkCount - (linkCount / 2))) {
while (prevs.size() > (linkCount / 2)) {
prevs.remove(0);
}
while (nexts.size() > (linkCount - (linkCount / 2))) {
nexts.remove(nexts.size() - 1);
}
} else if (prevs.size() <= (linkCount / 2)) {
while (prevs.size() + nexts.size() > linkCount) {
nexts.remove(nexts.size() - 1);
}
} else {
while (prevs.size() + nexts.size() > linkCount) {
prevs.remove(0);
}
}
String name;
int skip = prevs.size() > 0 ? prevs.get(0) : 1;
if (skip > 1) {
skip -= (linkCount - (linkCount / 2));
skip--;
name = "...";
if (skip < 1) {
skip = 1;
if (prevs.get(0) == 2) {
name = "1";
}
}
writeLinkElement(writer, sheet, name, Integer.toString(skip), pagerCommandId, true);
}
for (Integer prev : prevs) {
name = prev.toString();
writeLinkElement(writer, sheet, name, name, pagerCommandId, true);
}
name = Integer.toString(sheet.getCurrentPage() + 1);
writeLinkElement(writer, sheet, name, name, pagerCommandId, false);
for (Integer next : nexts) {
name = next.toString();
writeLinkElement(writer, sheet, name, name, pagerCommandId, true);
}
skip = nexts.size() > 0 ? nexts.get(nexts.size() - 1) : pages;
if (skip < pages) {
skip += linkCount / 2;
skip++;
name = "...";
if (skip > pages) {
skip = pages;
if ((nexts.get(nexts.size() - 1)) == skip - 1) {
name = Integer.toString(skip);
}
}
writeLinkElement(writer, sheet, name, Integer.toString(skip), pagerCommandId, true);
}
}
private UICommand createPagingCommand(Application application, PageAction command, boolean disabled) {
UICommand link;
link = (UICommand) application.createComponent(UICommand.COMPONENT_TYPE);
link.setRendererType(RendererTypes.SHEET_PAGE_COMMAND);
link.setRendered(true);
link.setId(command.getToken());
link.getAttributes().put(Attributes.INLINE, Boolean.TRUE);
link.getAttributes().put(Attributes.DISABLED, disabled);
return link;
}
private void writeLinkElement(
TobagoResponseWriter writer, UISheet sheet, String str, String skip, String id, boolean makeLink)
throws IOException {
String type = makeLink ? HtmlElements.A : HtmlElements.SPAN;
writer.startElement(type, null);
writer.writeClassAttribute(Classes.create(sheet, "pagingLink"));
if (makeLink) {
writer.writeIdAttribute(id + ComponentUtils.SUB_SEPARATOR + "link_" + skip);
writer.writeAttribute(HtmlAttributes.HREF, "#", true);
}
writer.flush();
writer.write(str);
writer.endElement(type);
}
private Measure getContentBorder(FacesContext facesContext, UISheet data) {
return getBorderLeft(facesContext, data).add(getBorderRight(facesContext, data));
}
@Override
public Measure getPreferredHeight(FacesContext facesContext, Configurable component) {
final UISheet sheet = (UISheet) component;
final Measure headerHeight = getHeaderHeight(facesContext, sheet);
final Measure rowHeight = getRowHeight(facesContext, sheet);
final Measure footerHeight = getFooterHeight(facesContext, sheet);
int rows = sheet.getRows();
if (rows == 0) {
rows = sheet.getRowCount();
}
if (rows == -1) {
rows = 10; // estimating something to get a valid value...
}
if (LOG.isDebugEnabled()) {
LOG.debug(headerHeight + " " + footerHeight + " " + rowHeight + " " + rows);
}
return headerHeight.add(rowHeight.multiply(rows)).add(footerHeight);
}
@Override
public void encodeChildren(FacesContext context, UIComponent component) throws IOException {
// DO Nothing
}
@Override
public boolean getPrepareRendersChildren() {
return true;
}
@Override
public void prepareRendersChildren(FacesContext facesContext, UIComponent component) throws IOException {
UISheet sheet = (UISheet) component;
for (UIColumn column : sheet.getRenderedColumns()) {
RenderUtils.prepareRendererAll(facesContext, column);
}
}
}