com.extjs.gxt.ui.client.widget.grid.GridGroupRenderer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gxt Show documentation

Rich Internet Application Framework for GWT

There is a newer version: 2.3.1-gwt22

/*
 * Sencha GXT 2.3.0 - Sencha for GWT
 * Copyright(c) 2007-2013, Sencha, Inc.
 * [email protected]
 * 
 * http://www.sencha.com/products/gxt/license/
 */
 package com.extjs.gxt.ui.client.widget.grid;

/**
 * Renderer used to render a grids group row which is the row displayed before
 * the groups data rows begin. The group row will span all columns.
 * 
 * Code snippet:
 * 
 *     GroupingView view = new GroupingView();
    view.setShowGroupedColumn(false);
    view.setForceFit(true);
    view.setGroupRenderer(new GridGroupRenderer() {
      public String render(GroupColumnData data) {
        String f = cm.getColumnById(data.field).getHeader();
        String l = data.models.size() == 1 ? "Item" : "Items";
        return f + ": " + data.group + " (" + data.models.size() + " " + l + ")";
      }
    });
 * 
 */
public interface GridGroupRenderer {

  /**
   * Returns the HTML for a group.
   * 
   * @param data the group column data
   * @return the HTML
   */
  public String render(GroupColumnData data);

}