|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectnet.sf.jasperreports.engine.base.JRBaseGroup
public class JRBaseGroup
| Field Summary | |
|---|---|
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
|
| Fields inherited from interface net.sf.jasperreports.engine.JRGroup |
|---|
FOOTER_POSITION_COLLATE_AT_BOTTOM, FOOTER_POSITION_FORCE_AT_BOTTOM, FOOTER_POSITION_NORMAL, FOOTER_POSITION_STACK_AT_BOTTOM |
| Constructor Summary | |
|---|---|
protected |
JRBaseGroup()
|
protected |
JRBaseGroup(JRGroup group,
JRBaseObjectFactory factory)
|
| Method Summary | |
|---|---|
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. |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
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
| Constructor Detail |
|---|
protected JRBaseGroup()
protected JRBaseGroup(JRGroup group,
JRBaseObjectFactory factory)
| Method Detail |
|---|
public java.lang.String getName()
JRGroup
getName in interface JRGrouppublic boolean isStartNewColumn()
JRGroup
isStartNewColumn in interface JRGrouppublic void setStartNewColumn(boolean isStart)
JRGroup
setStartNewColumn in interface JRGrouppublic boolean isStartNewPage()
JRGroup
isStartNewPage in interface JRGrouppublic void setStartNewPage(boolean isStart)
JRGroup
setStartNewPage in interface JRGrouppublic boolean isResetPageNumber()
JRGroup
isResetPageNumber in interface JRGrouppublic void setResetPageNumber(boolean isReset)
JRGroup
setResetPageNumber in interface JRGrouppublic boolean isReprintHeaderOnEachPage()
JRGroup
isReprintHeaderOnEachPage in interface JRGrouppublic void setReprintHeaderOnEachPage(boolean isReprint)
JRGroup
setReprintHeaderOnEachPage in interface JRGrouppublic int getMinHeightToStartNewPage()
JRGroup
getMinHeightToStartNewPage in interface JRGrouppublic void setMinHeightToStartNewPage(int minHeight)
JRGroup
setMinHeightToStartNewPage in interface JRGrouppublic byte getFooterPosition()
getFooterPositionValue().
getFooterPosition in interface JRGrouppublic FooterPositionEnum getFooterPositionValue()
JRGroup
getFooterPositionValue in interface JRGrouppublic void setFooterPosition(byte footerPosition)
setFooterPosition(FooterPositionEnum).
setFooterPosition in interface JRGrouppublic void setFooterPosition(FooterPositionEnum footerPositionValue)
JRGroup
setFooterPosition in interface JRGrouppublic boolean isKeepTogether()
JRGroup
isKeepTogether in interface JRGrouppublic void setKeepTogether(boolean keepTogether)
JRGroup
setKeepTogether in interface JRGrouppublic JRExpression getExpression()
JRGroup
getExpression in interface JRGrouppublic JRBand getGroupHeader()
getGroupHeaderSection().
JRGroup
getGroupHeader in interface JRGrouppublic JRSection getGroupHeaderSection()
JRGroup
getGroupHeaderSection in interface JRGrouppublic JRBand getGroupFooter()
getGroupFooterSection().
JRGroup
getGroupFooter in interface JRGrouppublic JRSection getGroupFooterSection()
JRGroup
getGroupFooterSection in interface JRGrouppublic JRVariable getCountVariable()
getCountVariable in interface JRGrouppublic java.lang.Object clone()
clone in interface JRCloneableclone in class java.lang.Objectpublic JRPropertyChangeSupport getEventSupport()
JRChangeEventsSupport
getEventSupport in interface JRChangeEventsSupport
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||