com.inet.report
Class CrossTabColumn

java.lang.Object
  com.inet.report.ReportComponent
      com.inet.report.Element
          com.inet.report.CrossTabColumn

All Implemented Interfaces:

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

public class CrossTabColumn
extends Element

A CrossTabColumn holds a field which values are used for the columns of the cross table, i.e. a dayplan would use a CrossTabColumn with a time-field. Each value of the field creates a new column in the cross table. To add a new CrossTabColumn use methods CrossTab.appendColumn(Field) in class CrossTab.

This class is part of the RDC.

See Also:

CrossTab, CrossTab.appendColumn(Field), Serialized Form

Field Summary

Fields inherited from class com.inet.report.Element

BOX, CHART, CROSSTAB, CROSSTABCELL, CROSSTABCOLUMN, CROSSTABROW, CROSSTABSECTION, DATABASE_PICTURE, FIELD, FIELDPART, 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

java.util.List	getCells() Returns the cells of this column.
FieldElement	getFieldElement() Returns the FieldElement whose field values are used for the columns of the cross table.
Group	getGroup() Returns the group object of this row.
java.util.List	getPropertyFormulas() Returns a list with all property formulas that are set for this report element.
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	getSuppressSubTotal() Returns whether sub total should be suppressed true or not (false).
FormulaField	getSuppressSubTotalFormula() Returns the formula for the property 'suppress sub total'.
Text	getTextElement() Returns the text element of this column containing the total text.
NodeParser	parseElement(com.inet.report.parser.XMLTag group, java.lang.String tag, org.xml.sax.Attributes atts, java.util.Map parserMap) FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XML Parses an XML node with the given information, and returns either a sub-element which was created as a result, or null if no sub-element was created, i.e. the information was applied to the ReportComponent itself.
void	parseEndElement(com.inet.report.parser.XMLTag group, java.lang.String tag, java.util.Map parserMap) FOR INTERNAL USE ONLY Internal method for reading report XML Receive notification of the end of an XML tag.
void	setField(Field newField) Sets the field definition element (for example, DatabaseField element, prompt field element).
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	setSuppressSubTotal(boolean suppressSubTotal) Sets the property 'suppress sub total' for this column.
void	setSuppressSubTotalFormula(FormulaField newFormula) Sets the formula for the property 'suppress sub totals'.
void	setX(int x) This element can not be moved.
void	setY(int y) This element can not be moved.

Methods inherited from class com.inet.report.Element

addListener, copy, copyXML2, 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, 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, setHeight, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula, setWidth

Methods inherited from interface com.inet.report.BorderProperties

getBackColor, getBackColorFormula, setBackColor, setBackColorFormula

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, parseText

Method Detail

getTextElement

public Text getTextElement()

Returns the text element of this column containing the total text.

Returns:

The Text containing the total text.

getFieldElement

public FieldElement getFieldElement()

Returns the FieldElement whose field values are used for the columns of the cross table.

Returns:

The FieldElement for this row.

getGroup

public Group getGroup()

Returns the group object of this row. The group is 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 option.

Returns:

Group the group of this column.

See Also:

Group

setX

public void setX(int x)

This element can not be moved. Invoking this methode will have no effect. The position of this element defined by the width and height of other crosstab subelements.

Overrides:

setX in class ReportComponent

Parameters:

x - This Methode does nothing.

setY

public void setY(int y)

This element can not be moved. Invoking this methode will have no effect. The position of this element defined by the width and height of other crosstab subelements.

Overrides:

setY in class ReportComponent

Parameters:

y - This Methode does nothing.

getSuppressSubTotal

public boolean getSuppressSubTotal()

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

Returns:

boolean

getSuppressSubTotalFormula

public FormulaField getSuppressSubTotalFormula()

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

Returns:

The formula for the property 'suppress sub total'

Since:

7.0

setSuppressSubTotal

public void setSuppressSubTotal(boolean suppressSubTotal)

Sets the property 'suppress sub total' for this column.

Parameters:

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

setSuppressSubTotalFormula

public void setSuppressSubTotalFormula(FormulaField newFormula)

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

Parameters:

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

Since:

7.0

setSuppressGroupLabel

public void setSuppressGroupLabel(boolean suppressGroupLabel)

Sets whether Group Labels should be suppressed (true) or not (false).

Parameters:

suppressGroupLabel - The suppressGroupLabel to set

setSuppressGroupLabelFormula

public void setSuppressGroupLabelFormula(FormulaField newFormula)

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

Parameters:

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

Since:

7.0

getSuppressGroupLabel

public boolean getSuppressGroupLabel()

Returns whether Group Labels should be suppressed (true) or not (false).

Returns:

boolean

getSuppressGroupLabelFormula

public FormulaField getSuppressGroupLabelFormula()

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

Returns:

The formula for the property 'suppress group labels'.

Since:

7.0

getPropertyFormulas

public java.util.List getPropertyFormulas()

Returns a list with all property formulas that are set for this report element.

Overrides:

getPropertyFormulas in class Element

Returns:

List of property formulas

parseElement

public NodeParser parseElement(com.inet.report.parser.XMLTag group,
                               java.lang.String tag,
                               org.xml.sax.Attributes atts,
                               java.util.Map parserMap)
                        throws FatalParserException

FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XML

Parses an XML node with the given information, and returns either a sub-element which was created as a result, or null if no sub-element was created, i.e. the information was applied to the ReportComponent itself. Note that the parsing is highly tolerant, i.e. exceptions are intercepted and suppressed if at all possible.

Specified by:

parseElement in interface NodeParser

Parameters:

group - XMLTag of the current node to be parsed, or null if there is no such current group. An XMLTag is a group of nodes bundled together, usually it is a Properties node such as CommonProperties, BorderProperties, etc.

tag - The XMLTag to be parsed

atts - The set of attributes in the current XMLTag

parserMap - The map of current Parser.

Returns:

The NodeParser sub-element if one needed to be created, or null if none was created.

Throws:

FatalParserException - if an exception occurs which causes the report to not be able to be read: causes the abortion of the reading of the report.

parseEndElement

public void parseEndElement(com.inet.report.parser.XMLTag group,
                            java.lang.String tag,
                            java.util.Map parserMap)
                     throws FatalParserException

FOR INTERNAL USE ONLY Internal method for reading report XML

Receive notification of the end of an XML tag.

Specified by:

parseEndElement in interface NodeParser

Parameters:

group - XMLTag of the current node to be parsed, or null if there is no such current group.

tag - The XMLTag to be parsed

parserMap - The map of current Parser.

Throws:

FatalParserException - if an exception occurs which causes the report to not be able to be read: causes the abortion of the reading of the report.

setField

public void setField(Field newField)

Sets the field definition element (for example, DatabaseField element, prompt field element).

Overrides:

setField in class Element

Parameters:

newField - The new field element of the property 'field'.

getCells

public java.util.List getCells()

Returns the cells of this column.

Returns:

the list of cells (not null)