Interface JRFrame
-
- All Superinterfaces:
Cloneable
,JRBoxContainer
,JRChild
,JRCloneable
,JRCommonElement
,JRElement
,JRElementGroup
,JRIdentifiable
,JRPropertiesHolder
,JRStyleContainer
,JRVisitable
- All Known Implementing Classes:
JRBaseFrame
,JRDesignFrame
,JRFillFrame
public interface JRFrame extends JRElement, JRElementGroup, JRBoxContainer
An abstract representation of a report elements container.A frame is a report element that contains sub elements. It has a background, a border and it stretches to accommodate its content. It is usually helpful when a common background and/or common border must be put around a group of elements.
For the Graphics2D and PDF exporters, a frame is equivalent to a rectangle placed behind a group of elements. The HTML exporter creates sub-tables for frames and the XLS exporter includes the frame sub elements into the grid.
For elements inside a frame, the coordinates,
Frames can be nested into one another to any depth.positionType
andstretchType
properties are relative to the frame instead of the band.- Author:
- Lucian Chirita (lucianc@users.sourceforge.net)
-
-
Field Summary
Fields Modifier and Type Field Description static String
PROPERTY_BORDER_SPLIT_TYPE
A property that provides the default border split type for frames.static String
PROPERTY_FRAME_WIDTH_STRETCH_DISABLED
-
Fields inherited from interface net.sf.jasperreports.engine.JRElement
PROPERTY_ELEMENT_TEMPLATE_POPULATE_STYLE
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description BorderSplitType
getBorderSplitType()
Determines how should the frames borders behave when the frame splits on two pages.-
Methods inherited from interface net.sf.jasperreports.engine.JRBoxContainer
getDefaultLineColor, getLineBox
-
Methods inherited from interface net.sf.jasperreports.engine.JRCloneable
clone
-
Methods inherited from interface net.sf.jasperreports.engine.JRCommonElement
getBackcolor, getForecolor, getHeight, getKey, getMode, getOwnBackcolor, getOwnForecolor, getOwnMode, getWidth, setBackcolor, setForecolor, setMode
-
Methods inherited from interface net.sf.jasperreports.engine.JRElement
clone, collectExpressions, 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
getChildren, getElementByKey, getElementGroup, getElements
-
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
-
Methods inherited from interface net.sf.jasperreports.engine.JRVisitable
visit
-
-
-
-
Field Detail
-
PROPERTY_BORDER_SPLIT_TYPE
static final String PROPERTY_BORDER_SPLIT_TYPE
A property that provides the default border split type for frames.The property can be set at report and global/context levels. The property value should be one of the names of the
BorderSplitType
enum, that is NoBorders or DrawBorders. By defaultBorderSplitType.NO_BORDERS
is used.- See Also:
getBorderSplitType()
, Constant Field Values
-
PROPERTY_FRAME_WIDTH_STRETCH_DISABLED
static final String PROPERTY_FRAME_WIDTH_STRETCH_DISABLED
- See Also:
- Constant Field Values
-
-
Method Detail
-
getBorderSplitType
BorderSplitType getBorderSplitType()
Determines how should the frames borders behave when the frame splits on two pages.- Returns:
- the border split type
- See Also:
PROPERTY_BORDER_SPLIT_TYPE
,JRDesignFrame.setBorderSplitType(BorderSplitType)
-
-