Package net.sf.jasperreports.engine.base
Class JRBaseGroup
java.lang.Object
net.sf.jasperreports.engine.base.JRBaseGroup
- All Implemented Interfaces:
Serializable
,Cloneable
,JRChangeEventsSupport
,JRCloneable
,JRGroup
,StoreCloneable<JRBaseGroup>
- Direct Known Subclasses:
JRDesignGroup
public class JRBaseGroup
extends Object
implements JRGroup, Serializable, JRChangeEventsSupport, StoreCloneable<JRBaseGroup>
- Author:
- Teodor Danciu (teodord@users.sourceforge.net)
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected JRVariable
protected JRExpression
protected FooterPositionEnum
protected JRSection
protected JRSection
protected boolean
protected boolean
protected boolean
protected boolean
protected boolean
protected boolean
protected int
protected int
protected String
protected boolean
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
protected
JRBaseGroup
(JRGroup group, JRBaseObjectFactory factory) -
Method Summary
Modifier and TypeMethodDescriptionclone()
clone
(CloneStore cloneStore) Returns the property change support object for this instance.Gets the expression that defines what records in the group have in common.Specifies how the group footer section behaves with regards to its position on the current page.Gets the footer section created for this group.Gets the header section created for this group.int
Gets the minimum number of details to be rendered on the current column, to avoid starting the group on a new column.int
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.getName()
Gets the group nameboolean
Gets the flag that signals if the group should be prevented from splitting on first break attempt.boolean
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
Gets the flag that signals if the group header should be reprinted at the beginning of each column, in vertically filled reports only.boolean
Gets the flag that signals if the group header should be reprinted at the beginning of each page.boolean
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
Gets the flag that signals if the group header should be printed always on a new column.boolean
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
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.
-
Field Details
-
PROPERTY_MIN_HEIGHT_TO_START_NEW_PAGE
- See Also:
-
PROPERTY_MIN_DETAILS_TO_START_FROM_TOP
- See Also:
-
PROPERTY_FOOTER_POSITION
- See Also:
-
PROPERTY_KEEP_TOGETHER
- See Also:
-
PROPERTY_PREVENT_ORPHAN_FOOTER
- See Also:
-
PROPERTY_RESET_PAGE_NUMBER
- See Also:
-
PROPERTY_REPRINT_HEADER_ON_EACH_PAGE
- See Also:
-
PROPERTY_REPRINT_HEADER_ON_EACH_COLUMN
- See Also:
-
PROPERTY_START_NEW_COLUMN
- See Also:
-
PROPERTY_START_NEW_PAGE
- See Also:
-
name
-
isStartNewColumn
protected boolean isStartNewColumn -
isStartNewPage
protected boolean isStartNewPage -
isResetPageNumber
protected boolean isResetPageNumber -
isReprintHeaderOnEachPage
protected boolean isReprintHeaderOnEachPage -
isReprintHeaderOnEachColumn
protected boolean isReprintHeaderOnEachColumn -
minHeightToStartNewPage
protected int minHeightToStartNewPage -
minDetailsToStartFromTop
protected int minDetailsToStartFromTop -
keepTogether
protected boolean keepTogether -
expression
-
groupHeaderSection
-
countVariable
-
-
Constructor Details
-
JRBaseGroup
protected JRBaseGroup() -
JRBaseGroup
-
-
Method Details
-
getName
Description copied from interface:JRGroup
Gets the group name -
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
-
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
-
getExpression
Description copied from interface:JRGroup
Gets the expression that defines what records in the group have in common.- Specified by:
getExpression
in interfaceJRGroup
-
getGroupHeaderSection
Description copied from interface:JRGroup
Gets the header section created for this group.- Specified by:
getGroupHeaderSection
in interfaceJRGroup
-
getCountVariable
- Specified by:
getCountVariable
in interfaceJRGroup
-
clone
- Specified by:
clone
in interfaceJRCloneable
- Overrides:
clone
in classObject
-
clone
- Specified by:
clone
in interfaceStoreCloneable<JRBaseGroup>
-
getEventSupport
Description copied from interface:JRChangeEventsSupport
Returns the property change support object for this instance.- Specified by:
getEventSupport
in interfaceJRChangeEventsSupport
- Returns:
- the property change support object for this instance
-