public class JRBaseGroup extends java.lang.Object implements JRGroup, java.io.Serializable, JRChangeEventsSupport
Modifier and Type | Field and Description |
---|---|
protected JRVariable |
countVariable |
protected JRExpression |
expression |
protected FooterPositionEnum |
footerPositionValue |
protected JRSection |
groupFooterSection |
protected JRSection |
groupHeaderSection |
protected boolean |
isReprintHeaderOnEachPage |
protected boolean |
isResetPageNumber |
protected boolean |
isStartNewColumn |
protected boolean |
isStartNewPage |
protected boolean |
keepTogether |
protected int |
minHeightToStartNewPage |
protected java.lang.String |
name |
static java.lang.String |
PROPERTY_FOOTER_POSITION |
static java.lang.String |
PROPERTY_KEEP_TOGETHER |
static java.lang.String |
PROPERTY_MIN_HEIGHT_TO_START_NEW_PAGE |
static java.lang.String |
PROPERTY_REPRINT_HEADER_ON_EACH_PAGE |
static java.lang.String |
PROPERTY_RESET_PAGE_NUMBER |
static java.lang.String |
PROPERTY_START_NEW_COLUMN |
static java.lang.String |
PROPERTY_START_NEW_PAGE |
FOOTER_POSITION_COLLATE_AT_BOTTOM, FOOTER_POSITION_FORCE_AT_BOTTOM, FOOTER_POSITION_NORMAL, FOOTER_POSITION_STACK_AT_BOTTOM
Modifier | Constructor and Description |
---|---|
protected |
JRBaseGroup() |
protected |
JRBaseGroup(JRGroup group,
JRBaseObjectFactory factory) |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone() |
JRVariable |
getCountVariable() |
JRPropertyChangeSupport |
getEventSupport()
Returns the property change support object for this instance.
|
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 footerPositionValue)
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.
|
public static final java.lang.String PROPERTY_MIN_HEIGHT_TO_START_NEW_PAGE
public static final java.lang.String PROPERTY_FOOTER_POSITION
public static final java.lang.String PROPERTY_KEEP_TOGETHER
public static final java.lang.String PROPERTY_RESET_PAGE_NUMBER
public static final java.lang.String PROPERTY_REPRINT_HEADER_ON_EACH_PAGE
public static final java.lang.String PROPERTY_START_NEW_COLUMN
public static final java.lang.String PROPERTY_START_NEW_PAGE
protected java.lang.String name
protected boolean isStartNewColumn
protected boolean isStartNewPage
protected boolean isResetPageNumber
protected boolean isReprintHeaderOnEachPage
protected int minHeightToStartNewPage
protected FooterPositionEnum footerPositionValue
protected boolean keepTogether
protected JRExpression expression
protected JRSection groupHeaderSection
protected JRSection groupFooterSection
protected JRVariable countVariable
protected JRBaseGroup()
protected JRBaseGroup(JRGroup group, JRBaseObjectFactory factory)
public java.lang.String getName()
JRGroup
public boolean isStartNewColumn()
JRGroup
isStartNewColumn
in interface JRGroup
public void setStartNewColumn(boolean isStart)
JRGroup
setStartNewColumn
in interface JRGroup
public boolean isStartNewPage()
JRGroup
isStartNewPage
in interface JRGroup
public void setStartNewPage(boolean isStart)
JRGroup
setStartNewPage
in interface JRGroup
public boolean isResetPageNumber()
JRGroup
isResetPageNumber
in interface JRGroup
public void setResetPageNumber(boolean isReset)
JRGroup
setResetPageNumber
in interface JRGroup
public boolean isReprintHeaderOnEachPage()
JRGroup
isReprintHeaderOnEachPage
in interface JRGroup
public void setReprintHeaderOnEachPage(boolean isReprint)
JRGroup
setReprintHeaderOnEachPage
in interface JRGroup
public int getMinHeightToStartNewPage()
JRGroup
getMinHeightToStartNewPage
in interface JRGroup
public void setMinHeightToStartNewPage(int minHeight)
JRGroup
setMinHeightToStartNewPage
in interface JRGroup
public byte getFooterPosition()
getFooterPositionValue()
.getFooterPosition
in interface JRGroup
public FooterPositionEnum getFooterPositionValue()
JRGroup
getFooterPositionValue
in interface JRGroup
public void setFooterPosition(byte footerPosition)
setFooterPosition(FooterPositionEnum)
.setFooterPosition
in interface JRGroup
public void setFooterPosition(FooterPositionEnum footerPositionValue)
JRGroup
setFooterPosition
in interface JRGroup
public boolean isKeepTogether()
JRGroup
isKeepTogether
in interface JRGroup
public void setKeepTogether(boolean keepTogether)
JRGroup
setKeepTogether
in interface JRGroup
public JRExpression getExpression()
JRGroup
getExpression
in interface JRGroup
public JRBand getGroupHeader()
getGroupHeaderSection()
.JRGroup
getGroupHeader
in interface JRGroup
public JRSection getGroupHeaderSection()
JRGroup
getGroupHeaderSection
in interface JRGroup
public JRBand getGroupFooter()
getGroupFooterSection()
.JRGroup
getGroupFooter
in interface JRGroup
public JRSection getGroupFooterSection()
JRGroup
getGroupFooterSection
in interface JRGroup
public JRVariable getCountVariable()
getCountVariable
in interface JRGroup
public java.lang.Object clone()
clone
in interface JRCloneable
clone
in class java.lang.Object
public JRPropertyChangeSupport getEventSupport()
JRChangeEventsSupport
getEventSupport
in interface JRChangeEventsSupport
© 2001-2010 Jaspersoft Corporation www.jaspersoft.com