com.inet.report

Class CrossTab

java.lang.Object

com.inet.report.ReportComponent

com.inet.report.Element

com.inet.report.CrossTab

All Implemented Interfaces:

BorderProperties, GeneralProperties, HyperlinkProperties, NodeParser, com.inet.report.ReferenceHolder, java.io.Serializable, java.lang.Cloneable

public class CrossTab
extends Element
implements com.inet.report.ReferenceHolder, HyperlinkProperties, BorderProperties

This class represents a cross table that has been or should be drawn in a report. A cross table is a report to summarize and visualize data in a compact form with rows and columns, so you can better compare data. Use this class to get or set properties. You can create and add a new cross table element with Section.addCrossTab(int, int, SummaryField) method in class Section. The last Argument of the method is the field the cross table needs at least.
This class is part of the RDC.

Since:

1.0

See Also:

Section.addCrossTab(int,int,SummaryField), Section.remove(Element), Section.getElements(), Section.getElementsV(), CrossTabBody, CrossTabHeaderList, CrossTabOptions, Serialized Form

Field Summary

Fields inherited from class com.inet.report.Element

BOX, CHART, CROSSTAB, CROSSTABSECTION, DATABASE_PICTURE, FIELD, FIELDPART, FORMFIELD, INTERACTIVE_SORTING, JAVABEAN, LINE, PARAGRAPH, PICTURE, SIGNATURE, SUBREPORT, TEXT, TEXTPART

Fields inherited from interface com.inet.report.BorderProperties

LINE_STYLE_DASHED, LINE_STYLE_DOTTED, LINE_STYLE_DOUBLE, LINE_STYLE_SINGLE, NO_LINE

Fields inherited from interface com.inet.report.GeneralProperties

ALIGN_HORIZONTAL_CENTER, ALIGN_HORIZONTAL_DEFAULT, ALIGN_HORIZONTAL_JUSTIFIED, ALIGN_HORIZONTAL_LEFT, ALIGN_HORIZONTAL_RIGHT

Method Summary

Modifier and Type	Method and Description
CrossTabBody	getBody() The body of the table.
CrossTabHeaderList	getColumns() The top headers of the table.
CrossTabGridLineFormat[]	getCrossTabGridLineFormat() Returns the gridline format of the crosstab.
CrossTabDescriptionSection	getDescriptionSection() Gets the description section of the crosstab.
CrossTabOptions	getOptions() The properties of the table.
java.util.List<FormulaField>	getPropertyFormulas() Returns a list with all property formulas that are set for this report element.
CrossTabHeaderList	getRows() The left headers of the table.
java.util.List<? extends ReportComponent>	getSubComponents() Returns all ReportComponents that are descendants of this one.
void	setCrossTabGridLineFormat(CrossTabGridLineFormat[] gridLines) Sets the gridline format of the crosstab.
void	setHeight(int height) This element can not be resized.
void	setWidth(int width) This element can not be resized.
void	swapHeaders() Swap the column and row headers.

Methods inherited from class com.inet.report.Element

addListener, copy, getBottomLineStyle, getBottomLineStyleFormula, getCanGrowCount, getCanGrowFormula, getCloseBorderOnPageBreakFormula, getDropShadowFormula, getEngine, getField, getForeColor, getForeColorFormula, getHorAlign, getHorAlignFormula, getHyperlinkUrl, getHyperlinkUrlFormula, getLeftLineStyle, getLeftLineStyleFormula, getParent, getRightLineStyle, getRightLineStyleFormula, getSuppressIfDuplicatedFormula, getTightHorizontalFormula, getToolTipsText, getToolTipsTextFormula, getTopLineStyle, getTopLineStyleFormula, indexOf, isCanGrow, isCloseBorderOnPageBreak, isDropShadow, isSuppressIfDuplicated, isTightHorizontal, paramString, removeListener, setBottomLineStyle, setBottomLineStyleFormula, setCanGrow, setCanGrowCount, setCanGrowFormula, setCloseBorderOnPageBreak, setCloseBorderOnPageBreakFormula, setDropShadow, setDropShadowFormula, setField, setForeColor, setForeColorFormula, setHorAlign, setHorAlignFormula, setHyperlinkUrl, setHyperlinkUrlFormula, setIndex, setLeftLineStyle, setLeftLineStyleFormula, setRightLineStyle, setRightLineStyleFormula, setSuppressIfDuplicated, setSuppressIfDuplicatedFormula, setTightHorizontal, setTightHorizontalFormula, setToolTipsText, setToolTipsTextFormula, setTopLineStyle, setTopLineStyleFormula

Methods inherited from class com.inet.report.ReportComponent

getBackColor, getBackColorFormula, getHeight, getKeepTogetherFormula, getSuppressFormula, getType, getWidth, getX, getY, isKeepTogether, isSuppress, setBackColor, setBackColorFormula, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula, setX, setY

