Class TableReportGroup
- java.lang.Object
-
- net.sf.jasperreports.components.table.fill.TableReportGroup
-
- All Implemented Interfaces:
Cloneable,JRCloneable,JRGroup
public class TableReportGroup extends Object implements JRGroup
- Author:
- Lucian Chirita (lucianc@users.sourceforge.net)
-
-
Constructor Summary
Constructors Constructor Description TableReportGroup(JRGroup datasetGroup)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Objectclone()JRVariablegetCountVariable()JRExpressiongetExpression()Gets the expression that defines what records in the group have in common.FooterPositionEnumgetFooterPositionValue()Specifies how the group footer section behaves with regards to its position on the current page.JRBandgetGroupFooter()Deprecated.JRSectiongetGroupFooterSection()Gets the footer section created for this group.JRBandgetGroupHeader()Deprecated.JRSectiongetGroupHeaderSection()Gets the header section created for this group.intgetMinDetailsToStartFromTop()Gets the minimum number of details to be rendered on the current column, to avoid starting the group on a new column.intgetMinHeightToStartNewPage()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.StringgetName()Gets the group nameJRGroupgetOriginalGroup()booleanisKeepTogether()Gets the flag that signals if the group should be prevented from splitting on first break attempt.booleanisPreventOrphanFooter()Gets the flag that signals if the group footer should be prevented from appearing without a detail at the top of a new page/column.booleanisReprintHeaderOnEachColumn()Gets the flag that signals if the group header should be reprinted at the beginning of each column, in vertically filled reports only.booleanisReprintHeaderOnEachPage()Gets the flag that signals if the group header should be reprinted at the beginning of each page.booleanisResetPageNumber()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.booleanisStartNewColumn()Gets the flag that signals if the group header should be printed always on a new column.booleanisStartNewPage()Gets the flag that signals if the group header should be printed always on a new page.voidsetFooterPosition(FooterPositionEnum footerPosition)Specifies the group footer section behavior with regards to its position on the current page.voidsetGroupFooter(JRBand footer)voidsetGroupHeader(JRBand header)voidsetKeepTogether(boolean keepTogether)Sets the flag that signals if the group should be prevented from splitting on first break attempt.voidsetMinDetailsToStartFromTop(int minDetails)Sets the minimum number of details to be rendered on the current column, to avoid starting the group on a new column.voidsetMinHeightToStartNewPage(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.voidsetPreventOrphanFooter(boolean preventOrphanFooter)Sets the flag that signals if the group should be prevented from appearing without a detail at the top of a new page/column.voidsetReprintHeaderOnEachColumn(boolean isReprint)Sets the flag that signals if the group header should be reprinted at the beginning of each column, in vertically filled reports only.voidsetReprintHeaderOnEachPage(boolean isReprint)Sets the flag that signals if the group header should be reprinted at the beginning of each page.voidsetResetPageNumber(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.voidsetStartNewColumn(boolean isStart)Sets the flag that signals if the group header should be printed always on a new column.voidsetStartNewPage(boolean isStart)Sets the flag that signals if the group header should be printed always on a new page.protected JRSectionwrapBand(JRBand band, BandTypeEnum bandType)
-
-
-
Constructor Detail
-
TableReportGroup
public TableReportGroup(JRGroup datasetGroup)
-
-
Method Detail
-
getCountVariable
public JRVariable getCountVariable()
- Specified by:
getCountVariablein interfaceJRGroup
-
getExpression
public JRExpression getExpression()
Description copied from interface:JRGroupGets the expression that defines what records in the group have in common.- Specified by:
getExpressionin interfaceJRGroup
-
getFooterPositionValue
public FooterPositionEnum getFooterPositionValue()
Description copied from interface:JRGroupSpecifies how the group footer section behaves with regards to its position on the current page.- Specified by:
getFooterPositionValuein interfaceJRGroup
-
getGroupFooter
@Deprecated public JRBand getGroupFooter()
Deprecated.
-
setGroupFooter
public void setGroupFooter(JRBand footer)
-
wrapBand
protected JRSection wrapBand(JRBand band, BandTypeEnum bandType)
-
getGroupFooterSection
public JRSection getGroupFooterSection()
Description copied from interface:JRGroupGets the footer section created for this group.- Specified by:
getGroupFooterSectionin interfaceJRGroup
-
getGroupHeader
@Deprecated public JRBand getGroupHeader()
Deprecated.
-
setGroupHeader
public void setGroupHeader(JRBand header)
-
getGroupHeaderSection
public JRSection getGroupHeaderSection()
Description copied from interface:JRGroupGets the header section created for this group.- Specified by:
getGroupHeaderSectionin interfaceJRGroup
-
getMinHeightToStartNewPage
public int getMinHeightToStartNewPage()
Description copied from interface:JRGroupGets the minimum amount of vertical space needed at the bottom of the column in order to place the group header on the current column.- Specified by:
getMinHeightToStartNewPagein interfaceJRGroup
-
getMinDetailsToStartFromTop
public int getMinDetailsToStartFromTop()
Description copied from interface:JRGroupGets the minimum number of details to be rendered on the current column, to avoid starting the group on a new column.- Specified by:
getMinDetailsToStartFromTopin interfaceJRGroup
-
isKeepTogether
public boolean isKeepTogether()
Description copied from interface:JRGroupGets the flag that signals if the group should be prevented from splitting on first break attempt.- Specified by:
isKeepTogetherin interfaceJRGroup
-
isPreventOrphanFooter
public boolean isPreventOrphanFooter()
Description copied from interface:JRGroupGets the flag that signals if the group footer should be prevented from appearing without a detail at the top of a new page/column.- Specified by:
isPreventOrphanFooterin interfaceJRGroup
-
isReprintHeaderOnEachPage
public boolean isReprintHeaderOnEachPage()
Description copied from interface:JRGroupGets the flag that signals if the group header should be reprinted at the beginning of each page.- Specified by:
isReprintHeaderOnEachPagein interfaceJRGroup
-
isReprintHeaderOnEachColumn
public boolean isReprintHeaderOnEachColumn()
Description copied from interface:JRGroupGets the flag that signals if the group header should be reprinted at the beginning of each column, in vertically filled reports only.- Specified by:
isReprintHeaderOnEachColumnin interfaceJRGroup
-
isResetPageNumber
public boolean isResetPageNumber()
Description copied from interface:JRGroupGets 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.- Specified by:
isResetPageNumberin interfaceJRGroup
-
isStartNewColumn
public boolean isStartNewColumn()
Description copied from interface:JRGroupGets the flag that signals if the group header should be printed always on a new column.- Specified by:
isStartNewColumnin interfaceJRGroup
-
isStartNewPage
public boolean isStartNewPage()
Description copied from interface:JRGroupGets the flag that signals if the group header should be printed always on a new page.- Specified by:
isStartNewPagein interfaceJRGroup
-
setFooterPosition
public void setFooterPosition(FooterPositionEnum footerPosition)
Description copied from interface:JRGroupSpecifies the group footer section behavior with regards to its position on the current page.- Specified by:
setFooterPositionin interfaceJRGroup
-
setKeepTogether
public void setKeepTogether(boolean keepTogether)
Description copied from interface:JRGroupSets the flag that signals if the group should be prevented from splitting on first break attempt.- Specified by:
setKeepTogetherin interfaceJRGroup
-
setPreventOrphanFooter
public void setPreventOrphanFooter(boolean preventOrphanFooter)
Description copied from interface:JRGroupSets the flag that signals if the group should be prevented from appearing without a detail at the top of a new page/column.- Specified by:
setPreventOrphanFooterin interfaceJRGroup
-
setMinHeightToStartNewPage
public void setMinHeightToStartNewPage(int minHeight)
Description copied from interface:JRGroupSets the minimum amount of vertical space needed at the bottom of the column in order to place the group header on the current column.- Specified by:
setMinHeightToStartNewPagein interfaceJRGroup
-
setMinDetailsToStartFromTop
public void setMinDetailsToStartFromTop(int minDetails)
Description copied from interface:JRGroupSets the minimum number of details to be rendered on the current column, to avoid starting the group on a new column.- Specified by:
setMinDetailsToStartFromTopin interfaceJRGroup
-
setReprintHeaderOnEachPage
public void setReprintHeaderOnEachPage(boolean isReprint)
Description copied from interface:JRGroupSets the flag that signals if the group header should be reprinted at the beginning of each page.- Specified by:
setReprintHeaderOnEachPagein interfaceJRGroup
-
setReprintHeaderOnEachColumn
public void setReprintHeaderOnEachColumn(boolean isReprint)
Description copied from interface:JRGroupSets the flag that signals if the group header should be reprinted at the beginning of each column, in vertically filled reports only.- Specified by:
setReprintHeaderOnEachColumnin interfaceJRGroup
-
setResetPageNumber
public void setResetPageNumber(boolean isReset)
Description copied from interface:JRGroupSets 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.- Specified by:
setResetPageNumberin interfaceJRGroup
-
setStartNewColumn
public void setStartNewColumn(boolean isStart)
Description copied from interface:JRGroupSets the flag that signals if the group header should be printed always on a new column.- Specified by:
setStartNewColumnin interfaceJRGroup
-
setStartNewPage
public void setStartNewPage(boolean isStart)
Description copied from interface:JRGroupSets the flag that signals if the group header should be printed always on a new page.- Specified by:
setStartNewPagein interfaceJRGroup
-
clone
public Object clone()
- Specified by:
clonein interfaceJRCloneable- Overrides:
clonein classObject
-
getOriginalGroup
public JRGroup getOriginalGroup()
-
-