com.smartgwt.client.widgets.grid

Class GroupSummaryCustomizer

java.lang.Object

com.smartgwt.client.widgets.grid.GroupSummaryCustomizer

public abstract class GroupSummaryCustomizer
extends java.lang.Object

If ListGrid.getShowGroupSummary() is true, and this method is specified it will be called to generate the field summary value to be displayed for each group level summary row. Note that this is called instead of making use of the ListGridField.summaryFunction.

Constructor Summary

Constructors

Constructor and Description
GroupSummaryCustomizer()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.Object[]	getGroupSummary(ListGridRecord[] records, ListGridField field, GroupNode groupNode)

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupSummaryCustomizer

public GroupSummaryCustomizer()

Method Detail

getGroupSummary

public abstract java.lang.Object[] getGroupSummary(ListGridRecord[] records,
                                                   ListGridField field,
                                                   GroupNode groupNode)

Parameters:

recordsrecords - for which a summary is being generated (so all records in the group).

field - pointer to the field for which summary value is being generated

groupNode - object with specified groupValue and groupName for this group

Returns:

This method may return an array of results - in this case the group will show multiple summary rows, with each entry in the array showing up in a different record.