com.inet.report

Class CrossTabHeader

java.lang.Object

com.inet.report.CrossTabHeader

All Implemented Interfaces:

NodeParser, java.io.Serializable

public class CrossTabHeader
extends java.lang.Object
implements NodeParser, java.io.Serializable

A single CrossTab header. There are headers for rows (left) and columns (top).

Since:

12.0

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
int	getBackColor() Returns the background color of the header as ABGR, i.e. 0x000000FF for red.
FormulaField	getBackColorFormula() Returns the formula of the background color of the header as ABGR, i.e. 0x000000FF for red.
Field	getField() The field of the grouping.
FieldElement	getFieldElement() Returns the field element of this row.
Group	getGroup() Returns the group object of this row.
int	getHeight() Position of this header, is used from designer.
boolean	getSuppressGroupLabel() Returns whether group labels should be suppressed (true) or not (false).
FormulaField	getSuppressGroupLabelFormula() Returns the formula for the property 'suppress group labels'.
boolean	getSuppressTotal() Returns whether total of this header should be suppressed true or not (false).
FormulaField	getSuppressTotalFormula() Returns the formula for the property 'suppress total'.
Text	getText() Returns the text element of this row.
int	getWidth() Position of this header, is used from designer.
int	getX() Position of this header, is used from designer.
int	getY() Position of this header, is used from designer.
boolean	isRow() If this header is currently a row header or a column header.
void	setBackColor(int backColor) Sets the background color of the header.
void	setBackColorFormula(FormulaField backColorFormula) Sets the formula of the background color of the header.
void	setField(Field field) Set the field of grouping.
void	setSuppressGroupLabel(boolean suppressGroupLabel) Sets whether group labels should be suppressed (true) or not (false).
void	setSuppressGroupLabelFormula(FormulaField newFormula) Sets the formula for the property 'suppress group labels'.
void	setSuppressTotal(boolean suppressTotal) Sets whether sub total should be suppressed (true) or not (false).
void	setSuppressTotalFormula(FormulaField newFormula) Sets the formula for the property 'suppress sub totals'.

Methods inherited from interface com.inet.report.parser.NodeParser

isDOMParser, parseDOM, parseElement, parseEndElement, parseText

Method Detail

isRow

public boolean isRow()

If this header is currently a row header or a column header.

Returns:

true, if it is a row header.

Since:

12.0

getX

public int getX()

Position of this header, is used from designer.

Returns:

the x position

Since:

12.0

getY

public int getY()

Position of this header, is used from designer.

Returns:

the y position

Since:

12.0

getWidth

public int getWidth()

Position of this header, is used from designer.

Returns:

the width

Since:

12.0

getHeight

public int getHeight()

Position of this header, is used from designer.

Returns:

the height

Since:

12.0

getSuppressTotal

public boolean getSuppressTotal()

Returns whether total of this header should be suppressed true or not (false).

Returns:

True if the sub total is suppressed or not.

Since:

12.0

See Also:

setSuppressTotal(boolean)

getSuppressTotalFormula

@Nullable
public FormulaField getSuppressTotalFormula()

Returns the formula for the property 'suppress total'. If this property is enabled total of this header will not be printed.

Returns:

The FormulaField of suppress sub total formula.

Since:

12.0

setSuppressTotal

public void setSuppressTotal(boolean suppressTotal)

Sets whether sub total should be suppressed (true) or not (false).

Parameters:

suppressTotal - True if sub total should be suppressed else false.

Since:

12.0

setSuppressTotalFormula

public void setSuppressTotalFormula(FormulaField newFormula)

Sets the formula for the property 'suppress sub totals'. If this property is enabled group label of the row will not be printed.

Parameters:

newFormula - The new formula for the property 'suppress sub totals'.

Since:

12.0

setSuppressGroupLabel

public void setSuppressGroupLabel(boolean suppressGroupLabel)

Sets whether group labels should be suppressed (true) or not (false).

Parameters:

suppressGroupLabel - True if group label should be suppressed else false.

Since:

12.0

setSuppressGroupLabelFormula

public void setSuppressGroupLabelFormula(FormulaField newFormula)

Sets the formula for the property 'suppress group labels'. If this property is enabled group label of the row will not be printed.

Parameters:

newFormula - The new formula for the property 'suppress group labels'.

Since:

12.0

getSuppressGroupLabel

public boolean getSuppressGroupLabel()

Returns whether group labels should be suppressed (true) or not (false).

Returns:

boolean True if the group labels is suppressed or not.

Since:

12.0

See Also:

CrossTabRow.setSuppressGroupLabel(boolean)

getSuppressGroupLabelFormula

@Nullable
public FormulaField getSuppressGroupLabelFormula()

Returns the formula for the property 'suppress group labels'. If this property is enabled group label of the row will not be printed.

Returns:

The formulaField of Suppress Group Label Formula.

Since:

12.0

getGroup

@Nullable
public Group getGroup()

Returns the group object of this row. The group will be null if this row is a total row. Set the group options of this row with the returned group object, i.e. the customize group name options and sort options.

Returns:

Group The group object of this row

Since:

12.0

See Also:

Group

getField

@Nullable
public Field getField()

The field of the grouping.

Returns:

the field

Since:

12.0

setField

public void setField(Field field)

Set the field of grouping.

Parameters:

field - the new field, can not be null

Since:

12.0

getText

public Text getText()

Returns the text element of this row. This text will displayed als total text of this row. You can use this methode to set your own total text.

Returns:

Total text of this row.

Since:

12.0

See Also:

Text

getFieldElement

@Nullable
public FieldElement getFieldElement()

Returns the field element of this row. You can use this method to format the fieldelement of this row.

Returns:

FieldElement of this row.

Since:

12.0

setBackColor

public void setBackColor(int backColor)

Sets the background color of the header.
You can use the ABGR value (i.e. 0x000000FF for red) or one of the color constants in class CoderXML.
More information about the usage of colors in RDC can be found in the RDC documentation.

Parameters:

backColor - the new ABGR value of the grand total background color.

Since:

12.0

See Also:

ColorUtils.toCcColor(Color), ColorUtils.toJavaColor(int)

getBackColor

public int getBackColor()

Returns the background color of the header as ABGR, i.e. 0x000000FF for red.

Returns:

ABGR value of the grand total row background color or -1 if cross table contains no rows.

Since:

12.0

See Also:

setBackColor(int), ColorUtils.toCcColor(Color), ColorUtils.toJavaColor(int)

setBackColorFormula

public void setBackColorFormula(FormulaField backColorFormula)

Sets the formula of the background color of the header.
You can use the ABGR value (i.e. 0x000000FF for red) or one of the color constants in class CoderXML.
More information about the usage of colors in RDC can be found in the RDC documentation.

Parameters:

backColorFormula - the new ABGR value of the grand total background color.

Since:

12.0

See Also:

ColorUtils.toCcColor(Color), ColorUtils.toJavaColor(int)

getBackColorFormula

@Nullable
public FormulaField getBackColorFormula()

Returns the formula of the background color of the header as ABGR, i.e. 0x000000FF for red.

Returns:

ABGR value of the grand total row background color or -1 if cross table contains no rows.

Since:

12.0

See Also:

ColorUtils.toCcColor(Color), ColorUtils.toJavaColor(int)