Package net.sf.jasperreports.engine.fill

Class JRFillBand

java.lang.Object

net.sf.jasperreports.engine.fill.JRFillElementGroup

net.sf.jasperreports.engine.fill.JRFillElementContainer

net.sf.jasperreports.engine.fill.JRFillBand

All Implemented Interfaces:

Cloneable, FillContainerContext, JRFillCloneable, JROriginProvider, JRBand, JRChild, JRCloneable, JRElementGroup, JRPropertiesHolder, JRVisitable

public class JRFillBand
extends JRFillElementContainer
implements JRBand, JROriginProvider

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field	Description
protected JROrigin	origin

Fields inherited from class net.sf.jasperreports.engine.fill.JRFillElementContainer

atLeastOneElementIsToPrint, currentOverflowWithElements, currentOverflowWithWhiteSpace, deepElements, evaluatedStyles, expressionEvaluator, filler, hasPrintWhenOverflowElement, isOverflow, stylesToEvaluate, willOverflowWithElements, willOverflowWithWhiteSpace

Fields inherited from class net.sf.jasperreports.engine.fill.JRFillElementGroup

bottomElementInGroup, children, elementGroup, elements, topElementInGroup

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

PROPERTY_SPLIT_TYPE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JRFillBand(JRBaseFiller filler, JRBand band, JRFillObjectFactory factory)

Method Summary

Modifier and Type	Method	Description
protected void	addNowEvaluationTime(JREvaluationTime evaluationTime)
protected void	addNowEvaluationTimes(JREvaluationTime[] evaluationTimes)
protected void	evaluate(byte evaluation)
protected void	evaluatePrintWhenExpression(byte evaluation)
protected JRPrintBand	fill()
protected JRPrintBand	fill(int availableHeight)
protected JRPrintBand	fill(int availableHeight, boolean isOverflowAllowed)
protected int	getActualContainerHeight()	Returns the actual height of the element container.
int	getBreakHeight()
protected int	getContainerHeight()	Returns the height of the element container.
int	getHeight()
protected int	getId()
JROrigin	getOrigin()	Returns an element origin.
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.
SplitTypeEnum	getSplitType()	Specifies the band split behavior.
boolean	hasProperties()	Checks whether the object has any properties.
protected boolean	isColumnBand()
protected boolean	isEmpty()
protected boolean	isFirstWholeOnPageColumn()	Decides whether this band is the for whole band on the page/column.
protected boolean	isNewGroup(String group)
protected boolean	isNewPageColumn()
protected boolean	isNowEvaluationTime(JREvaluationTime evaluationTime)
protected boolean	isPageBreakInhibited()
protected boolean	isPrintWhenExpressionNull()
protected boolean	isPrintWhenTrue()
protected boolean	isSplitPrevented()
protected boolean	isSplitTypePreventInhibited()
boolean	isSplitTypePreventInhibited(boolean isTopLevelCall)
protected boolean	isToPrint()
protected boolean	isVariableUsedInReturns(String variableName)
protected JRPrintBand	refill(byte evaluation, int availableHeight)
void	registerReturnValues(FillReturnValues fillReturnValues)
protected void	resetSavedVariables()
protected void	restoreSavedVariables()
protected void	saveVariable(String variableName)
protected void	setNewGroup(JRGroup group, boolean isNew)
protected void	setNewPageColumn(boolean isNew)
protected void	setOrigin(JROrigin origin)
protected void	setPrintWhenTrue(boolean isPrintWhenTrue)
void	setSplitType(SplitTypeEnum splitType)
protected boolean	willOverflowWithElements()

Methods inherited from class net.sf.jasperreports.engine.fill.JRFillElementContainer

addSubElements, buildConsolidatedStyle, calculateStretchHeight, collectConditionalStyle, evaluateConditionalStyle, evaluateConditionalStyles, fillElements, getEvaluatedConditionalStyle, getFirstY, getStretchHeight, initConditionalStyles, initDeepElements, initElements, initFill, isCurrentOverflow, isCurrentOverflowAllowed, moveBandBottomElements, prepareElements, prepareStretchHeight, removeBlankElements, resetElements, rewind, setElementOriginProvider, setStretchHeight, stretchElementsToContainer, stretchElementsToElementGroup, willOverflow

