Class JRDesignSubreport
java.lang.Object
net.sf.jasperreports.engine.base.JRBaseElement
net.sf.jasperreports.engine.design.JRDesignElement
net.sf.jasperreports.engine.design.JRDesignSubreport
- All Implemented Interfaces:
Serializable
,Cloneable
,JRChangeEventsSupport
,JRChild
,JRCloneable
,JRCommonElement
,JRElement
,JRIdentifiable
,JRPropertiesHolder
,JRStyleContainer
,JRSubreport
,JRVisitable
- Author:
- Teodor Danciu (teodord@users.sourceforge.net)
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected JRExpression
protected JRExpression
static final String
protected JRExpression
protected Boolean
protected Map
<String, JRSubreportParameter> protected JRExpression
static final String
static final String
static final String
static final String
static final String
static final String
protected List
<JRSubreportReturnValue> Values to be copied from the subreport into the master report.Fields inherited from class net.sf.jasperreports.engine.design.JRDesignElement
PROPERTY_ELEMENT_GROUP, PROPERTY_HEIGHT, PROPERTY_KEY, PROPERTY_PARENT_STYLE, PROPERTY_PARENT_STYLE_NAME_REFERENCE, PROPERTY_PRINT_WHEN_EXPRESSION, PROPERTY_PRINT_WHEN_GROUP_CHANGES, PROPERTY_PROPERTY_EXPRESSIONS, PROPERTY_STYLE_EXPRESSION, PROPERTY_Y
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
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addParameter
(JRSubreportParameter subreportParameter) void
addReturnValue
(JRSubreportReturnValue returnValue) Adds a return value to the subreport.clone()
void
collectExpressions
(JRExpressionCollector collector) getMode()
Returns the element transparency mode.Returns the list of values to be copied from the subreport into the master.Returns the list of values to be copied from the subreport into the master.Indicates if the engine is loading the current subreport from cache.Specifies whether the subreport element will consume the entire vertical space available on the report page.removeParameter
(String name) boolean
removeReturnValue
(JRSubreportReturnValue returnValue) Removes a return value from the subreport.void
setConnectionExpression
(JRExpression connectionExpression) void
setDataSourceExpression
(JRExpression dataSourceExpression) void
setExpression
(JRExpression expression) void
setOverflowType
(OverflowType overflowType) void
setParametersMapExpression
(JRExpression parametersMapExpression) void
setRunToBottom
(Boolean runToBottom) Sets the flag that Specifies whether the subreport element will consume the entire vertical space available on the report page.void
setUsingCache
(Boolean isUsingCache) Specifies if the engine should be loading the current subreport from cache.void
Methods inherited from class net.sf.jasperreports.engine.design.JRDesignElement
addPropertyExpression, getPropertyExpressions, getPropertyExpressionsList, removePropertyExpression, removePropertyExpression, setElementGroup, setHeight, setKey, setPrintWhenExpression, setPrintWhenGroupChanges, setStyle, setStyleExpression, setStyleNameReference, setY
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, 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.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.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 Details
-
EXCEPTION_MESSAGE_KEY_DUPLICATE_PARAMETER
- See Also:
-
PROPERTY_CONNECTION_EXPRESSION
- See Also:
-
PROPERTY_DATASOURCE_EXPRESSION
- See Also:
-
PROPERTY_EXPRESSION
- See Also:
-
PROPERTY_PARAMETERS_MAP_EXPRESSION
- See Also:
-
PROPERTY_PARAMETERS
- See Also:
-
PROPERTY_RETURN_VALUES
- See Also:
-
isUsingCache
-
parametersMap
-
returnValues
Values to be copied from the subreport into the master report. -
parametersMapExpression
-
connectionExpression
-
dataSourceExpression
-
expression
-
-
Constructor Details
-
JRDesignSubreport
-
-
Method Details
-
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 interfaceJRCommonElement
- Overrides:
getMode
in classJRBaseElement
-
getParametersMapExpression
- Specified by:
getParametersMapExpression
in interfaceJRSubreport
-
setParametersMapExpression
-
getParameters
- Specified by:
getParameters
in interfaceJRSubreport
-
getParametersMap
-
addParameter
- Throws:
JRException
-
removeParameter
-
getConnectionExpression
- Specified by:
getConnectionExpression
in interfaceJRSubreport
-
setConnectionExpression
-
getDataSourceExpression
- Specified by:
getDataSourceExpression
in interfaceJRSubreport
-
setDataSourceExpression
-
getExpression
- Specified by:
getExpression
in interfaceJRSubreport
-
setExpression
-
collectExpressions
- Specified by:
collectExpressions
in interfaceJRElement
-
visit
- Specified by:
visit
in interfaceJRVisitable
-
addReturnValue
Adds a return value to the subreport.- Parameters:
returnValue
- the return value to be added.
-
getReturnValues
Returns the list of values to be copied from the subreport into the master.- Specified by:
getReturnValues
in interfaceJRSubreport
- Returns:
- the list of values to be copied from the subreport into the master.
-
getReturnValuesList
Returns the list of values to be copied from the subreport into the master.- Returns:
- list of
JRSubreportReturnValue
objects
-
removeReturnValue
Removes a return value from the subreport.- Parameters:
returnValue
- the return value to be removed- Returns:
true
if the return value was found and removed
-
getUsingCache
Description copied from interface:JRSubreport
Indicates if the engine is loading the current subreport from cache. Implementations of this method return the actual value for the internal flag that was explicitly set on this subreport.- Specified by:
getUsingCache
in interfaceJRSubreport
- Returns:
- Boolean.TRUE if the subreport should be loaded from cache, Boolean.FALSE otherwise or null in case the flag was never explicitly set on this subreport element
-
setUsingCache
Description copied from interface:JRSubreport
Specifies if the engine should be loading the current subreport from cache. If set to Boolean.TRUE, the reporting engine will try to recognize previously loaded subreports using their specified source. For example, it will recognize an subreport if the subreport source is a file name that it has already loaded, or if it is the same URL.If set to null, the engine will rely on some default value which depends on the type of the subreport expression. The cache is turned on by default only for subreports that have java.lang.String objects in their expressions.
- Specified by:
setUsingCache
in interfaceJRSubreport
-
isRunToBottom
Description copied from interface:JRSubreport
Specifies whether the subreport element will consume the entire vertical space available on the report page.- Specified by:
isRunToBottom
in interfaceJRSubreport
- Returns:
- whether the subreport element will consume the entire space down to the bottom of the page
- See Also:
-
setRunToBottom
Description copied from interface:JRSubreport
Sets the flag that Specifies whether the subreport element will consume the entire vertical space available on the report page.This flag should be set to
true
if the subreport needs to always print its column and page footers at the bottom of the report page, even when the subreport data does not stretch to the bottom.Note that when
isFloatColumnFooter
is set for the subreport, the column footers will not be printed at the bottom of the page even if this flag is set.- Specified by:
setRunToBottom
in interfaceJRSubreport
- Parameters:
runToBottom
- whether the subreport element will consume the entire space down to the bottom of the page
-
getOverflowType
- Specified by:
getOverflowType
in interfaceJRSubreport
-
setOverflowType
- Specified by:
setOverflowType
in interfaceJRSubreport
-
clone
- Specified by:
clone
in interfaceJRCloneable
- Overrides:
clone
in classJRDesignElement
-