org.apache.tapestry5.corelib.components.GridRows Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tapestry-core Show documentation
Show all versions of tapestry-core Show documentation
Central module for Tapestry, containing interfaces to the Java
Servlet API and all core services and components.
// Copyright 2007, 2008, 2009 The Apache Software Foundation
//
// Licensed 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.
// Copyright 2007, 2008 The Apache Software Foundation
//
// Licensed 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.tapestry5.corelib.components;
import org.apache.tapestry5.ComponentAction;
import org.apache.tapestry5.PropertyOverrides;
import org.apache.tapestry5.ValueEncoder;
import org.apache.tapestry5.annotations.Environmental;
import org.apache.tapestry5.annotations.Parameter;
import org.apache.tapestry5.annotations.Property;
import org.apache.tapestry5.beaneditor.PropertyModel;
import org.apache.tapestry5.grid.GridConstants;
import org.apache.tapestry5.grid.GridDataSource;
import org.apache.tapestry5.grid.GridModel;
import org.apache.tapestry5.internal.TapestryInternalUtils;
import org.apache.tapestry5.ioc.internal.util.CollectionFactory;
import org.apache.tapestry5.services.FormSupport;
import java.util.List;
/**
* Renders out a series of rows within the table.
*
* Inside a {@link Form}, a series of row index numbers are stored into the form ( {@linkplain FormSupport#store(Object,
* ComponentAction) as ComponentActions}). This is not ideal ... in a situation where the data set can shift between the
* form render and the form submission, this can cause unexpected results, including applying changes to the wrong
* objects.
*/
@SuppressWarnings({ "unchecked" })
public class GridRows
{
private int startRow;
private boolean recordStateByIndex;
private boolean recordStateByEncoder;
/**
* This action is used when a {@link org.apache.tapestry5.ValueEncoder} is not provided.
*/
static class SetupForRowByIndex implements ComponentAction
{
private static final long serialVersionUID = -3216282071752371975L;
private final int rowIndex;
public SetupForRowByIndex(int rowIndex)
{
this.rowIndex = rowIndex;
}
public void execute(GridRows component)
{
component.setupForRow(rowIndex);
}
@Override
public String toString()
{
return String.format("GridRows.SetupForRowByIndex[%d]", rowIndex);
}
}
/**
* This action is used when a {@link org.apache.tapestry5.ValueEncoder} is provided.
*/
static class SetupForRowWithClientValue implements ComponentAction
{
private final String clientValue;
SetupForRowWithClientValue(String clientValue)
{
this.clientValue = clientValue;
}
public void execute(GridRows component)
{
component.setupForRowWithClientValue(clientValue);
}
@Override
public String toString()
{
return String.format("GridRows.SetupForRowWithClientValue[%s]", clientValue);
}
}
/**
* Parameter used to set the CSS class for each row (each <tr> element) within the <tbody>). This is not
* cached, so it will be recomputed for each row.
*/
@Parameter(cache = false)
private String rowClass;
/**
* Object that provides access to the bean and data models used to render the Grid.
*/
@Parameter(value = "componentResources.container")
private GridModel gridModel;
/**
* Where to search for property override blocks.
*/
@Parameter(required = true, allowNull = false)
@Property
private PropertyOverrides overrides;
/**
* Number of rows displayed on each page. Long result sets are split across multiple pages.
*/
@Parameter(required = true)
private int rowsPerPage;
/**
* The current page number within the available pages (indexed from 1).
*/
@Parameter(required = true)
private int currentPage;
/**
* The current row being rendered, this is primarily an output parameter used to allow the Grid, and the Grid's
* container, to know what object is being rendered.
*/
@Parameter(required = true)
@Property(write = false)
private Object row;
/**
* If true, then the CSS class on each <TD> cell will be omitted, which can reduce the amount of output from
* the component overall by a considerable amount. Leave this as false, the default, when you are leveraging the CSS
* to customize the look and feel of particular columns.
*/
@Parameter
private boolean lean;
/**
* If true and the component is enclosed by a Form, then the normal state saving logic is turned off. Defaults to
* false, enabling state saving logic within Forms. This can be set to false when form elements within the Grid are
* not related to the current row of the grid, or where another component (such as {@link
* org.apache.tapestry5.corelib.components.Hidden}) is used to maintain row state.
*/
@Parameter(name = "volatile")
private boolean volatileState;
/**
* Changes how state is recorded into the form to store the {@linkplain org.apache.tapestry5.ValueEncoder#toClient(Object)
* client value} for each row (rather than the index), and restore the {@linkplain
* org.apache.tapestry5.ValueEncoder#toValue(String) row values} from the client value.
*/
@Parameter
private ValueEncoder encoder;
/**
* Optional output parameter (only set during rendering) that identifies the current row index. This is the index on
* the page (i.e., always numbered from zero) as opposed to the row index inside the {@link
* org.apache.tapestry5.grid.GridDataSource}.
*/
@Parameter
private int rowIndex;
/**
* Optional output parameter that stores the current column index.
*/
@Parameter
@Property
private int columnIndex;
@Environmental(false)
private FormSupport formSupport;
private int endRow;
/**
* Index into the {@link org.apache.tapestry5.grid.GridDataSource}.
*/
private int dataRowIndex;
private String propertyName;
@Property(write = false)
private PropertyModel columnModel;
public String getRowClass()
{
List classes = CollectionFactory.newList();
// Not a cached parameter, so careful to only access it once.
String rc = rowClass;
if (rc != null) classes.add(rc);
if (dataRowIndex == startRow) classes.add(GridConstants.FIRST_CLASS);
if (dataRowIndex == endRow) classes.add(GridConstants.LAST_CLASS);
return TapestryInternalUtils.toClassAttributeValue(classes);
}
public String getCellClass()
{
List classes = CollectionFactory.newList();
String id = gridModel.getDataModel().get(propertyName).getId();
if (!lean)
{
classes.add(id);
switch (gridModel.getSortModel().getColumnSort(id))
{
case ASCENDING:
classes.add(GridConstants.SORT_ASCENDING_CLASS);
break;
case DESCENDING:
classes.add(GridConstants.SORT_DESCENDING_CLASS);
break;
default:
}
}
return TapestryInternalUtils.toClassAttributeValue(classes);
}
void setupRender()
{
GridDataSource dataSource = gridModel.getDataSource();
int availableRows = dataSource.getAvailableRows();
int maxPages = ((availableRows - 1) / rowsPerPage) + 1;
// This can sometimes happen when the number of items shifts between requests.
if (currentPage > maxPages) currentPage = maxPages;
startRow = (currentPage - 1) * rowsPerPage;
endRow = Math.min(availableRows - 1, startRow + rowsPerPage - 1);
dataRowIndex = startRow;
boolean recordingStateInsideForm = !volatileState && formSupport != null;
recordStateByIndex = recordingStateInsideForm && (encoder == null);
recordStateByEncoder = recordingStateInsideForm && (encoder != null);
}
/**
* Callback method, used when recording state to a form, or called directly when not recording state.
*/
void setupForRow(int rowIndex)
{
row = gridModel.getDataSource().getRowValue(rowIndex);
}
/**
* Callback method that bypasses the data source and converts a primary key back into a row value (via {@link
* org.apache.tapestry5.ValueEncoder#toValue(String)}).
*/
void setupForRowWithClientValue(String clientValue)
{
row = encoder.toValue(clientValue);
if (row == null)
throw new IllegalArgumentException(
String.format("%s returned null for client value '%s'.", encoder, clientValue));
}
boolean beginRender()
{
// Setup for this row.
setupForRow(dataRowIndex);
// Update the index parameter (which starts from zero).
rowIndex = dataRowIndex - startRow;
if (row != null)
{
// When needed, store a callback used when the form is submitted.
if (recordStateByIndex)
formSupport.store(this, new SetupForRowByIndex(dataRowIndex));
if (recordStateByEncoder)
{
String key = encoder.toClient(row);
formSupport.store(this, new SetupForRowWithClientValue(key));
}
}
// If the row is null, it's because the rowIndex is too large (see the notes
// on GridDataSource). When row is null, return false to not render anything for this iteration
// of the loop.
return row != null;
}
boolean afterRender()
{
dataRowIndex++;
// Abort the loop when we hit a null row, or when we've exhausted the range we need to
// display.
return row == null || dataRowIndex > endRow;
}
public List getPropertyNames()
{
return gridModel.getDataModel().getPropertyNames();
}
public String getPropertyName()
{
return propertyName;
}
public void setPropertyName(String propertyName)
{
this.propertyName = propertyName;
columnModel = gridModel.getDataModel().get(propertyName);
}
}