net.sf.jasperreports.engine.fill

Class JRFillFrame

java.lang.Object

net.sf.jasperreports.engine.fill.JRFillElement

net.sf.jasperreports.engine.fill.JRFillFrame

All Implemented Interfaces:

java.lang.Cloneable, JRFillCloneable, JRBox, JRBoxContainer, JRChild, JRCloneable, JRCommonElement, JRElement, JRElementGroup, JRFrame, JRPropertiesHolder, JRStyleContainer, JRStyleSetter, JRVisitable

public class JRFillFrame
extends JRFillElement
implements JRFrame

Fill time implementation of a frame element.

Version:

$Id: JRFillFrame.java 3420 2010-02-18 09:17:47Z teodord $

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	JRFillFrame.JRFillFrameElements Frame element container filler.

Field Summary

Fields

Modifier and Type	Field and Description
protected JRLineBox	lineBox
protected JRFrame	parentFrame

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

band, conditionalStylesContainer, currentEvaluation, currentStyle, defaultStyleProvider, delayedEvaluationsMap, dynamicProperties, elementGroup, expressionEvaluator, filler, initStyle, mergedProperties, originProvider, parent, printWhenGroupChanges, staticProperties, templates

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

MODE_OPAQUE, MODE_TRANSPARENT, POSITION_TYPE_FIX_RELATIVE_TO_BOTTOM, POSITION_TYPE_FIX_RELATIVE_TO_TOP, POSITION_TYPE_FLOAT, STRETCH_TYPE_NO_STRETCH, STRETCH_TYPE_RELATIVE_TO_BAND_HEIGHT, STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT

Constructor Summary

Constructors

Modifier	Constructor and Description
	JRFillFrame(JRBaseFiller filler, JRFrame frame, JRFillObjectFactory factory)
protected	JRFillFrame(JRFillFrame frame, JRFillCloneFactory factory)

Method Summary

Methods

