net.sf.jasperreports.engine
Interface JRGroup

All Known Implementing Classes:
JRBaseGroup, JRFillGroup

public interface JRGroup

Groups represent a flexible way to organize data on a report. A report group is represented by sequence of consecutive records in the data source that have something in common, like the value of a certain report field for example.

The value of the associated group expression is what makes group records stick together. This value is the thing that they have in common.

Version:
$Id: JRGroup.java,v 1.8 2005/08/22 15:44:50 ionutned Exp $
Author:
Teodor Danciu (teodord@users.sourceforge.net)

Method Summary
 JRVariable getCountVariable()
           
 JRExpression getExpression()
          Gets the expression that defines what records in the group have in common.
 JRBand getGroupFooter()
          Gets the footer band created for this group.
 JRBand getGroupHeader()
          Gets the header band created for this group.
 int getMinHeightToStartNewPage()
          Gets the minimum amount of vertical space needed at the bottom of the column in order to place the group header on the current column.
 java.lang.String getName()
          Gets the group name
 boolean isReprintHeaderOnEachPage()
          Gets the flag that signals if the group header should be reprinted at the beginning of each page.
 boolean isResetPageNumber()
          Gets the flag that signals if the group header should be printed always on a new page, along with the re-initialization of the page number.
 boolean isStartNewColumn()
          Gets the flag that signals if the group header should be printed always on a new column.
 boolean isStartNewPage()
          Gets the flag that signals if the group header should be printed always on a new page.
 void setMinHeightToStartNewPage(int minHeight)
          Gets the minimum amount of vertical space needed at the bottom of the column in order to place the group header on the current column.
 void setReprintHeaderOnEachPage(boolean isReprint)
          Sets the flag that signals if the group header should be reprinted at the beginning of each page.
 void setResetPageNumber(boolean isReset)
          Sets the flag that signals if the group header should be printed always on a new page, along with the re-initialization of the page number.
 void setStartNewColumn(boolean isStart)
          Sets the flag that signals if the group header should be printed always on a new column.
 void setStartNewPage(boolean isStart)
          Sets the flag that signals if the group header should be printed always on a new page.
 

Method Detail

getName

public java.lang.String getName()
Gets the group name


isStartNewColumn

public boolean isStartNewColumn()
Gets the flag that signals if the group header should be printed always on a new column.


setStartNewColumn

public void setStartNewColumn(boolean isStart)
Sets the flag that signals if the group header should be printed always on a new column.


isStartNewPage

public boolean isStartNewPage()
Gets the flag that signals if the group header should be printed always on a new page.


setStartNewPage

public void setStartNewPage(boolean isStart)
Sets the flag that signals if the group header should be printed always on a new page.


isResetPageNumber

public boolean isResetPageNumber()
Gets the flag that signals if the group header should be printed always on a new page, along with the re-initialization of the page number.


setResetPageNumber

public void setResetPageNumber(boolean isReset)
Sets the flag that signals if the group header should be printed always on a new page, along with the re-initialization of the page number.


isReprintHeaderOnEachPage

public boolean isReprintHeaderOnEachPage()
Gets the flag that signals if the group header should be reprinted at the beginning of each page.


setReprintHeaderOnEachPage

public void setReprintHeaderOnEachPage(boolean isReprint)
Sets the flag that signals if the group header should be reprinted at the beginning of each page.


getMinHeightToStartNewPage

public int getMinHeightToStartNewPage()
Gets the minimum amount of vertical space needed at the bottom of the column in order to place the group header on the current column.


setMinHeightToStartNewPage

public void setMinHeightToStartNewPage(int minHeight)
Gets the minimum amount of vertical space needed at the bottom of the column in order to place the group header on the current column.


getExpression

public JRExpression getExpression()
Gets the expression that defines what records in the group have in common.


getGroupHeader

public JRBand getGroupHeader()
Gets the header band created for this group.


getGroupFooter

public JRBand getGroupFooter()
Gets the footer band created for this group.


getCountVariable

public JRVariable getCountVariable()


© 2001-2005 JasperSoft Corporation www.jaspersoft.com