net.sf.jasperreports.crosstabs.design

Class JRDesignCrosstabGroup

java.lang.Object

net.sf.jasperreports.crosstabs.base.JRBaseCrosstabGroup

net.sf.jasperreports.crosstabs.design.JRDesignCrosstabGroup

All Implemented Interfaces:

Serializable, Cloneable, CrosstabBaseCloneable, JRCrosstabGroup, JRChangeEventsSupport, JRCloneable

Direct Known Subclasses:

JRDesignCrosstabColumnGroup, JRDesignCrosstabRowGroup

public abstract class JRDesignCrosstabGroup
extends JRBaseCrosstabGroup
implements JRChangeEventsSupport

Base crosstab row/column group implementation to be used at design time.

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected JRDesignVariable	designVariable
protected JRDesignCrosstab	parent
static String	PROPERTY_BUCKET
static String	PROPERTY_HEADER
static String	PROPERTY_MERGE_HEADER_CELLS
static String	PROPERTY_NAME
static String	PROPERTY_TOTAL_HEADER
static String	PROPERTY_TOTAL_POSITION

Fields inherited from class net.sf.jasperreports.crosstabs.base.JRBaseCrosstabGroup

bucket, header, mergeHeaderCells, name, totalHeader, totalPositionValue, variable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JRDesignCrosstabGroup()

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone()
JRDesignCrosstabGroup	clone(JRDesignCrosstab parent)
JRPropertyChangeSupport	getEventSupport() Returns the property change support object for this instance.
JRDesignCrosstab	getParent() Returns the group parent crosstab.
void	setBucket(JRDesignCrosstabBucket bucket) Sets the group bucketing information.
protected void	setCellOrigin(JRCellContents cell, JRCrosstabOrigin origin)
void	setHeader(JRDesignCellContents header) Sets the group header cell.
void	setMergeHeaderCells(Boolean mergeHeaderCells) Defines whether the header cell should span across entries in the group.
void	setName(String name) Sets the group name.
void	setTotalHeader(JRDesignCellContents totalHeader) Sets the group total header cell.
void	setTotalPosition(CrosstabTotalPositionEnum totalPositionValue) Sets the position of the total row/column.

Methods inherited from class net.sf.jasperreports.crosstabs.base.JRBaseCrosstabGroup

clone, getBucket, getHeader, getMergeHeaderCells, getName, getTotalHeader, getTotalPositionValue, getVariable, hasTotal

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTY_BUCKET

public static final String PROPERTY_BUCKET

See Also:

Constant Field Values

PROPERTY_HEADER

public static final String PROPERTY_HEADER

See Also:

Constant Field Values

PROPERTY_NAME

public static final String PROPERTY_NAME

See Also:

Constant Field Values

PROPERTY_TOTAL_HEADER

public static final String PROPERTY_TOTAL_HEADER

See Also:

Constant Field Values

PROPERTY_TOTAL_POSITION

public static final String PROPERTY_TOTAL_POSITION

See Also:

Constant Field Values

PROPERTY_MERGE_HEADER_CELLS

public static final String PROPERTY_MERGE_HEADER_CELLS

See Also:

Constant Field Values

designVariable

protected JRDesignVariable designVariable

parent

protected JRDesignCrosstab parent

Constructor Detail

JRDesignCrosstabGroup

protected JRDesignCrosstabGroup()

Method Detail

setName

public void setName(String name)

Sets the group name.

Parameters:

name - the name

See Also:

JRCrosstabGroup.getName()

setTotalPosition

public void setTotalPosition(CrosstabTotalPositionEnum totalPositionValue)

Sets the position of the total row/column.

Parameters:

totalPositionValue - the position of the total row/column

See Also:

JRCrosstabGroup.getTotalPositionValue()

setBucket

public void setBucket(JRDesignCrosstabBucket bucket)

Sets the group bucketing information.

Parameters:

bucket - the bucketing information

See Also:

JRCrosstabGroup.getBucket()

setHeader

public void setHeader(JRDesignCellContents header)

Sets the group header cell.

Parameters:

header - the header cell

See Also:

JRCrosstabGroup.getHeader()

setTotalHeader

public void setTotalHeader(JRDesignCellContents totalHeader)

Sets the group total header cell.

Parameters:

totalHeader - the total header

See Also:

JRCrosstabGroup.getTotalHeader()

setMergeHeaderCells

public void setMergeHeaderCells(Boolean mergeHeaderCells)

Defines whether the header cell should span across entries in the group.

Parameters:

mergeHeaderCells - whether the header cell should span across entries in the group; if null the default will apply

See Also:

JRCrosstabGroup.getMergeHeaderCells()

getParent

public JRDesignCrosstab getParent()

Returns the group parent crosstab.

The parent is automatically set when the group is added to the crosstab.

Returns:

the parent crosstab

setCellOrigin

protected void setCellOrigin(JRCellContents cell,
                 JRCrosstabOrigin origin)

clone

public Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class JRBaseCrosstabGroup

clone

public JRDesignCrosstabGroup clone(JRDesignCrosstab parent)

getEventSupport

public JRPropertyChangeSupport getEventSupport()

Description copied from interface: JRChangeEventsSupport

Returns the property change support object for this instance.

Specified by:

getEventSupport in interface JRChangeEventsSupport

Returns:

the property change support object for this instance