Modifier and Type	Method and Description
void	collectExpressions(JRExpressionCollector collector)
JRFillCloneable	createClone(JRFillCloneFactory factory) Creates a working clone of itself.
protected JRTemplateElement	createElementTemplate()
protected JRTemplateFrame	createFrameTemplate()
protected void	evaluate(byte evaluation)
protected JRPrintElement	fill()
byte	getBorder() Deprecated. Replaced by getLineBox()
java.awt.Color	getBorderColor() Deprecated. Replaced by getLineBox()
byte	getBottomBorder() Deprecated. Replaced by getLineBox()
java.awt.Color	getBottomBorderColor() Deprecated. Replaced by getLineBox()
int	getBottomPadding() Deprecated. Replaced by getLineBox()
java.util.List	getChildren() Gets a list of all direct children elements or elements groups.
java.awt.Color	getDefaultLineColor()
JRElement	getElementByKey(java.lang.String key) Gets an element from this group, based on its element key.
JRElement[]	getElements() Gets an array containing all the elements and element groups in the hierarchy.
byte	getLeftBorder() Deprecated. Replaced by getLineBox()
java.awt.Color	getLeftBorderColor() Deprecated. Replaced by getLineBox()
int	getLeftPadding() Deprecated. Replaced by getLineBox()
JRLineBox	getLineBox()
ModeEnum	getModeValue() Returns the element transparency mode.
java.lang.Byte	getOwnBorder() Deprecated. Replaced by getLineBox()
java.awt.Color	getOwnBorderColor() Deprecated. Replaced by getLineBox()
java.lang.Byte	getOwnBottomBorder() Deprecated. Replaced by getLineBox()
java.awt.Color	getOwnBottomBorderColor() Deprecated. Replaced by getLineBox()
java.lang.Integer	getOwnBottomPadding() Deprecated. Replaced by getLineBox()
java.lang.Byte	getOwnLeftBorder() Deprecated. Replaced by getLineBox()
java.awt.Color	getOwnLeftBorderColor() Deprecated. Replaced by getLineBox()
java.lang.Integer	getOwnLeftPadding() Deprecated. Replaced by getLineBox()
java.lang.Integer	getOwnPadding() Deprecated. Replaced by getLineBox()
java.lang.Byte	getOwnRightBorder() Deprecated. Replaced by getLineBox()
java.awt.Color	getOwnRightBorderColor() Deprecated. Replaced by getLineBox()
java.lang.Integer	getOwnRightPadding() Deprecated. Replaced by getLineBox()
java.lang.Byte	getOwnTopBorder() Deprecated. Replaced by getLineBox()
java.awt.Color	getOwnTopBorderColor() Deprecated. Replaced by getLineBox()
java.lang.Integer	getOwnTopPadding() Deprecated. Replaced by getLineBox()
int	getPadding() Deprecated. Replaced by getLineBox()
byte	getRightBorder() Deprecated. Replaced by getLineBox()
java.awt.Color	getRightBorderColor() Deprecated. Replaced by getLineBox()
int	getRightPadding() Deprecated. Replaced by getLineBox()
protected JRTemplateFrame	getTemplate()
byte	getTopBorder() Deprecated. Replaced by getLineBox()
java.awt.Color	getTopBorderColor() Deprecated. Replaced by getLineBox()
int	getTopPadding() Deprecated. Replaced by getLineBox()
protected boolean	prepare(int availableHeight, boolean isOverflow)
protected void	resolveElement(JRPrintElement element, byte evaluation) Resolves an element.
protected void	rewind()
void	setBorder(byte border) Deprecated. Replaced by getLineBox()
void	setBorder(java.lang.Byte border) Deprecated. Replaced by getLineBox()
void	setBorderColor(java.awt.Color borderColor) Deprecated. Replaced by getLineBox()
void	setBottomBorder(byte bottomBorder) Deprecated. Replaced by getLineBox()
void	setBottomBorder(java.lang.Byte bottomBorder) Deprecated. Replaced by getLineBox()
void	setBottomBorderColor(java.awt.Color bottomBorderColor) Deprecated. Replaced by getLineBox()
void	setBottomPadding(int bottomPadding) Deprecated. Replaced by getLineBox()
void	setBottomPadding(java.lang.Integer bottomPadding) Deprecated. Replaced by getLineBox()
void	setLeftBorder(byte leftBorder) Deprecated. Replaced by getLineBox()
void	setLeftBorder(java.lang.Byte leftBorder) Deprecated. Replaced by getLineBox()
void	setLeftBorderColor(java.awt.Color leftBorderColor) Deprecated. Replaced by getLineBox()
void	setLeftPadding(int leftPadding) Deprecated. Replaced by getLineBox()
void	setLeftPadding(java.lang.Integer leftPadding) Deprecated. Replaced by getLineBox()
void	setPadding(int padding) Deprecated. Replaced by getLineBox()
void	setPadding(java.lang.Integer padding) Deprecated. Replaced by getLineBox()
void	setRightBorder(byte rightBorder) Deprecated. Replaced by getLineBox()
void	setRightBorder(java.lang.Byte rightBorder) Deprecated. Replaced by getLineBox()
void	setRightBorderColor(java.awt.Color rightBorderColor) Deprecated. Replaced by getLineBox()
void	setRightPadding(int rightPadding) Deprecated. Replaced by getLineBox()
void	setRightPadding(java.lang.Integer rightPadding) Deprecated. Replaced by getLineBox()
protected void	setStretchHeight(int stretchHeight)
void	setTopBorder(byte topBorder) Deprecated. Replaced by getLineBox()
void	setTopBorder(java.lang.Byte topBorder) Deprecated. Replaced by getLineBox()
void	setTopBorderColor(java.awt.Color topBorderColor) Deprecated. Replaced by getLineBox()
void	setTopPadding(int topPadding) Deprecated. Replaced by getLineBox()
void	setTopPadding(java.lang.Integer topPadding) Deprecated. Replaced by getLineBox()
protected void	stretchHeightFinal() Called when the stretch height of an element is final so that the element can perform any adjustments.
void	visit(JRVisitor visitor)

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

addDependantElement, clone, clone, collectDelayedEvaluations, collectDelayedEvaluations, collectDelayedEvaluations, collectStyleDelayedEvaluations, delayedEvaluate, evaluateExpression, evaluatePrintWhenExpression, evaluateProperties, getBackcolor, getBand, getDefaultStyleProvider, getDependantElements, getElementGroup, getElementOrigin, getElementTemplate, getEvaluatedProperties, getEvaluationTimeValue, getField, getForecolor, getGroupElements, getHeight, getKey, getMode, getOwnBackcolor, getOwnForecolor, getOwnMode, getOwnModeValue, getParentProperties, getPositionType, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertiesMap, getPropertyExpressions, getRelativeY, getStretchHeight, getStretchType, getStretchTypeValue, getStyle, getStyleNameReference, getTemplate, getVariable, getWidth, getX, getY, hasProperties, initDelayedEvaluationPrint, initDelayedEvaluations, isAlreadyPrinted, isAutoEvaluateNow, isDelayedStyleEvaluation, isEvaluateAuto, isEvaluateNow, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isPrintWhenExpressionNull, isPrintWhenTrue, isRemoveLineWhenBlank, isReprinted, isToPrint, isValueRepeating, moveDependantElements, performDelayedEvaluation, registerTemplate, reset, resolveElement, setAlreadyPrinted, setBackcolor, setBand, setConditionalStylesContainer, setCurrentEvaluation, setForecolor, setHeight, setMode, setMode, setMode, setOriginProvider, setPositionType, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setPrintWhenExpressionNull, setPrintWhenTrue, setRelativeY, setRemoveLineWhenBlank, setReprinted, setShrinkable, setStretchType, setStretchType, setStyle, setStyleNameReference, setToPrint, setValueRepeating, setWidth, setX, setY, stretchElement, transferProperties, transferProperties

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

