Class JRBaseCrosstab
- java.lang.Object
-
- net.sf.jasperreports.engine.base.JRBaseElement
-
- net.sf.jasperreports.crosstabs.base.JRBaseCrosstab
-
- All Implemented Interfaces:
Serializable
,Cloneable
,JRCrosstab
,JRChangeEventsSupport
,JRBoxContainer
,JRChild
,JRCloneable
,JRCommonElement
,JRElement
,JRIdentifiable
,JRPropertiesHolder
,JRStyleContainer
,JRVisitable
public class JRBaseCrosstab extends JRBaseElement implements JRCrosstab
Base read-onlycrosstab
implementation.- Author:
- Lucian Chirita (lucianc@users.sourceforge.net)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected JRCrosstabCell[][]
cells
protected Integer
columnBreakOffset
protected JRCrosstabColumnGroup[]
columnGroups
protected JRCrosstabDataset
dataset
protected JRCellContents
headerCell
protected HorizontalPosition
horizontalPosition
protected int
id
protected Boolean
ignoreWidth
protected JRLineBox
lineBox
protected JRCrosstabMeasure[]
measures
protected JRCrosstabParameter[]
parameters
protected JRExpression
parametersMapExpression
static String
PROPERTY_HORIZONTAL_POSITION
static String
PROPERTY_IGNORE_WIDTH
static String
PROPERTY_RUN_DIRECTION
protected boolean
repeatColumnHeaders
protected boolean
repeatRowHeaders
protected JRCrosstabRowGroup[]
rowGroups
protected RunDirectionEnum
runDirection
protected CrosstabColumnCell
titleCell
protected JRVariable[]
variables
protected JRCellContents
whenNoDataCell
-
Fields inherited from class net.sf.jasperreports.engine.base.JRBaseElement
backcolor, defaultStyleProvider, elementGroup, forecolor, height, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, key, mode, parentStyle, parentStyleNameReference, positionType, printWhenExpression, printWhenGroupChanges, PROPERTY_POSITION_TYPE, PROPERTY_PRINT_IN_FIRST_WHOLE_BAND, PROPERTY_PRINT_REPEATED_VALUES, PROPERTY_PRINT_WHEN_DETAIL_OVERFLOWS, PROPERTY_REMOVE_LINE_WHEN_BLANK, PROPERTY_STRETCH_TYPE, PROPERTY_WIDTH, PROPERTY_X, stretchType, styleExpression, uuid, width, x, y
-
Fields inherited from interface net.sf.jasperreports.crosstabs.JRCrosstab
DEFAULT_COLUMN_BREAK_OFFSET, VARIABLE_COLUMN_COUNT, VARIABLE_IS_EVEN_COLUMN, VARIABLE_IS_EVEN_ROW, VARIABLE_ROW_COUNT
-
Fields inherited from interface net.sf.jasperreports.engine.JRElement
PROPERTY_ELEMENT_TEMPLATE_POPULATE_STYLE
-
-
Constructor Summary
Constructors Constructor Description JRBaseCrosstab(JRCrosstab crosstab, JRBaseObjectFactory factory, int id)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
clone()
void
collectExpressions(JRExpressionCollector collector)
JRCrosstabCell[][]
getCells()
Returns the data cell matrix.Integer
getColumnBreakOffset()
Returns the column break offset.JRCrosstabColumnGroup[]
getColumnGroups()
Returns the column groups of the crosstab.JRCrosstabDataset
getDataset()
Returns the input dataset of the crosstab.Color
getDefaultLineColor()
JRElement
getElementByKey(String elementKey)
Searches for an element inside all crosstab cells.static JRElement
getElementByKey(JRCrosstab crosstab, String key)
JRCellContents
getHeaderCell()
Returns a cell which will be rendered at the upper-left corner of the crosstab.HorizontalPosition
getHorizontalPosition()
Returns the position of the crosstab within its element box.int
getId()
Returns the ID of the crosstab.Boolean
getIgnoreWidth()
Returns the ignore width flag for the crosstab.JRLineBox
getLineBox()
JRCrosstabMeasure[]
getMeasures()
Returns the crosstab measures.ModeEnum
getMode()
Returns the element transparency mode.JRCrosstabParameter[]
getParameters()
Returns the crosstab parameters.JRExpression
getParametersMapExpression()
Returns the parameters map expression.JRCrosstabRowGroup[]
getRowGroups()
Returns the row groups of the crosstab.RunDirectionEnum
getRunDirection()
Retrieves the run direction of this crosstabCrosstabColumnCell
getTitleCell()
Returns the title cell, which renders once at the beginning of the crosstab.JRVariable[]
getVariables()
Returns the variables defined for the crosstab.JRCellContents
getWhenNoDataCell()
Returns a cell which will be rendered when no data was fed to the crosstab.boolean
isRepeatColumnHeaders()
Returns whether to repeat the column headers after a row break.boolean
isRepeatRowHeaders()
Returns whether to repeat the row headers after a column break.void
setHorizontalPosition(HorizontalPosition horizontalPosition)
Sets the position of the crosstab within its element box.void
setIgnoreWidth(Boolean ignoreWidth)
Set the ignore width crosstab flag.void
setRunDirection(RunDirectionEnum runDirection)
Sets the run direction of the crosstab.void
visit(JRVisitor visitor)
-
Methods inherited from class net.sf.jasperreports.engine.base.JRBaseElement
clone, clone, getBackcolor, getBaseStyle, getDefaultStyleProvider, getElementGroup, getEventSupport, getForecolor, getHeight, getKey, getOwnBackcolor, getOwnForecolor, getOwnMode, getParentProperties, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertiesMap, getPropertyExpressions, getStretchType, getStyle, getStyleExpression, getStyleNameReference, getStyleResolver, getUUID, getWidth, getX, getY, hasProperties, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setUUID, setWidth, setX
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.sf.jasperreports.engine.JRCommonElement
getBackcolor, getForecolor, getHeight, getKey, getOwnBackcolor, getOwnForecolor, getOwnMode, getWidth, setBackcolor, setForecolor, setMode
-
Methods inherited from interface net.sf.jasperreports.engine.JRElement
clone, getElementGroup, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertyExpressions, getStretchType, getStyleExpression, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setX
-
Methods inherited from interface net.sf.jasperreports.engine.JRIdentifiable
getUUID
-
Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder
getParentProperties, getPropertiesMap, hasProperties
-
Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer
getDefaultStyleProvider, getStyle, getStyleName, getStyleNameReference
-
-
-
-
Field Detail
-
PROPERTY_RUN_DIRECTION
public static final String PROPERTY_RUN_DIRECTION
- See Also:
- Constant Field Values
-
PROPERTY_HORIZONTAL_POSITION
public static final String PROPERTY_HORIZONTAL_POSITION
- See Also:
- Constant Field Values
-
PROPERTY_IGNORE_WIDTH
public static final String PROPERTY_IGNORE_WIDTH
- See Also:
- Constant Field Values
-
id
protected int id
-
parameters
protected JRCrosstabParameter[] parameters
-
variables
protected JRVariable[] variables
-
parametersMapExpression
protected JRExpression parametersMapExpression
-
dataset
protected JRCrosstabDataset dataset
-
rowGroups
protected JRCrosstabRowGroup[] rowGroups
-
columnGroups
protected JRCrosstabColumnGroup[] columnGroups
-
measures
protected JRCrosstabMeasure[] measures
-
columnBreakOffset
protected Integer columnBreakOffset
-
repeatColumnHeaders
protected boolean repeatColumnHeaders
-
repeatRowHeaders
protected boolean repeatRowHeaders
-
runDirection
protected RunDirectionEnum runDirection
-
horizontalPosition
protected HorizontalPosition horizontalPosition
-
cells
protected JRCrosstabCell[][] cells
-
whenNoDataCell
protected JRCellContents whenNoDataCell
-
titleCell
protected CrosstabColumnCell titleCell
-
headerCell
protected JRCellContents headerCell
-
ignoreWidth
protected Boolean ignoreWidth
-
lineBox
protected JRLineBox lineBox
-
-
Constructor Detail
-
JRBaseCrosstab
public JRBaseCrosstab(JRCrosstab crosstab, JRBaseObjectFactory factory, int id)
-
-
Method Detail
-
getMode
public ModeEnum getMode()
Description copied from interface:JRCommonElement
Returns the element transparency mode. The default value depends on the type of the report element. Graphic elements like rectangles and lines are opaque by default, but the images are transparent. Both static texts and text fields are transparent by default, and so are the subreport elements.- Specified by:
getMode
in interfaceJRCommonElement
- Overrides:
getMode
in classJRBaseElement
-
getId
public int getId()
Description copied from interface:JRCrosstab
Returns the ID of the crosstab.The ID is generated when the report is compiled and is used internally.
- Specified by:
getId
in interfaceJRCrosstab
- Returns:
- the ID of the crosstab
-
getDataset
public JRCrosstabDataset getDataset()
Description copied from interface:JRCrosstab
Returns the input dataset of the crosstab.- Specified by:
getDataset
in interfaceJRCrosstab
- Returns:
- the input dataset of the crosstab
-
getRowGroups
public JRCrosstabRowGroup[] getRowGroups()
Description copied from interface:JRCrosstab
Returns the row groups of the crosstab.- Specified by:
getRowGroups
in interfaceJRCrosstab
- Returns:
- the row groups
-
getColumnGroups
public JRCrosstabColumnGroup[] getColumnGroups()
Description copied from interface:JRCrosstab
Returns the column groups of the crosstab.- Specified by:
getColumnGroups
in interfaceJRCrosstab
- Returns:
- the column groups
-
getMeasures
public JRCrosstabMeasure[] getMeasures()
Description copied from interface:JRCrosstab
Returns the crosstab measures.- Specified by:
getMeasures
in interfaceJRCrosstab
- Returns:
- the crosstab measures
-
collectExpressions
public void collectExpressions(JRExpressionCollector collector)
- Specified by:
collectExpressions
in interfaceJRElement
-
visit
public void visit(JRVisitor visitor)
- Specified by:
visit
in interfaceJRVisitable
-
getColumnBreakOffset
public Integer getColumnBreakOffset()
Description copied from interface:JRCrosstab
Returns the column break offset.When the crosstab columns do not fit the width, the crosstab breaks the columns and prints the ones that don't fit after printing the first set of columns for all rows. This method returns the offset to be used when continuing the printing after a column break.
- Specified by:
getColumnBreakOffset
in interfaceJRCrosstab
- Returns:
- the column break offset
-
isRepeatColumnHeaders
public boolean isRepeatColumnHeaders()
Description copied from interface:JRCrosstab
Returns whether to repeat the column headers after a row break.- Specified by:
isRepeatColumnHeaders
in interfaceJRCrosstab
- Returns:
- whether to repeat the column headers after a row break
-
isRepeatRowHeaders
public boolean isRepeatRowHeaders()
Description copied from interface:JRCrosstab
Returns whether to repeat the row headers after a column break.- Specified by:
isRepeatRowHeaders
in interfaceJRCrosstab
- Returns:
- whether to repeat the row headers after a column break
-
getCells
public JRCrosstabCell[][] getCells()
Description copied from interface:JRCrosstab
Returns the data cell matrix.A crosstab can have multiple data cells for row/groups totals. These cells are organized in a (rowGroupCount + 1) x (columnGroupCount + 1) matrix as following:
- the row index of a cell is
- the row group index, if the cell corresponds to a total row
- rowGroupCount, otherwise
- the column index of a cell is
- the column group index, if the cell corresponds to a total column
- columnGroupCount, otherwise
E.g. if the crosstab has Country and City (subgroup of Country) row groups and Year and Month column groups, the cells will be organized in the following matrix
0/Years total 1/Months total 2/Base 0/Countries total Total for all countries and all years Total for all countries and a year Total for all countries and a month 1/Cities total Total for a country and all years Total for a country and a year Total for a country and a month 2/Base Total for a city and all years Total for a city and a year Total for a city and a month If the data cell for a total row/column is not specified, the cell will be inherited from lower levels, if possible. For example, if the "Total for all countries and a year" cell is not specified, the "Total for a country and a year" or "Total for a city and a year" cell will be used (in this order).
The data cell sizes are calculated from the base data cell sizes, i.e. the height of all data cells for a row will be the height of the base cell of that row. The base cell sizes are also inherited, e.g. if the height of a total row is not specified the height of the base row will be used.
- Specified by:
getCells
in interfaceJRCrosstab
- Returns:
- the data cell matrix
- the row index of a cell is
-
getParameters
public JRCrosstabParameter[] getParameters()
Description copied from interface:JRCrosstab
Returns the crosstab parameters.Crosstabs have separate expression evaluators and cannot access the parameters/fields/variables of the report. In order to use a value from the report inside a crosstab, it should be passed as parameter to the crosstab.
A crosstab parameters has a name and a value expression.
- Specified by:
getParameters
in interfaceJRCrosstab
- Returns:
- the crosstab parameters
-
getParametersMapExpression
public JRExpression getParametersMapExpression()
Description copied from interface:JRCrosstab
Returns the parameters map expression.The set of values for crosstab parameters can be set using a map. If a parameter has also a value expression, it will overwrite the value from the map.
- Specified by:
getParametersMapExpression
in interfaceJRCrosstab
- Returns:
- the parameters map expression
-
getWhenNoDataCell
public JRCellContents getWhenNoDataCell()
Description copied from interface:JRCrosstab
Returns a cell which will be rendered when no data was fed to the crosstab.If this cell is not specified for a crosstab, nothing will be rendered for an empty crosstab.
The cell sizes are the same as the crosstab element sizes.
- Specified by:
getWhenNoDataCell
in interfaceJRCrosstab
- Returns:
- a cell which will be rendered when no data was fed to the crosstab
-
getElementByKey
public static JRElement getElementByKey(JRCrosstab crosstab, String key)
-
getElementByKey
public JRElement getElementByKey(String elementKey)
Description copied from interface:JRCrosstab
Searches for an element inside all crosstab cells.- Specified by:
getElementByKey
in interfaceJRCrosstab
- Parameters:
elementKey
- the element key- Returns:
- the first element having the specified key
-
getTitleCell
public CrosstabColumnCell getTitleCell()
Description copied from interface:JRCrosstab
Returns the title cell, which renders once at the beginning of the crosstab.- Specified by:
getTitleCell
in interfaceJRCrosstab
- Returns:
- the title cell
-
getHeaderCell
public JRCellContents getHeaderCell()
Description copied from interface:JRCrosstab
Returns a cell which will be rendered at the upper-left corner of the crosstab. The cell size will be calculated based on the row/column header cell widths/heights.- Specified by:
getHeaderCell
in interfaceJRCrosstab
- Returns:
- a cell which will be rendered at the upper-left corner of the crosstab
-
getVariables
public JRVariable[] getVariables()
Description copied from interface:JRCrosstab
Returns the variables defined for the crosstab.- Specified by:
getVariables
in interfaceJRCrosstab
- Returns:
- variables defined for the crosstab
- See Also:
JRCrosstabGroup.getVariable()
,JRCrosstabMeasure.getVariable()
,JRCrosstab.VARIABLE_ROW_COUNT
,JRCrosstab.VARIABLE_IS_EVEN_ROW
,JRCrosstab.VARIABLE_COLUMN_COUNT
,JRCrosstab.VARIABLE_IS_EVEN_COLUMN
-
getRunDirection
public RunDirectionEnum getRunDirection()
Description copied from interface:JRCrosstab
Retrieves the run direction of this crosstab- Specified by:
getRunDirection
in interfaceJRCrosstab
- Returns:
- a value representing one of the run direction constants in
RunDirectionEnum
-
setRunDirection
public void setRunDirection(RunDirectionEnum runDirection)
Description copied from interface:JRCrosstab
Sets the run direction of the crosstab.Crosstabs can either be filled from left to right (the default) or from right to left (mainly for reports in RTL languages).
- Specified by:
setRunDirection
in interfaceJRCrosstab
- Parameters:
runDirection
- a value representing one of the run direction constants inRunDirectionEnum
-
getHorizontalPosition
public HorizontalPosition getHorizontalPosition()
Description copied from interface:JRCrosstab
Returns the position of the crosstab within its element box.- Specified by:
getHorizontalPosition
in interfaceJRCrosstab
- Returns:
- the position of the crosstab within its element box,
null
if no position is specified
-
setHorizontalPosition
public void setHorizontalPosition(HorizontalPosition horizontalPosition)
Description copied from interface:JRCrosstab
Sets the position of the crosstab within its element box.- Specified by:
setHorizontalPosition
in interfaceJRCrosstab
- Parameters:
horizontalPosition
- the crosstab position, ifnull
the default position is applied
-
clone
public Object clone()
- Specified by:
clone
in interfaceJRCloneable
- Overrides:
clone
in classJRBaseElement
-
getIgnoreWidth
public Boolean getIgnoreWidth()
Description copied from interface:JRCrosstab
Returns the ignore width flag for the crosstab.- Specified by:
getIgnoreWidth
in interfaceJRCrosstab
- Returns:
- the ignore width flag, or
null
is the crosstab does not specify a flag value - See Also:
JRCrosstab.setIgnoreWidth(Boolean)
-
setIgnoreWidth
public void setIgnoreWidth(Boolean ignoreWidth)
Description copied from interface:JRCrosstab
Set the ignore width crosstab flag.This flag determines whether the crosstab will break at the width set for the crosstab element, or whether the crosstab is to expand over this width (and over the page width as well).
If this flag is set to
true
, the crosstab will expand towards the right (or towards the left if the crosstab direction is RTL) as long as it needs to. This would result in crosstab cells being rendered over the page boundary; such elements will be exported by certain grid-based exporters such as the HTML or XLS ones, but will not be visible in export formats that observe the page width, such as the PDF exporter.The default value of this flag is given by the
JRCrosstab.PROPERTY_IGNORE_WIDTH
property and theJRParameter.IS_IGNORE_PAGINATION
parameter.- Specified by:
setIgnoreWidth
in interfaceJRCrosstab
- Parameters:
ignoreWidth
- whether the element width is to be ignored by the crosstab, ornull
if the default setting is to be used- See Also:
JRCrosstab.PROPERTY_IGNORE_WIDTH
-
getDefaultLineColor
public Color getDefaultLineColor()
- Specified by:
getDefaultLineColor
in interfaceJRBoxContainer
-
getLineBox
public JRLineBox getLineBox()
- Specified by:
getLineBox
in interfaceJRBoxContainer
-
-