Package net.sf.jasperreports.components.table

Class StandardTable

java.lang.Object

net.sf.jasperreports.components.table.StandardTable

All Implemented Interfaces:

Serializable, Cloneable, TableComponent, Component, DatasetRunHolder, JRChangeEventsSupport, JRCloneable, JRVisitable

public class StandardTable
extends Object
implements TableComponent, Serializable, JRChangeEventsSupport

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_COLUMN_FOOTER
static final String	PROPERTY_COLUMN_HEADER
static final String	PROPERTY_COLUMNS
static final String	PROPERTY_DATASET_RUN
static final String	PROPERTY_DETAIL
static final String	PROPERTY_GROUP_FOOTERS
static final String	PROPERTY_GROUP_HEADERS
static final String	PROPERTY_HORIZONTAL_POSITION
static final String	PROPERTY_NO_DATA
static final String	PROPERTY_SHRINK_WIDTH
static final String	PROPERTY_TABLE_FOOTER
static final String	PROPERTY_TABLE_HEADER
static final String	PROPERTY_WHEN_NO_DATA_TYPE

Fields inherited from interface net.sf.jasperreports.components.table.TableComponent

CONFIG_PROPERTY_COLUMN_WEIGHT, CONFIG_PROPERTY_HORIZONTAL_POSITION, CONFIG_PROPERTY_SHRINK_WIDTH, CONFIG_PROPERTY_WHEN_NO_DATA_TYPE

Constructor Summary

Constructors

Constructor	Description
StandardTable()
StandardTable(TableComponent table, JRBaseObjectFactory factory)

Method Summary

Modifier and Type	Method	Description
void	addColumn(int index, BaseColumn column)
void	addColumn(BaseColumn column)
void	addGroupFooter(GroupRow groupRow)
void	addGroupHeader(GroupRow groupRow)
Object	clone()
protected int	findGroupRowIndex(List<GroupRow> groupRows, String groupName)
Row	getColumnFooter()
Row	getColumnHeader()
List<BaseColumn>	getColumns()
JRDatasetRun	getDatasetRun()
Row	getDetail()
JRPropertyChangeSupport	getEventSupport()	Returns the property change support object for this instance.
Row	getGroupFooter(String groupName)
List<GroupRow>	getGroupFooters()
Row	getGroupHeader(String groupName)
List<GroupRow>	getGroupHeaders()
HorizontalPosition	getHorizontalPosition()	Returns the position of the table columns within the table element box.
BaseCell	getNoData()
Row	getTableFooter()
Row	getTableHeader()
WhenNoDataTypeTableEnum	getWhenNoDataType()
boolean	removeColumn(BaseColumn column)
boolean	removeGroupFooter(GroupRow groupRow)
boolean	removeGroupHeader(GroupRow groupRow)
void	setColumnFooter(Row header)
void	setColumnHeader(Row header)
void	setColumns(List<BaseColumn> columns)
void	setDatasetRun(JRDatasetRun datasetRun)
void	setDetail(Row detail)
void	setGroupFooter(String groupName, Row row)
void	setGroupFooters(List<GroupRow> groupFooters)
void	setGroupHeader(String groupName, Row row)
void	setGroupHeaders(List<GroupRow> groupHeaders)
void	setHorizontalPosition(HorizontalPosition horizontalPosition)	Sets the position of the table within its element box.
void	setNoData(BaseCell noData)
void	setShrinkWidth(Boolean shrinkWidth)
void	setTableFooter(Row tableFooter)
void	setTableHeader(Row tableHeader)
void	setWhenNoDataType(WhenNoDataTypeTableEnum whenNoDataType)
Boolean	shrinkWidth()	Specifies if the table box should shrink to accommodate the smaller total width of visible columns.
void	visit(JRVisitor visitor)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PROPERTY_DATASET_RUN

public static final String PROPERTY_DATASET_RUN

See Also:

• Constant Field Values

PROPERTY_COLUMNS

public static final String PROPERTY_COLUMNS

See Also:

• Constant Field Values

PROPERTY_WHEN_NO_DATA_TYPE

public static final String PROPERTY_WHEN_NO_DATA_TYPE

See Also:

• Constant Field Values

PROPERTY_HORIZONTAL_POSITION

public static final String PROPERTY_HORIZONTAL_POSITION

See Also:

• Constant Field Values

PROPERTY_SHRINK_WIDTH

public static final String PROPERTY_SHRINK_WIDTH

See Also:

• Constant Field Values

PROPERTY_TABLE_HEADER

public static final String PROPERTY_TABLE_HEADER

See Also:

• Constant Field Values

PROPERTY_TABLE_FOOTER

public static final String PROPERTY_TABLE_FOOTER

See Also:

• Constant Field Values

PROPERTY_COLUMN_HEADER

public static final String PROPERTY_COLUMN_HEADER

See Also:

• Constant Field Values

PROPERTY_COLUMN_FOOTER

public static final String PROPERTY_COLUMN_FOOTER

See Also:

• Constant Field Values

PROPERTY_GROUP_HEADERS

public static final String PROPERTY_GROUP_HEADERS

See Also:

• Constant Field Values

PROPERTY_GROUP_FOOTERS

public static final String PROPERTY_GROUP_FOOTERS

See Also:

• Constant Field Values

PROPERTY_DETAIL

public static final String PROPERTY_DETAIL

See Also:

• Constant Field Values

PROPERTY_NO_DATA

public static final String PROPERTY_NO_DATA

See Also:

• Constant Field Values

Constructor Details

StandardTable

public StandardTable()

StandardTable

public StandardTable(TableComponent table,
 JRBaseObjectFactory factory)

Method Details

getColumns

public List<BaseColumn> getColumns()

Specified by:

getColumns in interface TableComponent

setColumns

public void setColumns(List<BaseColumn> columns)

addColumn

public void addColumn(BaseColumn column)

addColumn

public void addColumn(int index,
 BaseColumn column)

removeColumn

public boolean removeColumn(BaseColumn column)

getDatasetRun

public JRDatasetRun getDatasetRun()

Specified by:

getDatasetRun in interface DatasetRunHolder

Specified by:

getDatasetRun in interface TableComponent

setDatasetRun

public void setDatasetRun(JRDatasetRun datasetRun)

getWhenNoDataType

public WhenNoDataTypeTableEnum getWhenNoDataType()

Specified by:

getWhenNoDataType in interface TableComponent

setWhenNoDataType

public void setWhenNoDataType(WhenNoDataTypeTableEnum whenNoDataType)

getHorizontalPosition

public HorizontalPosition getHorizontalPosition()

Description copied from interface: TableComponent

Returns the position of the table columns within the table element box.

Specified by:

getHorizontalPosition in interface TableComponent

Returns:

the position of the table columns within the table element box, null if no position is specified

setHorizontalPosition

public void setHorizontalPosition(HorizontalPosition horizontalPosition)

Sets the position of the table within its element box.

Parameters:

horizontalPosition - the table position, if null the default position is applied

shrinkWidth

public Boolean shrinkWidth()

Description copied from interface: TableComponent

Specifies if the table box should shrink to accommodate the smaller total width of visible columns.

Specified by:

shrinkWidth in interface TableComponent

setShrinkWidth

public void setShrinkWidth(Boolean shrinkWidth)

getTableHeader

public Row getTableHeader()

Specified by:

getTableHeader in interface TableComponent

setTableHeader

public void setTableHeader(Row tableHeader)

getTableFooter

public Row getTableFooter()

Specified by:

getTableFooter in interface TableComponent

setTableFooter

public void setTableFooter(Row tableFooter)

getGroupHeaders

public List<GroupRow> getGroupHeaders()

Specified by:

getGroupHeaders in interface TableComponent

getGroupFooters

public List<GroupRow> getGroupFooters()

Specified by:

getGroupFooters in interface TableComponent

findGroupRowIndex

protected int findGroupRowIndex(List<GroupRow> groupRows,
 String groupName)

getGroupFooter

public Row getGroupFooter(String groupName)

Specified by:

getGroupFooter in interface TableComponent

getGroupHeader

public Row getGroupHeader(String groupName)

Specified by:

getGroupHeader in interface TableComponent

setGroupHeaders

public void setGroupHeaders(List<GroupRow> groupHeaders)

setGroupFooters

public void setGroupFooters(List<GroupRow> groupFooters)

addGroupHeader

public void addGroupHeader(GroupRow groupRow)

addGroupFooter

public void addGroupFooter(GroupRow groupRow)

removeGroupFooter

public boolean removeGroupFooter(GroupRow groupRow)

removeGroupHeader

public boolean removeGroupHeader(GroupRow groupRow)

setGroupFooter

public void setGroupFooter(String groupName,
 Row row)

setGroupHeader

public void setGroupHeader(String groupName,
 Row row)

getColumnHeader

public Row getColumnHeader()

Specified by:

getColumnHeader in interface TableComponent

setColumnHeader

public void setColumnHeader(Row header)

getColumnFooter

public Row getColumnFooter()

Specified by:

getColumnFooter in interface TableComponent

setColumnFooter

public void setColumnFooter(Row header)

getDetail

public Row getDetail()

Specified by:

getDetail in interface TableComponent

setDetail

public void setDetail(Row detail)

getNoData

public BaseCell getNoData()

Specified by:

getNoData in interface TableComponent

setNoData

public void setNoData(BaseCell noData)

clone

public Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class Object

getEventSupport

public JRPropertyChangeSupport getEventSupport()

Description copied from interface: JRChangeEventsSupport

Returns the property change support object for this instance.

Specified by:

getEventSupport in interface JRChangeEventsSupport

Returns:

the property change support object for this instance

visit

public void visit(JRVisitor visitor)

Specified by:

visit in interface JRVisitable