com.sencha.gxt.widget.core.client.grid

Class AggregationRowConfig<M>

java.lang.Object

com.sencha.gxt.widget.core.client.grid.AggregationRowConfig<M>

Type Parameters:

M - the model type

public class AggregationRowConfig<M>
extends Object

Defines the configuration information for an aggregation row. The values for each column can be configured and calculated in several ways. The following methods are supported in order of precedence.

1. A static HTML string can be specified.
2. A widget can be specified.
3. A SummaryType can be used to "calculate" a value based on the data. When using a summary type, EITHER a NumberFormat or a AggregationRenderer can be used to "format" the value.

In some cases, the values will not be calculated by the data stored in the store, for example, with paging. In this situation, there are 2 ways to provide values.

The first method is to specify a AggregationRenderer for the relevant columns. This renderer can any data as needed. The second method is to provide a GXT Model that contains the values for the aggregation row. In this case, the value will be retrieved from the model using the property name associated with the column. With this method, you are responsible for ensuring the model is updated any time the aggregation values are updated.

Constructor Summary

Constructors

Constructor and Description
AggregationRowConfig() Creates a new aggregation row config.s

Method Summary

Methods

Modifier and Type	Method and Description
String	getCellStyle(ColumnConfig<M,?> id) Returns the cell style for the given column.
AggregationRenderer<M>	getRenderer(ColumnConfig<M,?> id) Returns the aggregation renderer for the given column.
void	setCellStyle(ColumnConfig<M,?> id, String style) Sets the cell style for the given column.
void	setRenderer(ColumnConfig<M,?> id, AggregationRenderer<M> renderer) Sets the aggregation renderer for the given column.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AggregationRowConfig

public AggregationRowConfig()

Creates a new aggregation row config.s

Method Detail

getCellStyle

public String getCellStyle(ColumnConfig<M,?> id)

Returns the cell style for the given column.

Parameters:

id - the column id

Returns:

the CSS style name

getRenderer

public AggregationRenderer<M> getRenderer(ColumnConfig<M,?> id)

Returns the aggregation renderer for the given column.

Parameters:

id - the column id

Returns:

the aggregation renderer

setCellStyle

public void setCellStyle(ColumnConfig<M,?> id,
                String style)

Sets the cell style for the given column.

Parameters:

id - the column id

style - the CSS style name

setRenderer

public void setRenderer(ColumnConfig<M,?> id,
               AggregationRenderer<M> renderer)

Sets the aggregation renderer for the given column.

Parameters:

id - the column id

renderer - the renderer