net.sf.jasperreports.engine
Interface JRGroup

All Superinterfaces:

java.lang.Cloneable, JRCloneable

All Known Implementing Classes:

JRBaseGroup, JRDesignGroup, JRFillGroup, TableReportGroup

public interface JRGroup
extends JRCloneable

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 5180 2012-03-29 13:23:12Z teodord $

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.
FooterPositionEnum	getFooterPositionValue() Specifies how the group footer section behaves with regards to its position on the current page.
JRSection	getGroupFooterSection() Gets the footer section created for this group.
JRSection	getGroupHeaderSection() Gets the header section 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	isKeepTogether() Gets the flag that signals if the group should be prevented from splitting on first break attempt.
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	setFooterPosition(FooterPositionEnum footerPosition) Specifies the group footer section behavior with regards to its position on the current page.
void	setKeepTogether(boolean keepTogether) Sets the flag that signals if the group should be prevented from splitting on first break attempt.
void	setMinHeightToStartNewPage(int minHeight) Sets 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.

Methods inherited from interface net.sf.jasperreports.engine.JRCloneable

clone

Method Detail

getName

java.lang.String getName()

Gets the group name

isStartNewColumn

boolean isStartNewColumn()

Gets the flag that signals if the group header should be printed always on a new column.

setStartNewColumn

void setStartNewColumn(boolean isStart)

Sets the flag that signals if the group header should be printed always on a new column.

isStartNewPage

boolean isStartNewPage()

Gets the flag that signals if the group header should be printed always on a new page.

setStartNewPage

void setStartNewPage(boolean isStart)

Sets the flag that signals if the group header should be printed always on a new page.

isResetPageNumber

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

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

boolean isReprintHeaderOnEachPage()

Gets the flag that signals if the group header should be reprinted at the beginning of each page.

setReprintHeaderOnEachPage

void setReprintHeaderOnEachPage(boolean isReprint)

Sets the flag that signals if the group header should be reprinted at the beginning of each page.

getMinHeightToStartNewPage

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

void setMinHeightToStartNewPage(int minHeight)

Sets the minimum amount of vertical space needed at the bottom of the column in order to place the group header on the current column.

getFooterPositionValue

FooterPositionEnum getFooterPositionValue()

Specifies how the group footer section behaves with regards to its position on the current page.

setFooterPosition

void setFooterPosition(FooterPositionEnum footerPosition)

Specifies the group footer section behavior with regards to its position on the current page.

isKeepTogether

boolean isKeepTogether()

Gets the flag that signals if the group should be prevented from splitting on first break attempt.

setKeepTogether

void setKeepTogether(boolean keepTogether)

Sets the flag that signals if the group should be prevented from splitting on first break attempt.

getExpression

JRExpression getExpression()

Gets the expression that defines what records in the group have in common.

getGroupHeaderSection

JRSection getGroupHeaderSection()

Gets the header section created for this group.

getGroupFooterSection

JRSection getGroupFooterSection()

Gets the footer section created for this group.

getCountVariable

JRVariable getCountVariable()