Methods inherited from interface com.inet.report.HyperlinkProperties

getHyperlinkUrl, getHyperlinkUrlFormula, setHyperlinkUrl, setHyperlinkUrlFormula

Methods inherited from interface com.inet.report.BorderProperties

getBackColor, getBackColorFormula, getBottomLineStyle, getBottomLineStyleFormula, getCloseBorderOnPageBreakFormula, getDropShadowFormula, getForeColor, getForeColorFormula, getLeftLineStyle, getLeftLineStyleFormula, getRightLineStyle, getRightLineStyleFormula, getTightHorizontalFormula, getTopLineStyle, getTopLineStyleFormula, isCloseBorderOnPageBreak, isDropShadow, isTightHorizontal, setBackColor, setBackColorFormula, setBottomLineStyle, setBottomLineStyleFormula, setCloseBorderOnPageBreak, setCloseBorderOnPageBreakFormula, setDropShadow, setDropShadowFormula, setForeColor, setForeColorFormula, setLeftLineStyle, setLeftLineStyleFormula, setRightLineStyle, setRightLineStyleFormula, setTightHorizontal, setTightHorizontalFormula, setTopLineStyle, setTopLineStyleFormula

Methods inherited from interface com.inet.report.GeneralProperties

getKeepTogetherFormula, getSuppressFormula, isKeepTogether, isSuppress, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula

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

isDOMParser, parseDOM, parseElement, parseEndElement, parseText

Method Detail

getDescriptionSection

public CrossTabDescriptionSection getDescriptionSection()

Gets the description section of the crosstab. This section can be used to add additional descriptions or decoration to the crosstab. The description section is located in the upper left corner of the crosstab.

Returns:

The description section of the crosstab

Since:

6.0

getColumns

public CrossTabHeaderList getColumns()

The top headers of the table.

Returns:

ever the same instance

Since:

12.0

getRows

public CrossTabHeaderList getRows()

The left headers of the table.

Returns:

ever the same instance

Since:

12.0

swapHeaders

public void swapHeaders()

Swap the column and row headers. The result is a rotated crosstab.

Since:

12.0

getOptions

public CrossTabOptions getOptions()

The properties of the table.

Returns:

ever the same instance

Since:

12.0

getBody

public CrossTabBody getBody()

The body of the table.

Returns:

ever the same instance

Since:

12.0

setWidth

public void setWidth(int width)

This element can not be resized. Invoking this method will have no effect. The size of this element depends on the width and height of its sub elements.

Overrides:

setWidth in class ReportComponent

Parameters:

width - Setting the width of the Crosstab has no effect.

Since:

6.0

setHeight

public void setHeight(int height)

This element can not be resized. Invoking this method will have no effect. The size of this element depends on the width and height of its sub elements.

Overrides:

setHeight in class ReportComponent

Parameters:

height - Setting the height of the Crosstab has no effect.

Since:

6.0

getCrossTabGridLineFormat

public CrossTabGridLineFormat[] getCrossTabGridLineFormat()

Returns the gridline format of the crosstab. The grid lines of the crosstab are for the row labels (vertical-, horizontal-lines, top-, bottom-, left-, right -border)
and for the column labels (vertical-, horizontal-lines, top-, bottom-, left-, right -border)
and for the cells (vertical-, horizontal-lines, bottom-, right -border)
which are 16 lines total.

Returns:

The array[16] of CrossTabGridLineFormat

Since:

6.0

setCrossTabGridLineFormat

public void setCrossTabGridLineFormat(CrossTabGridLineFormat[] gridLines)

Sets the gridline format of the crosstab. The grid lines of the crosstab are for the row labels (vertical-, horizontal-lines, top-, bottom-, left-, right -border)
and for the column labels (vertical-, horizontal-lines, top-, bottom-, left-, right -border)
and for the cells (vertical-, horizontal-lines, bottom-, right -border)
which are 16 lines total.

Parameters:

gridLines - The grid line format array obtained from #getCrossTabGridLineFormat().

Throws:

java.lang.IllegalArgumentException - if gridLines include not clonable instances

Since:

6.0

getPropertyFormulas

public java.util.List<FormulaField> getPropertyFormulas()

Returns a list with all property formulas that are set for this report element. This includes property formulas for any type of sub-component but excludes formulas for any descendant ReportComponent of this one. To get the property formulas for descendant ReportComponent use ReportComponent.getSubComponents()

Overrides:

getPropertyFormulas in class Element

Returns:

List of property formulas

getSubComponents

public java.util.List<? extends ReportComponent> getSubComponents()

Returns all ReportComponents that are descendants of this one. E.G. this will return all Element of a Section. But it's as well useful for CrossTabs or Text elements which have additional elements.

Specified by:

getSubComponents in class ReportComponent

Returns:

a list with all sub components which can be empty as well; will be null if the component has no descendants