|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jrefinery.report.Group
A report group. Reports can contain any number of (nested) groups. The order of the fields is important. If the group does not contain any fields, the group spans the whole report from the first to the last row.
The group's field list should not be modified after the group was added to the group list, or the results are undefined.
GroupList
,
Serialized FormConstructor Summary | |
Group()
Constructs a group with no fields, and an empty header and footer. |
Method Summary | |
void |
addField(java.lang.String name)
Adds a field to the group. |
java.lang.Object |
clone()
Clones this Element. |
int |
compareTo(java.lang.Object o)
Compares two objects (required to be instances of the Group class). |
boolean |
equals(java.lang.Object o)
Compares this group with an other object. |
java.util.List |
getFields()
Returns the list of fields for this group. |
GroupFooter |
getFooter()
Returns the group footer. |
GroupHeader |
getHeader()
Returns the group header. |
java.lang.String |
getName()
Returns the name of the group. |
StyleSheetCollection |
getStyleSheetCollection()
|
int |
hashCode()
Calculates the hashcode for this group. |
boolean |
isLastItemInGroup(DataRowBackend currentDataRow,
DataRowBackend nextDataRow)
Returns true if this is the last item in the group, and false otherwise. |
void |
setFields(java.util.List c)
Sets the fields for this group. |
void |
setFooter(GroupFooter footer)
Sets the footer for the group. |
void |
setHeader(GroupHeader header)
Sets the header for the group. |
void |
setName(java.lang.String name)
Defines the name for this group. |
void |
setStyleSheetCollection(StyleSheetCollection styleSheetCollection)
|
java.lang.String |
toString()
Returns a string representation of the group (useful for debugging). |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public Group()
Method Detail |
public void setName(java.lang.String name)
name
- the group name (null not permitted).public java.lang.String getName()
public GroupHeader getHeader()
The group header is a report band that contains elements that should be printed at the start of a group.
public void setHeader(GroupHeader header)
header
- the header (null not permitted).
java.lang.NullPointerException
- if the given header is nullpublic GroupFooter getFooter()
public void setFooter(GroupFooter footer)
footer
- the footer (null not permitted).public void setFields(java.util.List c)
c
- the list containing strings.
java.lang.NullPointerException
- if the given list is null or the list contains null-values.public void addField(java.lang.String name)
name
- the field name (null not permitted).
java.lang.NullPointerException
- if the name is nullpublic java.util.List getFields()
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
java.lang.CloneNotSupportedException
- should never be thrown.public boolean isLastItemInGroup(DataRowBackend currentDataRow, DataRowBackend nextDataRow)
currentDataRow
- the current data row.nextDataRow
- the next data row, or null, if this is the last datarow.
public boolean equals(java.lang.Object o)
o
- the object which should be compared with this group.
public int hashCode()
public int compareTo(java.lang.Object o)
compareTo
in interface java.lang.Comparable
o
- the to be compared object.
public java.lang.String toString()
public StyleSheetCollection getStyleSheetCollection()
public void setStyleSheetCollection(StyleSheetCollection styleSheetCollection)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |