public interface JRGroup extends JRCloneable
The value of the associated group expression is what makes group records stick together. This value is the thing that they have in common.
Modifier and Type | Field and Description |
---|---|
static byte |
FOOTER_POSITION_COLLATE_AT_BOTTOM
Deprecated.
Replaced by
FooterPositionEnum.COLLATE_AT_BOTTOM . |
static byte |
FOOTER_POSITION_FORCE_AT_BOTTOM
Deprecated.
Replaced by
FooterPositionEnum.FORCE_AT_BOTTOM . |
static byte |
FOOTER_POSITION_NORMAL
Deprecated.
Replaced by
FooterPositionEnum.NORMAL . |
static byte |
FOOTER_POSITION_STACK_AT_BOTTOM
Deprecated.
Replaced by
FooterPositionEnum.STACK_AT_BOTTOM . |
Modifier and Type | Method and Description |
---|---|
JRVariable |
getCountVariable() |
JRExpression |
getExpression()
Gets the expression that defines what records in the group have in common.
|
byte |
getFooterPosition()
Deprecated.
Replaced by
getFooterPositionValue() . |
FooterPositionEnum |
getFooterPositionValue()
Specifies how the group footer section behaves with regards to its position on the current page.
|
JRBand |
getGroupFooter()
Deprecated.
Replaced by
getGroupFooterSection() . |
JRSection |
getGroupFooterSection()
Gets the footer section created for this group.
|
JRBand |
getGroupHeader()
Deprecated.
Replaced by
getGroupHeaderSection() . |
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(byte footerPosition)
Deprecated.
Replaced by
setFooterPosition(FooterPositionEnum) . |
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.
|
clone
static final byte FOOTER_POSITION_NORMAL
FooterPositionEnum.NORMAL
.static final byte FOOTER_POSITION_STACK_AT_BOTTOM
FooterPositionEnum.STACK_AT_BOTTOM
.static final byte FOOTER_POSITION_FORCE_AT_BOTTOM
FooterPositionEnum.FORCE_AT_BOTTOM
.static final byte FOOTER_POSITION_COLLATE_AT_BOTTOM
FooterPositionEnum.COLLATE_AT_BOTTOM
.java.lang.String getName()
boolean isStartNewColumn()
void setStartNewColumn(boolean isStart)
boolean isStartNewPage()
void setStartNewPage(boolean isStart)
boolean isResetPageNumber()
void setResetPageNumber(boolean isReset)
boolean isReprintHeaderOnEachPage()
void setReprintHeaderOnEachPage(boolean isReprint)
int getMinHeightToStartNewPage()
void setMinHeightToStartNewPage(int minHeight)
byte getFooterPosition()
getFooterPositionValue()
.FooterPositionEnum getFooterPositionValue()
void setFooterPosition(byte footerPosition)
setFooterPosition(FooterPositionEnum)
.void setFooterPosition(FooterPositionEnum footerPosition)
boolean isKeepTogether()
void setKeepTogether(boolean keepTogether)
JRExpression getExpression()
JRBand getGroupHeader()
getGroupHeaderSection()
.JRSection getGroupHeaderSection()
JRBand getGroupFooter()
getGroupFooterSection()
.JRSection getGroupFooterSection()
JRVariable getCountVariable()
© 2001-2010 Jaspersoft Corporation www.jaspersoft.com