Methods inherited from class net.sf.jasperreports.engine.fill.JRFillElementGroup

clone, clone, createClone, getChildren, getElementByKey, getElementGroup, getElements, getStretchHeightDiff, reset, 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.JRCloneable

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

origin

protected JROrigin origin

Constructor Detail

JRFillBand

protected JRFillBand(JRBaseFiller filler,
                     JRBand band,
                     JRFillObjectFactory factory)

Method Detail

getOrigin

public JROrigin getOrigin()

Description copied from interface: JROriginProvider

Returns an element origin.

Specified by:

getOrigin in interface JROriginProvider

Returns:

an element origin

setOrigin

protected void setOrigin(JROrigin origin)

setNewPageColumn

protected void setNewPageColumn(boolean isNew)

isNewPageColumn

protected boolean isNewPageColumn()

isFirstWholeOnPageColumn

protected boolean isFirstWholeOnPageColumn()

Decides whether this band is the for whole band on the page/column.

Returns:

whether this band is the for whole band on the page/column

setNewGroup

protected void setNewGroup(JRGroup group,
                           boolean isNew)

isNewGroup

protected boolean isNewGroup(String group)

getHeight

public int getHeight()

Specified by:

getHeight in interface JRBand

getBreakHeight

public int getBreakHeight()

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

isSplitPrevented

protected boolean isSplitPrevented()

isPrintWhenExpressionNull

protected boolean isPrintWhenExpressionNull()

isPrintWhenTrue

protected boolean isPrintWhenTrue()

setPrintWhenTrue

protected void setPrintWhenTrue(boolean isPrintWhenTrue)

isToPrint

protected boolean isToPrint()

evaluatePrintWhenExpression

protected void evaluatePrintWhenExpression(byte evaluation)
                                    throws JRException

Throws:

JRException

refill

protected JRPrintBand refill(byte evaluation,
                             int availableHeight)
                      throws JRException

Throws:

JRException

fill

protected JRPrintBand fill()
                    throws JRException

Throws:

JRException

fill

protected JRPrintBand fill(int availableHeight)
                    throws JRException

Throws:

JRException

fill

protected JRPrintBand fill(int availableHeight,
                           boolean isOverflowAllowed)
                    throws JRException

Throws:

JRException

willOverflowWithElements

protected boolean willOverflowWithElements()

getContainerHeight

protected int getContainerHeight()

Description copied from class: JRFillElementContainer

Returns the height of the element container.

Specified by:

getContainerHeight in class JRFillElementContainer

Returns:

the height of the element container

getActualContainerHeight

protected int getActualContainerHeight()

Description copied from class: JRFillElementContainer

Returns the actual height of the element container. Some element containers such as frames have a larger calculated container height, resulting from content being placed beyond container declared height.

Specified by:

getActualContainerHeight in class JRFillElementContainer

Returns:

the height of the element container

isVariableUsedInReturns

protected boolean isVariableUsedInReturns(String variableName)

addNowEvaluationTime

protected void addNowEvaluationTime(JREvaluationTime evaluationTime)

addNowEvaluationTimes

protected void addNowEvaluationTimes(JREvaluationTime[] evaluationTimes)

isNowEvaluationTime

protected boolean isNowEvaluationTime(JREvaluationTime evaluationTime)

getId

protected int getId()

evaluate

protected void evaluate(byte evaluation)
                 throws JRException

Overrides:

evaluate in class JRFillElementContainer

Throws:

JRException

resetSavedVariables

protected void resetSavedVariables()

saveVariable

protected void saveVariable(String variableName)

restoreSavedVariables

protected void restoreSavedVariables()

isEmpty

protected boolean isEmpty()

isColumnBand

protected boolean isColumnBand()

isPageBreakInhibited

protected boolean isPageBreakInhibited()

isSplitTypePreventInhibited

protected boolean isSplitTypePreventInhibited()

isSplitTypePreventInhibited

public boolean isSplitTypePreventInhibited(boolean isTopLevelCall)

Specified by:

isSplitTypePreventInhibited in interface FillContainerContext

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

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.

registerReturnValues

public void registerReturnValues(FillReturnValues fillReturnValues)