Interface JRFrame
- All Superinterfaces:
Cloneable,JRBoxContainer,JRChild,JRCloneable,JRCommonElement,JRElement,JRElementGroup,JRIdentifiable,JRPropertiesHolder,JRStyleContainer,JRVisitable
- All Known Implementing Classes:
JRBaseFrame,JRDesignFrame,JRFillFrame
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, positionType and
stretchType properties are relative to the frame instead of the band.
- Author:
- Lucian Chirita (lucianc@users.sourceforge.net)
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringA property that provides the default border split type for frames.static final StringFields inherited from interface net.sf.jasperreports.engine.JRElement
PROPERTY_ELEMENT_TEMPLATE_POPULATE_STYLE -
Method Summary
Modifier and TypeMethodDescriptionDetermines how should the frames borders behave when the frame splits on two pages.Methods inherited from interface net.sf.jasperreports.engine.JRBoxContainer
getDefaultLineColor, getLineBoxMethods inherited from interface net.sf.jasperreports.engine.JRCloneable
cloneMethods inherited from interface net.sf.jasperreports.engine.JRCommonElement
getBackcolor, getForecolor, getHeight, getKey, getMode, getOwnBackcolor, getOwnForecolor, getOwnMode, getWidth, setBackcolor, setForecolor, setModeMethods 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, setXMethods inherited from interface net.sf.jasperreports.engine.JRElementGroup
getChildren, getElementByKey, getElementGroup, getElementsMethods inherited from interface net.sf.jasperreports.engine.JRIdentifiable
getUUIDMethods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder
getParentProperties, getPropertiesMap, hasPropertiesMethods inherited from interface net.sf.jasperreports.engine.JRStyleContainer
getDefaultStyleProvider, getStyle, getStyleName, getStyleNameReferenceMethods inherited from interface net.sf.jasperreports.engine.JRVisitable
visit
-
Field Details
-
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
BorderSplitTypeenum, that is NoBorders or DrawBorders. By defaultBorderSplitType.NO_BORDERSis used.- See Also:
-
PROPERTY_FRAME_WIDTH_STRETCH_DISABLED
- See Also:
-
-
Method Details
-
getBorderSplitType
BorderSplitType getBorderSplitType()Determines how should the frames borders behave when the frame splits on two pages.- Returns:
- the border split type
- See Also:
-