Package net.sf.jasperreports.engine.design

Class JRDesignBand

java.lang.Object

net.sf.jasperreports.engine.base.JRBaseElementGroup

net.sf.jasperreports.engine.design.JRDesignElementGroup

net.sf.jasperreports.engine.design.JRDesignBand

All Implemented Interfaces:

Serializable, Cloneable, JRChangeEventsSupport, JRBand, JRChild, JRCloneable, JRElementGroup, JRPropertiesHolder, JRVisitable

public class JRDesignBand
extends JRDesignElementGroup
implements JRBand

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	height
protected JRExpression	printWhenExpression
static String	PROPERTY_HEIGHT
static String	PROPERTY_PRINT_WHEN_EXPRESSION
static String	PROPERTY_RETURN_VALUES
protected List<ExpressionReturnValue>	returnValues
protected SplitTypeEnum	splitType

Fields inherited from class net.sf.jasperreports.engine.design.JRDesignElementGroup

PROPERTY_CHILDREN, PROPERTY_ELEMENT_GROUP

Fields inherited from class net.sf.jasperreports.engine.base.JRBaseElementGroup

children, elementGroup

Fields inherited from interface net.sf.jasperreports.engine.JRBand

PROPERTY_SPLIT_TYPE

Constructor Summary

Constructors

Constructor	Description
JRDesignBand()

Method Summary

Modifier and Type	Method	Description
void	addReturnValue(ExpressionReturnValue returnValue)	Adds a return value to the band.
Object	clone()
int	getHeight()
JROrigin	getOrigin()	Returns the band origin, i.e. its location/role within the report (e.g. detail/title/group header/etc).
JRPropertiesHolder	getParentProperties()	Returns the parent properties holder, whose properties are used as defaults for this object.
JRExpression	getPrintWhenExpression()	Returns the boolean expression that specifies if the band will be displayed.
JRPropertiesMap	getPropertiesMap()	Returns this object's properties map.
List<ExpressionReturnValue>	getReturnValues()	Returns the list of values to increment report variables with.
List<ExpressionReturnValue>	getReturnValuesList()	Returns the list of values to increment report variables with.
SplitTypeEnum	getSplitType()	Specifies the band split behavior.
boolean	hasProperties()	Checks whether the object has any properties.
boolean	removeReturnValue(ExpressionReturnValue returnValue)	Removes a return value from the band.
void	setHeight(int height)
void	setPrintWhenExpression(JRExpression expression)
void	setSplitType(SplitTypeEnum splitType)

Methods inherited from class net.sf.jasperreports.engine.design.JRDesignElementGroup

addElement, addElement, addElement, addElementGroup, addElementGroup, getEventSupport, removeElement, removeElementGroup, setElementGroup

Methods inherited from class net.sf.jasperreports.engine.base.JRBaseElementGroup

clone, getChildren, getElementByKey, getElementByKey, getElementGroup, getElements, getElements, visit

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.JRChild

clone

Methods inherited from interface net.sf.jasperreports.engine.JRElementGroup

getChildren, getElementByKey, getElementGroup, getElements

Methods inherited from interface net.sf.jasperreports.engine.JRVisitable

visit

Field Detail

PROPERTY_HEIGHT

public static final String PROPERTY_HEIGHT

See Also:

Constant Field Values

PROPERTY_PRINT_WHEN_EXPRESSION

public static final String PROPERTY_PRINT_WHEN_EXPRESSION

See Also:

Constant Field Values

PROPERTY_RETURN_VALUES

public static final String PROPERTY_RETURN_VALUES

See Also:

Constant Field Values

height

protected int height

splitType

protected SplitTypeEnum splitType

printWhenExpression

protected JRExpression printWhenExpression

returnValues

protected List<ExpressionReturnValue> returnValues

Constructor Detail

JRDesignBand

public JRDesignBand()

Method Detail

getHeight

public int getHeight()

Specified by:

getHeight in interface JRBand

setHeight

public void setHeight(int height)

getSplitType

public SplitTypeEnum getSplitType()

Description copied from interface: JRBand

Specifies the band split behavior.

Specified by:

getSplitType in interface JRBand

setSplitType

public void setSplitType(SplitTypeEnum splitType)

Specified by:

setSplitType in interface JRBand

getPrintWhenExpression

public JRExpression getPrintWhenExpression()

Description copied from interface: JRBand

Returns the boolean expression that specifies if the band will be displayed.

Specified by:

getPrintWhenExpression in interface JRBand

setPrintWhenExpression

public void setPrintWhenExpression(JRExpression expression)

getOrigin

public JROrigin getOrigin()

Returns the band origin, i.e. its location/role within the report (e.g. detail/title/group header/etc). The location is automatically set when the band is inserted into the report (via one of the setTitle / setPageHeader methods).

Returns:

the band origin

getReturnValues

public List<ExpressionReturnValue> getReturnValues()

Description copied from interface: JRBand

Returns the list of values to increment report variables with.

Specified by:

getReturnValues in interface JRBand

Returns:

the list of returned values.

addReturnValue

public void addReturnValue(ExpressionReturnValue returnValue)

Adds a return value to the band.

Parameters:

returnValue - the return value to be added.

getReturnValuesList

public List<ExpressionReturnValue> getReturnValuesList()

Returns the list of values to increment report variables with.

Returns:

list of ReturnValue objects

removeReturnValue

public boolean removeReturnValue(ExpressionReturnValue returnValue)

Removes a return value from the band.

Parameters:

returnValue - the return value to be removed

Returns:

true if the return value was found and removed

clone

public Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class JRDesignElementGroup

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