Package net.sf.jasperreports.engine.base

Class JRBaseFrame

java.lang.Object

net.sf.jasperreports.engine.base.JRBaseElement

net.sf.jasperreports.engine.base.JRBaseFrame

All Implemented Interfaces:

Serializable, Cloneable, JRChangeEventsSupport, JRBoxContainer, JRChild, JRCloneable, JRCommonElement, JRElement, JRElementGroup, JRFrame, JRIdentifiable, JRPropertiesHolder, JRStyleContainer, JRVisitable

public class JRBaseFrame
extends JRBaseElement
implements JRFrame

Base read-only implementation of JRFrame.

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<JRChild>	children
protected JRLineBox	lineBox

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

backcolor, defaultStyleProvider, elementGroup, forecolor, height, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, key, mode, parentStyle, parentStyleNameReference, positionType, printWhenExpression, printWhenGroupChanges, PROPERTY_POSITION_TYPE, PROPERTY_PRINT_IN_FIRST_WHOLE_BAND, PROPERTY_PRINT_REPEATED_VALUES, PROPERTY_PRINT_WHEN_DETAIL_OVERFLOWS, PROPERTY_REMOVE_LINE_WHEN_BLANK, PROPERTY_STRETCH_TYPE, PROPERTY_WIDTH, PROPERTY_X, stretchType, styleExpression, uuid, width, x, y

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

PROPERTY_ELEMENT_TEMPLATE_POPULATE_STYLE

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

PROPERTY_BORDER_SPLIT_TYPE, PROPERTY_FRAME_WIDTH_STRETCH_DISABLED

Constructor Summary

Constructors

Constructor	Description
JRBaseFrame(JRFrame frame, JRBaseObjectFactory factory)

Method Summary

Modifier and Type	Method	Description
Object	clone()
void	collectExpressions(JRExpressionCollector collector)
BorderSplitType	getBorderSplitType()	Determines how should the frames borders behave when the frame splits on two pages.
List<JRChild>	getChildren()	Gets a list of all direct children elements or elements groups.
Color	getDefaultLineColor()
JRElement	getElementByKey(String elementKey)	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.
JRLineBox	getLineBox()
ModeEnum	getMode()	Returns the element transparency mode.
void	visit(JRVisitor visitor)

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

clone, clone, getBackcolor, getBaseStyle, getDefaultStyleProvider, getElementGroup, getEventSupport, getForecolor, getHeight, getKey, getOwnBackcolor, getOwnForecolor, getOwnMode, getParentProperties, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertiesMap, getPropertyExpressions, getStretchType, getStyle, getStyleExpression, getStyleNameReference, getStyleResolver, getUUID, getWidth, getX, getY, hasProperties, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setUUID, setWidth, setX

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

getBackcolor, getForecolor, getHeight, getKey, getOwnBackcolor, getOwnForecolor, getOwnMode, getWidth, setBackcolor, setForecolor, setMode

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

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

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

getElementGroup

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

getUUID

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

getParentProperties, getPropertiesMap, hasProperties

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

getDefaultStyleProvider, getStyle, getStyleName, getStyleNameReference

Field Detail

children

protected List<JRChild> children

lineBox

protected JRLineBox lineBox

Constructor Detail

JRBaseFrame

public JRBaseFrame(JRFrame frame,
                   JRBaseObjectFactory factory)

Method Detail

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

collectExpressions

public void collectExpressions(JRExpressionCollector collector)

Specified by:

collectExpressions in interface JRElement

visit

public void visit(JRVisitor visitor)

Specified by:

visit in interface JRVisitable

getChildren

public List<JRChild> getChildren()

Description copied from interface: JRElementGroup

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

Specified by:

getChildren in interface JRElementGroup

getElementByKey

public JRElement getElementByKey(String elementKey)

Description copied from interface: JRElementGroup

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

Specified by:

getElementByKey in interface JRElementGroup

getMode

public ModeEnum getMode()

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:

getMode in interface JRCommonElement

Overrides:

getMode in class JRBaseElement

getLineBox

public JRLineBox getLineBox()

Specified by:

getLineBox in interface JRBoxContainer

getDefaultLineColor

public Color getDefaultLineColor()

Specified by:

getDefaultLineColor in interface JRBoxContainer

getBorderSplitType

public BorderSplitType getBorderSplitType()

Description copied from interface: JRFrame

Determines how should the frames borders behave when the frame splits on two pages.

Specified by:

getBorderSplitType in interface JRFrame

Returns:

the border split type

See Also:

JRFrame.PROPERTY_BORDER_SPLIT_TYPE, JRDesignFrame.setBorderSplitType(BorderSplitType)

clone

public Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class JRBaseElement