nextapp.echo2.webcontainer.syncpeer.GridPeer Maven / Gradle / Ivy
Show all versions of ibis-echo2 Show documentation
/*
* This file is part of the Echo Web Application Framework (hereinafter "Echo").
* Copyright (C) 2002-2009 NextApp, Inc.
*
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*/
package nextapp.echo2.webcontainer.syncpeer;
import java.util.HashSet;
import java.util.Set;
import org.w3c.dom.Document;
import org.w3c.dom.DocumentFragment;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import nextapp.echo2.app.Border;
import nextapp.echo2.app.Component;
import nextapp.echo2.app.Extent;
import nextapp.echo2.app.Grid;
import nextapp.echo2.app.ImageReference;
import nextapp.echo2.app.Insets;
import nextapp.echo2.app.LayoutData;
import nextapp.echo2.app.layout.GridLayoutData;
import nextapp.echo2.app.update.ServerComponentUpdate;
import nextapp.echo2.webcontainer.ContainerInstance;
import nextapp.echo2.webcontainer.DomUpdateSupport;
import nextapp.echo2.webcontainer.RenderContext;
import nextapp.echo2.webcontainer.ComponentSynchronizePeer;
import nextapp.echo2.webcontainer.SynchronizePeerFactory;
import nextapp.echo2.webcontainer.image.ImageRenderSupport;
import nextapp.echo2.webcontainer.propertyrender.BorderRender;
import nextapp.echo2.webcontainer.propertyrender.CellLayoutDataRender;
import nextapp.echo2.webcontainer.propertyrender.ColorRender;
import nextapp.echo2.webcontainer.propertyrender.ExtentRender;
import nextapp.echo2.webcontainer.propertyrender.FontRender;
import nextapp.echo2.webcontainer.propertyrender.InsetsRender;
import nextapp.echo2.webrender.ClientProperties;
import nextapp.echo2.webrender.output.CssStyle;
import nextapp.echo2.webrender.servermessage.DomUpdate;
/**
* Synchronization peer for nextapp.echo2.app.Grid components.
*
* This class should not be extended or used by classes outside of the
* Echo framework.
*/
public class GridPeer
implements ComponentSynchronizePeer, DomUpdateSupport, ImageRenderSupport {
/**
* A string of periods used for the IE 100% Table Width workaround.
*/
private static final String SIZING_DOTS = ". . . . . . . . . . . . . . . . . . . . . . . . . . . . . "
+ ". . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ";
/**
* @see nextapp.echo2.webcontainer.ComponentSynchronizePeer#getContainerId(nextapp.echo2.app.Component)
*/
public String getContainerId(Component child) {
return ContainerInstance.getElementId(child.getParent()) + "_td_"
+ ContainerInstance.getElementId(child);
}
/**
* @see nextapp.echo2.webcontainer.image.ImageRenderSupport#getImage(nextapp.echo2.app.Component, java.lang.String)
*/
public ImageReference getImage(Component component, String imageId) {
// Only source of ImageReferences from this component are CellLayoutData background images:
// Delegate work to CellLayoutDataRender convenience method.
return CellLayoutDataRender.getCellLayoutDataBackgroundImage(component, imageId);
}
/**
* Returns the GridLayoutData of the given child,
* or null if it does not provide layout data.
*
* @param child the child component
* @return the layout data
* @throws java.lang.RuntimeException if the the provided
* LayoutData is not a GridLayoutData
*/
private GridLayoutData getLayoutData(Component child) {
LayoutData layoutData = (LayoutData) child.getRenderProperty(Component.PROPERTY_LAYOUT_DATA);
if (layoutData == null) {
return null;
} else if (layoutData instanceof GridLayoutData) {
return (GridLayoutData) layoutData;
} else {
throw new RuntimeException("Invalid LayoutData for Grid Child: " + layoutData.getClass().getName());
}
}
/**
* @see nextapp.echo2.webcontainer.ComponentSynchronizePeer#renderAdd(nextapp.echo2.webcontainer.RenderContext,
* nextapp.echo2.app.update.ServerComponentUpdate, java.lang.String, nextapp.echo2.app.Component)
*/
public void renderAdd(RenderContext rc, ServerComponentUpdate update, String targetId, Component component) {
Element domAddElement = DomUpdate.renderElementAdd(rc.getServerMessage());
DocumentFragment htmlFragment = rc.getServerMessage().getDocument().createDocumentFragment();
renderHtml(rc, update, htmlFragment, component);
DomUpdate.renderElementAddContent(rc.getServerMessage(), domAddElement, targetId, htmlFragment);
}
/**
* Renders a child component.
*
* @param rc the relevant RenderContext
* @param update the update
* @param parentElement the HTML element which should contain the child
* @param child the child component to render
*/
private void renderAddChild(RenderContext rc, ServerComponentUpdate update, Element parentElement, Component child) {
ComponentSynchronizePeer syncPeer = SynchronizePeerFactory.getPeerForComponent(child.getClass());
if (syncPeer instanceof DomUpdateSupport) {
((DomUpdateSupport) syncPeer).renderHtml(rc, update, parentElement, child);
} else {
syncPeer.renderAdd(rc, update, getContainerId(child), child);
}
}
/**
* @see nextapp.echo2.webcontainer.ComponentSynchronizePeer#renderDispose(nextapp.echo2.webcontainer.RenderContext,
* nextapp.echo2.app.update.ServerComponentUpdate, nextapp.echo2.app.Component)
*/
public void renderDispose(RenderContext rc, ServerComponentUpdate update, Component component) { }
/**
* @see nextapp.echo2.webcontainer.DomUpdateSupport#renderHtml(nextapp.echo2.webcontainer.RenderContext,
* nextapp.echo2.app.update.ServerComponentUpdate, org.w3c.dom.Node, nextapp.echo2.app.Component)
*/
public void renderHtml(RenderContext rc, ServerComponentUpdate update, Node parentNode, Component component) {
Document document = parentNode.getOwnerDocument();
Grid grid = (Grid) component;
Border border = (Border) grid.getRenderProperty(Grid.PROPERTY_BORDER);
String elementId = ContainerInstance.getElementId(grid);
GridProcessor gridProcessor = new GridProcessor(grid);
int columnCount = gridProcessor.getColumnCount();
int rowCount = gridProcessor.getRowCount();
Element tableElement = document.createElement("table");
tableElement.setAttribute("id", elementId);
CssStyle tableCssStyle = new CssStyle();
tableCssStyle.setAttribute("border-collapse", "collapse");
Insets gridInsets = (Insets) grid.getRenderProperty(Grid.PROPERTY_INSETS);
String defaultInsetsAttributeValue = gridInsets == null
? "0px" : InsetsRender.renderCssAttributeValue(gridInsets);
ColorRender.renderToStyle(tableCssStyle, component);
FontRender.renderToStyle(tableCssStyle, component);
BorderRender.renderToStyle(tableCssStyle, border);
ExtentRender.renderToStyle(tableCssStyle, "height", (Extent) grid.getRenderProperty(Grid.PROPERTY_HEIGHT));
Extent width = (Extent) grid.getRenderProperty(Grid.PROPERTY_WIDTH);
boolean render100PercentWidthWorkaround = false;
if (rc.getContainerInstance().getClientProperties().getBoolean(
ClientProperties.QUIRK_IE_TABLE_PERCENT_WIDTH_SCROLLBAR_ERROR)) {
if (width != null && width.getUnits() == Extent.PERCENT && width.getValue() == 100) {
width = null;
render100PercentWidthWorkaround = true;
}
}
ExtentRender.renderToStyle(tableCssStyle, "width", width);
Extent borderSize = border == null ? null : border.getSize();
if (borderSize != null) {
if (!rc.getContainerInstance().getClientProperties().getBoolean(ClientProperties.QUIRK_CSS_BORDER_COLLAPSE_INSIDE)) {
tableCssStyle.setAttribute("margin", ExtentRender.renderCssAttributeValueHalf(borderSize));
}
}
tableElement.setAttribute("style", tableCssStyle.renderInline());
parentNode.appendChild(tableElement);
boolean someColumnsHaveWidths = false;
for (int i = 0; i < columnCount; ++i) {
if (gridProcessor.getColumnWidth(i) != null) {
someColumnsHaveWidths = true;
}
}
if (someColumnsHaveWidths) {
Element colGroupElement = document.createElement("colgroup");
tableElement.appendChild(colGroupElement);
for (int i = 0; i < columnCount; ++i) {
Element colElement = document.createElement("col");
Extent columnWidth = gridProcessor.getColumnWidth(i);
if (columnWidth != null) {
colElement.setAttribute("style", "width:" + ExtentRender.renderCssAttributeValue(columnWidth));
}
colGroupElement.appendChild(colElement);
}
}
Element tbodyElement = document.createElement("tbody");
tbodyElement.setAttribute("id", elementId + "_tbody");
tableElement.appendChild(tbodyElement);
Set renderedCells = new HashSet();
for (int rowIndex = 0; rowIndex < rowCount; ++rowIndex) {
Element trElement = document.createElement("tr");
trElement.setAttribute("id", elementId + "_tr_" + rowIndex);
if (gridProcessor.getRowHeight(rowIndex) != null) {
trElement.setAttribute("style", "height:" + ExtentRender.renderCssAttributeValue(gridProcessor.getRowHeight(rowIndex)));
}
tbodyElement.appendChild(trElement);
for (int columnIndex = 0; columnIndex < columnCount; ++columnIndex) {
Component cell = gridProcessor.getContent(columnIndex, rowIndex);
if (cell == null) {
Element tdElement = document.createElement("td");
trElement.appendChild(tdElement);
continue;
}
if (renderedCells.contains(cell)) {
// Cell already rendered.
continue;
}
renderedCells.add(cell);
Element tdElement = document.createElement("td");
tdElement.setAttribute("id", elementId + "_td_" + ContainerInstance.getElementId(cell));
trElement.appendChild(tdElement);
int columnSpan = gridProcessor.getColumnSpan(columnIndex, rowIndex);
if (columnSpan > 1) {
tdElement.setAttribute("colspan", Integer.toString(columnSpan));
}
int rowSpan = gridProcessor.getRowSpan(columnIndex, rowIndex);
if (rowSpan > 1) {
tdElement.setAttribute("rowspan", Integer.toString(rowSpan));
}
CssStyle tdCssStyle = new CssStyle();
BorderRender.renderToStyle(tdCssStyle, (Border) grid.getRenderProperty(Grid.PROPERTY_BORDER));
CellLayoutDataRender.renderToElementAndStyle(tdElement, tdCssStyle, cell, getLayoutData(cell),
defaultInsetsAttributeValue);
CellLayoutDataRender.renderBackgroundImageToStyle(tdCssStyle, rc, this, grid, cell);
tdElement.setAttribute("style", tdCssStyle.renderInline());
if (rowIndex == 0 && render100PercentWidthWorkaround) {
// Render string of "sizing dots" in first cell.
Element sizingDivElement = document.createElement("div");
sizingDivElement.setAttribute("style", "font-size:50px;height:0px;overflow:hidden;");
sizingDivElement.appendChild(document.createTextNode(SIZING_DOTS));
tdElement.appendChild(sizingDivElement);
}
renderAddChild(rc, update, tdElement, cell);
}
}
}
/**
* @see nextapp.echo2.webcontainer.ComponentSynchronizePeer#renderUpdate(nextapp.echo2.webcontainer.RenderContext,
* nextapp.echo2.app.update.ServerComponentUpdate, java.lang.String)
*/
public boolean renderUpdate(RenderContext rc, ServerComponentUpdate update, String targetId) {
String parentId = ContainerInstance.getElementId(update.getParent());
DomUpdate.renderElementRemove(rc.getServerMessage(), parentId);
renderAdd(rc, update, targetId, update.getParent());
return true;
}
}