Package net.sf.jasperreports.engine
Interface JRBreak
-
- All Superinterfaces:
Cloneable
,JRChild
,JRCloneable
,JRCommonElement
,JRElement
,JRIdentifiable
,JRPropertiesHolder
,JRStyleContainer
,JRVisitable
- All Known Implementing Classes:
JRBaseBreak
,JRDesignBreak
,JRFillBreak
public interface JRBreak extends JRElement
An abstract representation of a break element. The break element was added to the list of elements that can be placed inside a band. This is used for introducing a page break or column break at a specified position within the band. In many ways, the break element behaves like any other normal element placed in a band. For instance, it can be conditionally displayed using<printWhenExpression>
, and it can float within the band ifpositionType="Float"
is used. Other common element properties like colors and styles do not make any sense for this kind of element, because it behaves like an invisible horizontal line that crosses the whole parent band and indicates they
position where a page break or column break should occur when the band content is rendered during the report-filling process. Whether a page break or a column break should be introduced is specified using thetype
attribute available for this element (seegetType()
). By default, page breaks are created.- Author:
- Teodor Danciu (teodord@users.sourceforge.net)
-
-
Field Summary
Fields Modifier and Type Field Description static String
PAGE_BREAK_NO_PAGINATION_APPLY
Value forPROPERTY_PAGE_BREAK_NO_PAGINATION
that results in page breaks being honoured in non paginated reports.static String
PAGE_BREAK_NO_PAGINATION_IGNORE
Value forPROPERTY_PAGE_BREAK_NO_PAGINATION
that results in page breaks being ignored in non paginated reports.static String
PROPERTY_PAGE_BREAK_NO_PAGINATION
Property that determines how page breaks are to be handled in reports that are not paginated.-
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 BreakTypeEnum
getType()
Gets the break type.void
setType(BreakTypeEnum breakTypeEnum)
Sets the break type.-
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.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_PAGE_BREAK_NO_PAGINATION
static final String PROPERTY_PAGE_BREAK_NO_PAGINATION
Property that determines how page breaks are to be handled in reports that are not paginated.The property value can be one of
The property can be set globally, at report level or at element level. The default behaviour is to ignore page breaks in non paginated reports.
- See Also:
- Constant Field Values
-
PAGE_BREAK_NO_PAGINATION_IGNORE
static final String PAGE_BREAK_NO_PAGINATION_IGNORE
Value forPROPERTY_PAGE_BREAK_NO_PAGINATION
that results in page breaks being ignored in non paginated reports.- See Also:
- Constant Field Values
-
PAGE_BREAK_NO_PAGINATION_APPLY
static final String PAGE_BREAK_NO_PAGINATION_APPLY
Value forPROPERTY_PAGE_BREAK_NO_PAGINATION
that results in page breaks being honoured in non paginated reports.- See Also:
- Constant Field Values
-
-
Method Detail
-
getType
BreakTypeEnum getType()
Gets the break type.- Returns:
- a value representing one of the break type constants in
BreakTypeEnum
-
setType
void setType(BreakTypeEnum breakTypeEnum)
Sets the break type.- Parameters:
breakTypeEnum
- a value representing one of the break type constants inBreakTypeEnum
-
-