getElementGroup, getKey, getPositionType, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertyExpressions, getStretchType, getStretchTypeValue, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setPositionType, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setStretchType, setWidth, setX

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

getBackcolor, getForecolor, getHeight, getMode, getOwnBackcolor, getOwnForecolor, getOwnMode, getOwnModeValue, getWidth, setBackcolor, setForecolor, setMode, setMode, setMode

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

getDefaultStyleProvider, getStyle, getStyleNameReference

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

getParentProperties, getPropertiesMap, hasProperties

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

getElementGroup

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

clone

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

clone

Field Detail

parentFrame

protected final JRFrame parentFrame

lineBox

protected final JRLineBox lineBox

Constructor Detail

JRFillFrame

public JRFillFrame(JRBaseFiller filler,
           JRFrame frame,
           JRFillObjectFactory factory)

JRFillFrame

protected JRFillFrame(JRFillFrame frame,
           JRFillCloneFactory factory)

Method Detail

getModeValue

public ModeEnum getModeValue()

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:

getModeValue in interface JRCommonElement

Overrides:

getModeValue in class JRFillElement

getDefaultLineColor

public java.awt.Color getDefaultLineColor()

Specified by:

getDefaultLineColor in interface JRBoxContainer

evaluate

protected void evaluate(byte evaluation)
                 throws JRException

Specified by:

evaluate in class JRFillElement

Throws:

JRException

rewind

protected void rewind()
               throws JRException

Specified by:

rewind in class JRFillElement

Throws:

JRException

prepare

protected boolean prepare(int availableHeight,
              boolean isOverflow)
                   throws JRException

Overrides:

prepare in class JRFillElement

Throws:

JRException

setStretchHeight

protected void setStretchHeight(int stretchHeight)

Overrides:

setStretchHeight in class JRFillElement

stretchHeightFinal

protected void stretchHeightFinal()

Description copied from class: JRFillElement

Called when the stretch height of an element is final so that the element can perform any adjustments.

Overrides:

stretchHeightFinal in class JRFillElement

fill

protected JRPrintElement fill()
                       throws JRException

Specified by:

fill in class JRFillElement

Throws:

JRException

getTemplate

protected JRTemplateFrame getTemplate()

createFrameTemplate

protected JRTemplateFrame createFrameTemplate()

createElementTemplate

protected JRTemplateElement createElementTemplate()

Specified by:

createElementTemplate in class JRFillElement

resolveElement

protected void resolveElement(JRPrintElement element,
                  byte evaluation)

Description copied from class: JRFillElement

Resolves an element.

Specified by:

resolveElement in class JRFillElement

Parameters:

element - the element

evaluation - the evaluation type

getElements

public JRElement[] getElements()

Description copied from interface: JRElementGroup

Gets an array containing all the elements and element groups in the hierarchy.

Specified by:

getElements in interface JRElementGroup

getChildren

public java.util.List getChildren()

Description copied from interface: JRElementGroup

Gets a list of all direct children elements or elements groups.

Specified by:

getChildren in interface JRElementGroup

collectExpressions

public void collectExpressions(JRExpressionCollector collector)

Specified by:

collectExpressions in interface JRElement

getLineBox

public JRLineBox getLineBox()

Specified by:

getLineBox in interface JRBoxContainer

getBorder

public byte getBorder()

Deprecated. Replaced by getLineBox()

Specified by:

getBorder in interface JRBox

getOwnBorder

public java.lang.Byte getOwnBorder()

Deprecated. Replaced by getLineBox()

Specified by:

getOwnBorder in interface JRBox

setBorder

public void setBorder(byte border)

Deprecated. Replaced by getLineBox()

Specified by:

setBorder in interface JRBox

setBorder

public void setBorder(java.lang.Byte border)

Deprecated. Replaced by getLineBox()

Specified by:

setBorder in interface JRBox

getBorderColor

public java.awt.Color getBorderColor()

