Package net.sf.jasperreports.engine.fill
Class JRFillGroup
- java.lang.Object
-
- net.sf.jasperreports.engine.fill.JRFillGroup
-
- All Implemented Interfaces:
Cloneable
,JRCloneable
,JRGroup
public class JRFillGroup extends Object implements JRGroup
- Author:
- Teodor Danciu (teodord@users.sourceforge.net)
-
-
Constructor Summary
Constructors Constructor Description JRFillGroup(JRGroup group, JRFillObjectFactory factory)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
clone()
JRVariable
getCountVariable()
protected int
getDetailsCount()
JRExpression
getExpression()
Gets the expression that defines what records in the group have in common.FooterPositionEnum
getFooterPosition()
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.ElementRange
getKeepTogetherElementRange()
int
getMinDetailsToStartFromTop()
Gets the minimum number of details to be rendered on the current column, to avoid starting the group on a new column.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.String
getName()
Gets the group nameboolean
hasChanged()
protected boolean
hasMinDetails()
protected boolean
hasMinDetails(int detailsToMove)
protected void
incrementDetailsCount()
boolean
isFooterPrinted()
boolean
isHeaderPrinted()
boolean
isKeepTogether()
Gets the flag that signals if the group should be prevented from splitting on first break attempt.boolean
isPreventOrphanFooter()
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.boolean
isReprintHeaderOnEachColumn()
Gets the flag that signals if the group header should be reprinted at the beginning of each column, in vertically filled reports only.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.boolean
isTopLevelChange()
Not used anymore.protected void
resetDetailsCount()
void
setFooterPosition(FooterPositionEnum footerPosition)
Specifies the group footer section behavior with regards to its position on the current page.void
setFooterPrinted(boolean isFooterPrinted)
void
setHasChanged(boolean hasChanged)
void
setHeaderPrinted(boolean isHeaderPrinted)
void
setKeepTogether(boolean keepTogether)
Sets the flag that signals if the group should be prevented from splitting on first break attempt.void
setKeepTogetherElementRange(ElementRange keepTogetherElementRange)
void
setMinDetailsToStartFromTop(int minDetails)
Sets the minimum number of details to be rendered on the current column, to avoid starting the group on a new column.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
setPreventOrphanFooter(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.void
setReprintHeaderOnEachColumn(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.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.void
setTopLevelChange(boolean isTopLevelChange)
-
-
-
Field Detail
-
parent
protected JRGroup parent
-
-
Constructor Detail
-
JRFillGroup
public JRFillGroup(JRGroup group, JRFillObjectFactory factory)
-
-
Method Detail
-
getExpression
public JRExpression getExpression()
Description copied from interface:JRGroup
Gets the expression that defines what records in the group have in common.- Specified by:
getExpression
in interfaceJRGroup
-
isStartNewColumn
public boolean isStartNewColumn()
Description copied from interface:JRGroup
Gets the flag that signals if the group header should be printed always on a new column.- Specified by:
isStartNewColumn
in interfaceJRGroup
-
setStartNewColumn
public void setStartNewColumn(boolean isStart)
Description copied from interface:JRGroup
Sets the flag that signals if the group header should be printed always on a new column.- Specified by:
setStartNewColumn
in interfaceJRGroup
-
isStartNewPage
public boolean isStartNewPage()
Description copied from interface:JRGroup
Gets the flag that signals if the group header should be printed always on a new page.- Specified by:
isStartNewPage
in interfaceJRGroup
-
setStartNewPage
public void setStartNewPage(boolean isStart)
Description copied from interface:JRGroup
Sets the flag that signals if the group header should be printed always on a new page.- Specified by:
setStartNewPage
in interfaceJRGroup
-
isResetPageNumber
public boolean isResetPageNumber()
Description copied from interface:JRGroup
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.- Specified by:
isResetPageNumber
in interfaceJRGroup
-
setResetPageNumber
public void setResetPageNumber(boolean isReset)
Description copied from interface:JRGroup
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.- Specified by:
setResetPageNumber
in interfaceJRGroup
-
isReprintHeaderOnEachPage
public boolean isReprintHeaderOnEachPage()
Description copied from interface:JRGroup
Gets the flag that signals if the group header should be reprinted at the beginning of each page.- Specified by:
isReprintHeaderOnEachPage
in interfaceJRGroup
-
setReprintHeaderOnEachPage
public void setReprintHeaderOnEachPage(boolean isReprint)
Description copied from interface:JRGroup
Sets the flag that signals if the group header should be reprinted at the beginning of each page.- Specified by:
setReprintHeaderOnEachPage
in interfaceJRGroup
-
isReprintHeaderOnEachColumn
public boolean isReprintHeaderOnEachColumn()
Description copied from interface:JRGroup
Gets the flag that signals if the group header should be reprinted at the beginning of each column, in vertically filled reports only.- Specified by:
isReprintHeaderOnEachColumn
in interfaceJRGroup
-
setReprintHeaderOnEachColumn
public void setReprintHeaderOnEachColumn(boolean isReprint)
Description copied from interface:JRGroup
Sets the flag that signals if the group header should be reprinted at the beginning of each column, in vertically filled reports only.- Specified by:
setReprintHeaderOnEachColumn
in interfaceJRGroup
-
getMinHeightToStartNewPage
public int getMinHeightToStartNewPage()
Description copied from interface:JRGroup
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.- Specified by:
getMinHeightToStartNewPage
in interfaceJRGroup
-
setMinHeightToStartNewPage
public void setMinHeightToStartNewPage(int minHeight)
Description copied from interface:JRGroup
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.- Specified by:
setMinHeightToStartNewPage
in interfaceJRGroup
-
getMinDetailsToStartFromTop
public int getMinDetailsToStartFromTop()
Description copied from interface:JRGroup
Gets the minimum number of details to be rendered on the current column, to avoid starting the group on a new column.- Specified by:
getMinDetailsToStartFromTop
in interfaceJRGroup
-
setMinDetailsToStartFromTop
public void setMinDetailsToStartFromTop(int minDetails)
Description copied from interface:JRGroup
Sets the minimum number of details to be rendered on the current column, to avoid starting the group on a new column.- Specified by:
setMinDetailsToStartFromTop
in interfaceJRGroup
-
getFooterPosition
public FooterPositionEnum getFooterPosition()
Description copied from interface:JRGroup
Specifies how the group footer section behaves with regards to its position on the current page.- Specified by:
getFooterPosition
in interfaceJRGroup
-
setFooterPosition
public void setFooterPosition(FooterPositionEnum footerPosition)
Description copied from interface:JRGroup
Specifies the group footer section behavior with regards to its position on the current page.- Specified by:
setFooterPosition
in interfaceJRGroup
-
isKeepTogether
public boolean isKeepTogether()
Description copied from interface:JRGroup
Gets the flag that signals if the group should be prevented from splitting on first break attempt.- Specified by:
isKeepTogether
in interfaceJRGroup
-
setKeepTogether
public void setKeepTogether(boolean keepTogether)
Description copied from interface:JRGroup
Sets the flag that signals if the group should be prevented from splitting on first break attempt.- Specified by:
setKeepTogether
in interfaceJRGroup
-
isPreventOrphanFooter
public boolean isPreventOrphanFooter()
Description copied from interface:JRGroup
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.- Specified by:
isPreventOrphanFooter
in interfaceJRGroup
-
setPreventOrphanFooter
public void setPreventOrphanFooter(boolean preventOrphanFooter)
Description copied from interface:JRGroup
Sets 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:
setPreventOrphanFooter
in interfaceJRGroup
-
getGroupHeaderSection
public JRSection getGroupHeaderSection()
Description copied from interface:JRGroup
Gets the header section created for this group.- Specified by:
getGroupHeaderSection
in interfaceJRGroup
-
getGroupFooterSection
public JRSection getGroupFooterSection()
Description copied from interface:JRGroup
Gets the footer section created for this group.- Specified by:
getGroupFooterSection
in interfaceJRGroup
-
getCountVariable
public JRVariable getCountVariable()
- Specified by:
getCountVariable
in interfaceJRGroup
-
hasChanged
public boolean hasChanged()
-
setHasChanged
public void setHasChanged(boolean hasChanged)
-
isTopLevelChange
public boolean isTopLevelChange()
Not used anymore.
-
setTopLevelChange
public void setTopLevelChange(boolean isTopLevelChange)
-
isHeaderPrinted
public boolean isHeaderPrinted()
-
setHeaderPrinted
public void setHeaderPrinted(boolean isHeaderPrinted)
-
isFooterPrinted
public boolean isFooterPrinted()
-
setFooterPrinted
public void setFooterPrinted(boolean isFooterPrinted)
-
getKeepTogetherElementRange
public ElementRange getKeepTogetherElementRange()
-
setKeepTogetherElementRange
public void setKeepTogetherElementRange(ElementRange keepTogetherElementRange)
-
incrementDetailsCount
protected void incrementDetailsCount()
-
resetDetailsCount
protected void resetDetailsCount()
-
hasMinDetails
protected boolean hasMinDetails()
-
hasMinDetails
protected boolean hasMinDetails(int detailsToMove)
-
getDetailsCount
protected int getDetailsCount()
-
clone
public Object clone()
- Specified by:
clone
in interfaceJRCloneable
- Overrides:
clone
in classObject
-
-