|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.jasperreports.crosstabs.base.JRBaseCrosstabGroup
public abstract class JRBaseCrosstabGroup
Base read-only implementation for crosstab row and column groups.
Field Summary | |
---|---|
protected JRCrosstabBucket |
bucket
|
protected JRCellContents |
header
|
protected java.lang.String |
name
|
protected JRCellContents |
totalHeader
|
protected CrosstabTotalPositionEnum |
totalPositionValue
|
protected JRVariable |
variable
|
Constructor Summary | |
---|---|
protected |
JRBaseCrosstabGroup()
|
|
JRBaseCrosstabGroup(JRCrosstabGroup group,
JRBaseObjectFactory factory)
|
Method Summary | |
---|---|
java.lang.Object |
clone()
|
JRCrosstabBucket |
getBucket()
Returns the bucketing information for this group. |
JRCellContents |
getHeader()
Returns the group header cell. |
java.lang.String |
getName()
Returns the name of the group. |
JRCellContents |
getTotalHeader()
Returns the group total header cell. |
CrosstabTotalPositionEnum |
getTotalPositionValue()
Returns the position of the total row/column for this group. |
JRVariable |
getVariable()
Returns the variable associated to this group. |
boolean |
hasTotal()
Returns whether the group has a total row/column. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.lang.String name
protected CrosstabTotalPositionEnum totalPositionValue
protected JRCrosstabBucket bucket
protected JRCellContents header
protected JRCellContents totalHeader
protected JRVariable variable
Constructor Detail |
---|
protected JRBaseCrosstabGroup()
public JRBaseCrosstabGroup(JRCrosstabGroup group, JRBaseObjectFactory factory)
Method Detail |
---|
public java.lang.String getName()
JRCrosstabGroup
getName
in interface JRCrosstabGroup
JRCrosstabGroup.getVariable()
public JRCrosstabBucket getBucket()
JRCrosstabGroup
The bucketing information consists of grouping expression and group ordering.
getBucket
in interface JRCrosstabGroup
public CrosstabTotalPositionEnum getTotalPositionValue()
JRCrosstabGroup
A group can have a total row/column summing the values for all the entries in the group. E.g. if there is a Year group having Month as a subgroup, the total row/column for the Year group would sum the values for all the years and the total row/column for the Month group would sum the values for all the months of an year.
Possible values for this attribute are:
CrosstabTotalPositionEnum.NONE
- the group will not display a total row/columnCrosstabTotalPositionEnum.START
- the group will display the total row/column before the group rows/columnsCrosstabTotalPositionEnum.END
- the group will display the total row/column at the end of the group rows/columns
getTotalPositionValue
in interface JRCrosstabGroup
public boolean hasTotal()
JRCrosstabGroup
This method is currently equivalent to
getTotalPosition() != Bucket.TOTAL_POSITION_NONE
and is therefore
redundant.
hasTotal
in interface JRCrosstabGroup
public JRCellContents getHeader()
JRCrosstabGroup
The size of the header cell is computed based on the following rules (only the row header rules are listed, the ones for columns can be deducted by simmetrical duality):
JRCrosstabRowGroup.getWidth()
Should never return null, but empty cell contents instead.
getHeader
in interface JRCrosstabGroup
public JRCellContents getTotalHeader()
JRCrosstabGroup
The size of a row group total header is computed based on the following rules:
Should never return null, but empty cell contents instead.
getTotalHeader
in interface JRCrosstabGroup
public JRVariable getVariable()
JRCrosstabGroup
Each group in the crosstab has a variable that can be used inside the group header as the current group value. The variable has the same name as the group and the same type as the bucket expression of the group.
getVariable
in interface JRCrosstabGroup
public java.lang.Object clone()
clone
in interface JRCloneable
clone
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |