Package net.sf.jasperreports.components.table

Class StandardBaseColumn

java.lang.Object

net.sf.jasperreports.components.table.StandardBaseColumn

All Implemented Interfaces:

Serializable, Cloneable, BaseColumn, JRChangeEventsSupport, JRCloneable, JRIdentifiable, JRPropertiesHolder

Direct Known Subclasses:

StandardColumn, StandardColumnGroup

public abstract class StandardBaseColumn
extends Object
implements BaseColumn, Serializable, JRChangeEventsSupport

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROPERTY_COLUMN_FOOTER
static String	PROPERTY_COLUMN_HEADER
static String	PROPERTY_GROUP_FOOTERS
static String	PROPERTY_GROUP_HEADERS
static String	PROPERTY_PRINT_WHEN_EXPRESSION
static String	PROPERTY_TABLE_FOOTER
static String	PROPERTY_TABLE_HEADER
static String	PROPERTY_WIDTH

Constructor Summary

Constructors

Constructor	Description
StandardBaseColumn()
StandardBaseColumn(BaseColumn column, ColumnFactory factory)

Method Summary

Modifier and Type	Method	Description
void	addGroupFooter(GroupCell groupCell)
void	addGroupHeader(GroupCell groupCell)
void	addPropertyExpression(JRPropertyExpression propertyExpression)	Add a dynamic/expression-based property.
Object	clone()
protected int	findGroupCellIndex(List<GroupCell> groupCells, String groupName)
Cell	getColumnFooter()
Cell	getColumnHeader()
JRPropertyChangeSupport	getEventSupport()	Returns the property change support object for this instance.
Cell	getGroupFooter(String groupName)
List<GroupCell>	getGroupFooters()
Cell	getGroupHeader(String groupName)
List<GroupCell>	getGroupHeaders()
JRPropertiesHolder	getParentProperties()	Returns the parent properties holder, whose properties are used as defaults for this object.
JRExpression	getPrintWhenExpression()
JRPropertiesMap	getPropertiesMap()	Returns this object's properties map.
JRPropertyExpression[]	getPropertyExpressions()
List<JRPropertyExpression>	getPropertyExpressionsList()	Returns the list of property expressions.
Cell	getTableFooter()
Cell	getTableHeader()
UUID	getUUID()
Integer	getWidth()
boolean	hasProperties()	Checks whether the object has any properties.
boolean	removeGroupFooter(GroupCell groupCell)
boolean	removeGroupHeader(GroupCell groupCell)
JRPropertyExpression	removePropertyExpression(String name)	Remove a property expression.
void	removePropertyExpression(JRPropertyExpression propertyExpression)	Remove a property expression.
void	setColumnFooter(Cell header)
void	setColumnHeader(Cell header)
void	setGroupFooter(String groupName, Cell cell)
void	setGroupFooters(List<GroupCell> groupFooters)
void	setGroupHeader(String groupName, Cell cell)
void	setGroupHeaders(List<GroupCell> groupHeaders)
void	setPrintWhenExpression(JRExpression printWhenExpression)
void	setTableFooter(Cell tableFooter)
void	setTableHeader(Cell tableHeader)
void	setUUID(UUID uuid)
void	setWidth(Integer width)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.jasperreports.components.table.BaseColumn

visitColumn

Field Detail

PROPERTY_PRINT_WHEN_EXPRESSION

public static final String PROPERTY_PRINT_WHEN_EXPRESSION

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_WIDTH

public static final String PROPERTY_WIDTH

See Also:

Constant Field Values

Constructor Detail

StandardBaseColumn

public StandardBaseColumn()

StandardBaseColumn

public StandardBaseColumn(BaseColumn column,
                          ColumnFactory factory)

Method Detail

getUUID

public UUID getUUID()

Specified by:

getUUID in interface JRIdentifiable

setUUID

public void setUUID(UUID uuid)

getColumnHeader

public Cell getColumnHeader()

Specified by:

getColumnHeader in interface BaseColumn

getColumnFooter

public Cell getColumnFooter()

Specified by:

getColumnFooter in interface BaseColumn

getPrintWhenExpression

public JRExpression getPrintWhenExpression()

Specified by:

getPrintWhenExpression in interface BaseColumn

setPrintWhenExpression

public void setPrintWhenExpression(JRExpression printWhenExpression)

setColumnHeader

public void setColumnHeader(Cell header)

setColumnFooter

public void setColumnFooter(Cell header)

clone

public Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class Object

getTableHeader

public Cell getTableHeader()

Specified by:

getTableHeader in interface BaseColumn

setTableHeader

public void setTableHeader(Cell tableHeader)

getTableFooter

public Cell getTableFooter()

Specified by:

getTableFooter in interface BaseColumn

setTableFooter

public void setTableFooter(Cell tableFooter)

getWidth

public Integer getWidth()

Specified by:

getWidth in interface BaseColumn

setWidth

public void setWidth(Integer width)

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

getGroupHeaders

public List<GroupCell> getGroupHeaders()

Specified by:

getGroupHeaders in interface BaseColumn

getGroupFooters

public List<GroupCell> getGroupFooters()

Specified by:

getGroupFooters in interface BaseColumn

findGroupCellIndex

protected int findGroupCellIndex(List<GroupCell> groupCells,
                                 String groupName)

getGroupFooter

public Cell getGroupFooter(String groupName)

Specified by:

getGroupFooter in interface BaseColumn

getGroupHeader

public Cell getGroupHeader(String groupName)

Specified by:

getGroupHeader in interface BaseColumn

setGroupHeaders

public void setGroupHeaders(List<GroupCell> groupHeaders)

setGroupFooters

public void setGroupFooters(List<GroupCell> groupFooters)

addGroupHeader

public void addGroupHeader(GroupCell groupCell)

addGroupFooter

public void addGroupFooter(GroupCell groupCell)

removeGroupFooter

public boolean removeGroupFooter(GroupCell groupCell)

removeGroupHeader

public boolean removeGroupHeader(GroupCell groupCell)

setGroupFooter

public void setGroupFooter(String groupName,
                           Cell cell)

setGroupHeader

public void setGroupHeader(String groupName,
                           Cell cell)

hasProperties

public boolean hasProperties()

Description copied from interface: JRPropertiesHolder

Checks whether the object has any properties.

Specified by:

hasProperties in interface JRPropertiesHolder

Returns:

whether the object has any properties

getPropertiesMap

public JRPropertiesMap getPropertiesMap()

Description copied from interface: JRPropertiesHolder

Returns this object's properties map.

Specified by:

getPropertiesMap in interface JRPropertiesHolder

Returns:

this object's properties map

getParentProperties

public JRPropertiesHolder getParentProperties()

Description copied from interface: JRPropertiesHolder

Returns the parent properties holder, whose properties are used as defaults for this object.

Specified by:

getParentProperties in interface JRPropertiesHolder

Returns:

the parent properties holder, or null if no parent

getPropertyExpressions

public JRPropertyExpression[] getPropertyExpressions()

Specified by:

getPropertyExpressions in interface BaseColumn

addPropertyExpression

public void addPropertyExpression(JRPropertyExpression propertyExpression)

Add a dynamic/expression-based property.

Parameters:

propertyExpression - the property to add

See Also:

getPropertyExpressions()

removePropertyExpression

public void removePropertyExpression(JRPropertyExpression propertyExpression)

Remove a property expression.

Parameters:

propertyExpression - the property expression to remove

See Also:

addPropertyExpression(JRPropertyExpression)

removePropertyExpression

public JRPropertyExpression removePropertyExpression(String name)

Remove a property expression.

Parameters:

name - the name of the property to remove

Returns:

the removed property expression (if found)

getPropertyExpressionsList

public List<JRPropertyExpression> getPropertyExpressionsList()

Returns the list of property expressions.

Returns:

the list of property expressions (JRPropertyExpression instances)

See Also:

addPropertyExpression(JRPropertyExpression)