net.sf.jasperreports.crosstabs

Interface JRCellContents

All Superinterfaces:

Cloneable, JRBoxContainer, JRChild, JRCloneable, JRElementGroup, JRPropertiesHolder, JRStyleContainer, JRVisitable

All Known Implementing Classes:

JRBaseCellContents, JRDesignCellContents, JRFillCellContents

public interface JRCellContents
extends JRElementGroup, JRStyleContainer, JRBoxContainer, JRPropertiesHolder

Crosstab cell contents interface.

This interface is used for both crosstab row/column headers and data cells.

There are some restrictions/rules regarding crosstab cells:

• subreports, crosstabs and charts are not allowed
• delayed evaluation for text fields and images is not allowed
• cells cannot split on multiple pages

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static int	NOT_CALCULATED Width or height value indicating that the value has not been computed.
static String	PROPERTIES_PREFIX A prefix used for properties that are set on frames generated by crosstab cells.
static String	PROPERTY_COLUMN_SPAN A property that provides the crosstab column span of a print frame.
static String	PROPERTY_ROW_SPAN A property that provides the crosstab row span of a print frame.
static String	PROPERTY_TYPE A property that provides the type of the cell that generated a print frame.
static String	TYPE_COLUMN_HEADER Type used by the column header cells.
static String	TYPE_CROSSTAB_HEADER Type used by the crosstab header cell.
static String	TYPE_CROSSTAB_TITLE Type used by the crosstab title cell.
static String	TYPE_DATA Type used by the crosstab data cells.
static String	TYPE_NO_DATA_CELL Type used by the crosstab "no data" cell.
static String	TYPE_ROW_HEADER Type used by the row header cells.

Method Summary

Modifier and Type	Method and Description
Color	getBackcolor() Returns the cell background color.
int	getHeight() Returns the computed cell height.
ModeEnum	getModeValue() Returns the cell transparency mode.
int	getWidth() Returns the computed cell width.

Methods inherited from interface net.sf.jasperreports.engine.JRElementGroup

getChildren, getElementByKey, getElementGroup, getElements

Methods inherited from interface net.sf.jasperreports.engine.JRChild

clone

Methods inherited from interface net.sf.jasperreports.engine.JRVisitable

visit

Methods inherited from interface net.sf.jasperreports.engine.JRCloneable

clone

Methods inherited from interface net.sf.jasperreports.engine.JRBoxContainer

getDefaultLineColor, getLineBox

Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer

getDefaultStyleProvider, getStyle, getStyleNameReference

Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder

getParentProperties, getPropertiesMap, hasProperties

Field Detail

NOT_CALCULATED

static final int NOT_CALCULATED

Width or height value indicating that the value has not been computed.

See Also:

Constant Field Values

PROPERTIES_PREFIX

static final String PROPERTIES_PREFIX

A prefix used for properties that are set on frames generated by crosstab cells.

See Also:

JRPrintFrame, Constant Field Values

PROPERTY_TYPE

static final String PROPERTY_TYPE

A property that provides the type of the cell that generated a print frame.

The property value is one of

• TYPE_CROSSTAB_HEADER
• TYPE_COLUMN_HEADER
• TYPE_ROW_HEADER
• TYPE_DATA
• TYPE_NO_DATA_CELL

See Also:

Constant Field Values

PROPERTY_ROW_SPAN

static final String PROPERTY_ROW_SPAN

A property that provides the crosstab row span of a print frame.

See Also:

Constant Field Values

PROPERTY_COLUMN_SPAN

static final String PROPERTY_COLUMN_SPAN

A property that provides the crosstab column span of a print frame.

See Also:

Constant Field Values

TYPE_CROSSTAB_TITLE

static final String TYPE_CROSSTAB_TITLE

Type used by the crosstab title cell.

See Also:

PROPERTY_TYPE, Constant Field Values

TYPE_CROSSTAB_HEADER

static final String TYPE_CROSSTAB_HEADER

Type used by the crosstab header cell.

See Also:

PROPERTY_TYPE, Constant Field Values

TYPE_ROW_HEADER

static final String TYPE_ROW_HEADER

Type used by the row header cells.

See Also:

JRCrosstabGroup.getHeader(), JRCrosstabGroup.getTotalHeader(), PROPERTY_TYPE, Constant Field Values

TYPE_COLUMN_HEADER

static final String TYPE_COLUMN_HEADER

Type used by the column header cells.

See Also:

JRCrosstabGroup.getHeader(), JRCrosstabGroup.getTotalHeader(), PROPERTY_TYPE, Constant Field Values

TYPE_DATA

static final String TYPE_DATA

Type used by the crosstab data cells.

See Also:

PROPERTY_TYPE, Constant Field Values

TYPE_NO_DATA_CELL

static final String TYPE_NO_DATA_CELL

Type used by the crosstab "no data" cell.

See Also:

PROPERTY_TYPE, Constant Field Values

Method Detail

getBackcolor

Color getBackcolor()

Returns the cell background color.

The cell is filled with the background color only if the cell has opaque mode.

Returns:

the cell backcolor

getWidth

int getWidth()

Returns the computed cell width.

Returns:

the computed cell width

See Also:

NOT_CALCULATED

getHeight

int getHeight()

Returns the computed cell height.

Returns:

the computed cell height

See Also:

NOT_CALCULATED

getModeValue

ModeEnum getModeValue()

Returns the cell transparency mode.

Returns:

ModeEnum.OPAQUE or ModeEnum.TRANSPARENT