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 Deprecated Methods Modifier and Type Method Description Objectclone()JRVariablegetCountVariable()protected intgetDetailsCount()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.JRSectiongetGroupFooterSection()Gets the footer section created for this group.JRSectiongetGroupHeaderSection()Gets the header section created for this group.ElementRangegetKeepTogetherElementRange()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 namebooleanhasChanged()protected booleanhasMinDetails()protected booleanhasMinDetails(int detailsToMove)protected voidincrementDetailsCount()booleanisFooterPrinted()booleanisHeaderPrinted()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.booleanisTopLevelChange()Deprecated.To be removed.protected voidresetDetailsCount()voidsetFooterPosition(FooterPositionEnum footerPosition)Specifies the group footer section behavior with regards to its position on the current page.voidsetFooterPrinted(boolean isFooterPrinted)voidsetHasChanged(boolean hasChanged)voidsetHeaderPrinted(boolean isHeaderPrinted)voidsetKeepTogether(boolean keepTogether)Sets the flag that signals if the group should be prevented from splitting on first break attempt.voidsetKeepTogetherElementRange(ElementRange keepTogetherElementRange)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.voidsetTopLevelChange(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:JRGroupGets the expression that defines what records in the group have in common.- Specified by:
getExpressionin 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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
getGroupHeaderSection
public JRSection getGroupHeaderSection()
Description copied from interface:JRGroupGets the header section created for this group.- Specified by:
getGroupHeaderSectionin interfaceJRGroup
-
getGroupFooterSection
public JRSection getGroupFooterSection()
Description copied from interface:JRGroupGets the footer section created for this group.- Specified by:
getGroupFooterSectionin interfaceJRGroup
-
getCountVariable
public JRVariable getCountVariable()
- Specified by:
getCountVariablein interfaceJRGroup
-
hasChanged
public boolean hasChanged()
-
setHasChanged
public void setHasChanged(boolean hasChanged)
-
isTopLevelChange
public boolean isTopLevelChange()
Deprecated.To be removed.
-
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:
clonein interfaceJRCloneable- Overrides:
clonein classObject
-
-