Deprecated. Replaced by getLineBox()

Specified by:

getBorderColor in interface JRBox

getOwnBorderColor

public java.awt.Color getOwnBorderColor()

Deprecated. Replaced by getLineBox()

Specified by:

getOwnBorderColor in interface JRBox

setBorderColor

public void setBorderColor(java.awt.Color borderColor)

Deprecated. Replaced by getLineBox()

Specified by:

setBorderColor in interface JRBox

getPadding

public int getPadding()

Deprecated. Replaced by getLineBox()

Specified by:

getPadding in interface JRBox

getOwnPadding

public java.lang.Integer getOwnPadding()

Deprecated. Replaced by getLineBox()

Specified by:

getOwnPadding in interface JRBox

setPadding

public void setPadding(int padding)

Deprecated. Replaced by getLineBox()

Specified by:

setPadding in interface JRBox

setPadding

public void setPadding(java.lang.Integer padding)

Deprecated. Replaced by getLineBox()

Specified by:

setPadding in interface JRBox

getTopBorder

public byte getTopBorder()

Deprecated. Replaced by getLineBox()

Specified by:

getTopBorder in interface JRBox

getOwnTopBorder

public java.lang.Byte getOwnTopBorder()

Deprecated. Replaced by getLineBox()

Specified by:

getOwnTopBorder in interface JRBox

setTopBorder

public void setTopBorder(byte topBorder)

Deprecated. Replaced by getLineBox()

Specified by:

setTopBorder in interface JRBox

setTopBorder

public void setTopBorder(java.lang.Byte topBorder)

Deprecated. Replaced by getLineBox()

Specified by:

setTopBorder in interface JRBox

getTopBorderColor

public java.awt.Color getTopBorderColor()

Deprecated. Replaced by getLineBox()

Specified by:

getTopBorderColor in interface JRBox

getOwnTopBorderColor

public java.awt.Color getOwnTopBorderColor()

Deprecated. Replaced by getLineBox()

Specified by:

getOwnTopBorderColor in interface JRBox

setTopBorderColor

public void setTopBorderColor(java.awt.Color topBorderColor)

Deprecated. Replaced by getLineBox()

Specified by:

setTopBorderColor in interface JRBox

getTopPadding

public int getTopPadding()

Deprecated. Replaced by getLineBox()

Specified by:

getTopPadding in interface JRBox

getOwnTopPadding

public java.lang.Integer getOwnTopPadding()

Deprecated. Replaced by getLineBox()

Specified by:

getOwnTopPadding in interface JRBox

setTopPadding

public void setTopPadding(int topPadding)

Deprecated. Replaced by getLineBox()

Specified by:

setTopPadding in interface JRBox

setTopPadding

public void setTopPadding(java.lang.Integer topPadding)

Deprecated. Replaced by getLineBox()

Specified by:

setTopPadding in interface JRBox

getLeftBorder

public byte getLeftBorder()

Deprecated. Replaced by getLineBox()

Specified by:

getLeftBorder in interface JRBox

getOwnLeftBorder

public java.lang.Byte getOwnLeftBorder()

Deprecated. Replaced by getLineBox()

Specified by:

getOwnLeftBorder in interface JRBox

setLeftBorder

public void setLeftBorder(byte leftBorder)

Deprecated. Replaced by getLineBox()

Specified by:

setLeftBorder in interface JRBox

setLeftBorder

public void setLeftBorder(java.lang.Byte leftBorder)

Deprecated. Replaced by getLineBox()

Specified by:

setLeftBorder in interface JRBox

getLeftBorderColor

public java.awt.Color getLeftBorderColor()

Deprecated. Replaced by getLineBox()

Specified by:

getLeftBorderColor in interface JRBox

getOwnLeftBorderColor

public java.awt.Color getOwnLeftBorderColor()

Deprecated. Replaced by getLineBox()

Specified by:

getOwnLeftBorderColor in interface JRBox

setLeftBorderColor

public void setLeftBorderColor(java.awt.Color leftBorderColor)

Deprecated. Replaced by getLineBox()

Specified by:

setLeftBorderColor in interface JRBox

getLeftPadding

public int getLeftPadding()

Deprecated. Replaced by getLineBox()

Specified by:

getLeftPadding in interface JRBox

getOwnLeftPadding

public java.lang.Integer getOwnLeftPadding()

Deprecated. Replaced by getLineBox()

Specified by:

getOwnLeftPadding in interface JRBox

setLeftPadding

public void setLeftPadding(int leftPadding)

Deprecated. Replaced by getLineBox()

Specified by:

setLeftPadding in interface JRBox

setLeftPadding

public void setLeftPadding(java.lang.Integer leftPadding)

Deprecated. Replaced by getLineBox()

Specified by:

setLeftPadding in interface JRBox

getBottomBorder

public byte getBottomBorder()

Deprecated. Replaced by getLineBox()

Specified by:

getBottomBorder in interface JRBox

getOwnBottomBorder

public java.lang.Byte getOwnBottomBorder()

Deprecated. Replaced by getLineBox()

Specified by:

getOwnBottomBorder in interface JRBox

setBottomBorder

public void setBottomBorder(byte bottomBorder)

Deprecated. Replaced by getLineBox()

Specified by:

setBottomBorder in interface JRBox

setBottomBorder

public void setBottomBorder(java.lang.Byte bottomBorder)

Deprecated. Replaced by getLineBox()

Specified by:

setBottomBorder in interface JRBox

getBottomBorderColor

public java.awt.Color getBottomBorderColor()

Deprecated. Replaced by getLineBox()

Specified by:

getBottomBorderColor in interface JRBox

getOwnBottomBorderColor

public java.awt.Color getOwnBottomBorderColor()

Deprecated. Replaced by getLineBox()

Specified by:

getOwnBottomBorderColor in interface JRBox

setBottomBorderColor

public void setBottomBorderColor(java.awt.Color bottomBorderColor)

Deprecated. Replaced by getLineBox()

Specified by:

setBottomBorderColor in interface JRBox

getBottomPadding

public int getBottomPadding()

Deprecated. Replaced by getLineBox()

Specified by:

getBottomPadding in interface JRBox

getOwnBottomPadding

public java.lang.Integer getOwnBottomPadding()

Deprecated. Replaced by getLineBox()

Specified by:

getOwnBottomPadding in interface JRBox

setBottomPadding

public void setBottomPadding(int bottomPadding)

Deprecated. Replaced by getLineBox()

Specified by:

setBottomPadding in interface JRBox

setBottomPadding

public void setBottomPadding(java.lang.Integer bottomPadding)

Deprecated. Replaced by getLineBox()

Specified by:

setBottomPadding in interface JRBox

getRightBorder

public byte getRightBorder()

Deprecated. Replaced by getLineBox()

Specified by:

getRightBorder in interface JRBox

getOwnRightBorder

public java.lang.Byte getOwnRightBorder()

Deprecated. Replaced by getLineBox()

Specified by:

getOwnRightBorder in interface JRBox

setRightBorder

public void setRightBorder(byte rightBorder)

Deprecated. Replaced by getLineBox()

Specified by:

setRightBorder in interface JRBox

setRightBorder

public void setRightBorder(java.lang.Byte rightBorder)

Deprecated. Replaced by getLineBox()

Specified by:

setRightBorder in interface JRBox

getRightBorderColor

public java.awt.Color getRightBorderColor()

Deprecated. Replaced by getLineBox()

Specified by:

getRightBorderColor in interface JRBox

getOwnRightBorderColor

public java.awt.Color getOwnRightBorderColor()

Deprecated. Replaced by getLineBox()

Specified by:

getOwnRightBorderColor in interface JRBox

setRightBorderColor

public void setRightBorderColor(java.awt.Color rightBorderColor)

Deprecated. Replaced by getLineBox()

Specified by:

setRightBorderColor in interface JRBox

getRightPadding

public int getRightPadding()

Deprecated. Replaced by getLineBox()

Specified by:

getRightPadding in interface JRBox

getOwnRightPadding

public java.lang.Integer getOwnRightPadding()

Deprecated. Replaced by getLineBox()

Specified by:

getOwnRightPadding in interface JRBox

setRightPadding

public void setRightPadding(int rightPadding)

Deprecated. Replaced by getLineBox()

Specified by:

setRightPadding in interface JRBox

setRightPadding

public void setRightPadding(java.lang.Integer rightPadding)

Deprecated. Replaced by getLineBox()

Specified by:

setRightPadding in interface JRBox

visit

public void visit(JRVisitor visitor)

Specified by:

visit in interface JRVisitable

getElementByKey

public JRElement getElementByKey(java.lang.String key)

Description copied from interface: JRElementGroup

Gets an element from this group, based on its element key.

Specified by:

getElementByKey in interface JRElementGroup

createClone

public JRFillCloneable createClone(JRFillCloneFactory factory)

Description copied from interface: JRFillCloneable

Creates a working clone of itself.

Specified by:

createClone in interface JRFillCloneable

Parameters:

factory - the clone factory to use while creating the clone

Returns:

a working clone of itself