Package net.sf.jasperreports.crosstabs.design

Class JRDesignCrosstabColumnGroup

java.lang.Object

net.sf.jasperreports.crosstabs.base.JRBaseCrosstabGroup

net.sf.jasperreports.crosstabs.design.JRDesignCrosstabGroup

net.sf.jasperreports.crosstabs.design.JRDesignCrosstabColumnGroup

All Implemented Interfaces:

Serializable, Cloneable, CrosstabBaseCloneable, JRCrosstabColumnGroup, JRCrosstabGroup, JRChangeEventsSupport, JRCloneable

public class JRDesignCrosstabColumnGroup
extends JRDesignCrosstabGroup
implements JRCrosstabColumnGroup

Crosstab column group implementation to be used for report designing.

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected JRCellContents	crosstabHeader
protected int	height
protected CrosstabColumnPositionEnum	position
static final String	PROPERTY_CROSSTAB_HEADER
static final String	PROPERTY_HEIGHT
static final String	PROPERTY_POSITION

Fields inherited from class net.sf.jasperreports.crosstabs.design.JRDesignCrosstabGroup

designVariable, parent, PROPERTY_BUCKET, PROPERTY_HEADER, PROPERTY_MERGE_HEADER_CELLS, PROPERTY_NAME, PROPERTY_TOTAL_HEADER, PROPERTY_TOTAL_POSITION

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

bucket, header, mergeHeaderCells, name, totalHeader, totalPosition, variable

Constructor Summary

Constructors

Constructor	Description
JRDesignCrosstabColumnGroup()	Creates a column group.

Method Summary

Modifier and Type	Method	Description
Object	clone()
JRCellContents	getCrosstabHeader()	Returns the crosstab header cell of the column group.
int	getHeight()	Returns the height of the group headers.
CrosstabColumnPositionEnum	getPosition()	Returns the position of the header contents for header stretching.
void	setCrosstabHeader(JRDesignCellContents crosstabHeader)
protected void	setCrosstabHeaderOrigin()
void	setHeader(JRDesignCellContents header)	Sets the group header cell.
void	setHeight(int height)	Sets the header cell height.
void	setPosition(CrosstabColumnPositionEnum position)	Sets the header contents stretch position.
void	setTotalHeader(JRDesignCellContents totalHeader)	Sets the group total header cell.

Methods inherited from class net.sf.jasperreports.crosstabs.design.JRDesignCrosstabGroup

clone, getEventSupport, getParent, setBucket, setCellOrigin, setMergeHeaderCells, setName, setTotalPosition

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.jasperreports.crosstabs.JRCrosstabGroup

getBucket, getHeader, getMergeHeaderCells, getName, getTotalHeader, getTotalPosition, getVariable, hasTotal

Field Details

PROPERTY_HEIGHT

public static final String PROPERTY_HEIGHT

See Also:

• Constant Field Values

PROPERTY_POSITION

public static final String PROPERTY_POSITION

See Also:

• Constant Field Values

PROPERTY_CROSSTAB_HEADER

public static final String PROPERTY_CROSSTAB_HEADER

See Also:

• Constant Field Values

height

protected int height

position

protected CrosstabColumnPositionEnum position

crosstabHeader

protected JRCellContents crosstabHeader

Constructor Details

JRDesignCrosstabColumnGroup

public JRDesignCrosstabColumnGroup()

Creates a column group.

Method Details

getPosition

public CrosstabColumnPositionEnum getPosition()

Description copied from interface: JRCrosstabColumnGroup

Returns the position of the header contents for header stretching.

The column group headers stretch horizontally when there are multiple sub group entries. The header contents will be adjusted to the new width depending on this attribute:

• CrosstabColumnPositionEnum.LEFT - the contents will be rendered on the left side of the header
• CrosstabColumnPositionEnum.CENTER - the contents will be rendered on the center of the header
• CrosstabColumnPositionEnum.RIGHT - the contents will be rendered on the right side of the header
• CrosstabColumnPositionEnum.STRETCH - the contents will be proportionally stretched to the new header size

Specified by:

getPosition in interface JRCrosstabColumnGroup

Returns:

the position of the header contents for header stretching

setPosition

public void setPosition(CrosstabColumnPositionEnum position)

Sets the header contents stretch position.

Parameters:

position - the header contents stretch position

See Also:

• JRCrosstabColumnGroup.getPosition()

getHeight

public int getHeight()

Description copied from interface: JRCrosstabColumnGroup

Returns the height of the group headers.

Specified by:

getHeight in interface JRCrosstabColumnGroup

Returns:

the height of the group headers

See Also:

• JRCrosstabGroup.getHeader()
• JRCrosstabGroup.getTotalHeader()

setHeight

public void setHeight(int height)

Sets the header cell height.

Parameters:

height - the height

See Also:

• JRCrosstabColumnGroup.getHeight()

setHeader

public void setHeader(JRDesignCellContents header)

Description copied from class: JRDesignCrosstabGroup

Sets the group header cell.

Overrides:

setHeader in class JRDesignCrosstabGroup

Parameters:

header - the header cell

See Also:

• JRCrosstabGroup.getHeader()

setTotalHeader

public void setTotalHeader(JRDesignCellContents totalHeader)

Description copied from class: JRDesignCrosstabGroup

Sets the group total header cell.

Overrides:

setTotalHeader in class JRDesignCrosstabGroup

Parameters:

totalHeader - the total header

See Also:

• JRCrosstabGroup.getTotalHeader()

getCrosstabHeader

public JRCellContents getCrosstabHeader()

Description copied from interface: JRCrosstabColumnGroup

Returns the crosstab header cell of the column group.

The cell will be rendered at the left of the corresponding row of column headers, potentially overlapping the crosstab header cell.

The width of the cell is the total width of row group headers, and the height is the height of the corresponding column header.

Specified by:

getCrosstabHeader in interface JRCrosstabColumnGroup

Returns:

the crosstab header cell of the column group, or null if no header cell is present

See Also:

• JRCrosstab.getHeaderCell()
• JRCrosstabColumnGroup.getHeight()

setCrosstabHeader

public void setCrosstabHeader(JRDesignCellContents crosstabHeader)

setCrosstabHeaderOrigin

protected void setCrosstabHeaderOrigin()

clone

public Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class JRDesignCrosstabGroup