public class JRFillSubreport extends JRFillElement implements JRSubreport
| Modifier and Type | Field and Description |
|---|---|
static String |
EXCEPTION_MESSAGE_KEY_NO_REWINDABLE_DATA_SOURCE |
static String |
EXCEPTION_MESSAGE_KEY_PROPERTY_NOT_SET |
static String |
EXCEPTION_MESSAGE_KEY_UNKNOWN_SOURCE_CLASS |
static String |
EXCEPTION_MESSAGE_KEY_UNSUPPORTED_SECTION_TYPE |
protected JRPrintPage |
printPage |
static String |
PROPERTY_SUBREPORT_GENERATE_RECTANGLE |
protected FillerSubreportParent |
subFillerParent |
static String |
SUBREPORT_GENERATE_RECTANGLE_ALWAYS |
protected JRBaseFiller |
subreportFiller |
band, conditionalStylesContainer, currentEvaluation, currentStyle, defaultStyleProvider, delayedEvaluationsMap, dynamicProperties, dynamicTransferProperties, elementGroup, expressionEvaluator, fillContainerContext, filler, initStyle, mergedProperties, originProvider, parent, printElementOriginator, printWhenGroupChanges, propertyExpressions, providerStyle, staticProperties, styleProviders, templates| Modifier | Constructor and Description |
|---|---|
protected |
JRFillSubreport(JRBaseFiller filler,
JRSubreport subreport,
JRFillObjectFactory factory) |
protected |
JRFillSubreport(JRFillSubreport subreport,
JRFillCloneFactory factory) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
cancelSubreportFill() |
void |
collectExpressions(JRExpressionCollector collector) |
JRFillCloneable |
createClone(JRFillCloneFactory factory)
Creates a working clone of itself.
|
protected JRTemplateElement |
createElementTemplate() |
protected DatasetExpressionEvaluator |
createEvaluator() |
protected void |
evaluate(byte evaluation) |
protected Map<String,Object> |
evaluateParameterValues(byte evaluation) |
protected JasperReport |
evaluateReport(byte evaluation) |
protected void |
evaluateSubreport(byte evaluation) |
protected void |
evictReportEvaluator() |
protected JRPrintElement |
fill() |
protected void |
fillSubreport() |
protected String |
generateRectangleOption() |
JRExpression |
getConnectionExpression() |
protected int |
getContentsStretchHeight() |
JRExpression |
getDataSourceExpression() |
JRExpression |
getExpression() |
protected JRTemplateRectangle |
getJRTemplateRectangle() |
ModeEnum |
getModeValue()
Returns the element transparency mode.
|
OverflowType |
getOverflowType() |
JRSubreportParameter[] |
getParameters() |
JRExpression |
getParametersMapExpression() |
static Map<String,Object> |
getParameterValues(BaseReportFiller filler,
JRExpression parametersMapExpression,
JRDatasetParameter[] subreportParameters,
byte evaluation,
boolean ignoreNullExpressions,
boolean removeResourceBundle,
boolean removeFormatFactory)
Utility method used for constructing a parameter values map for subreports, sub datasets and crosstabs.
|
static Map<String,Object> |
getParameterValues(BaseReportFiller filler,
JRFillExpressionEvaluator expressionEvaluator,
JRExpression parametersMapExpression,
JRDatasetParameter[] subreportParameters,
byte evaluation,
boolean ignoreNullExpressions,
boolean removeResourceBundle,
boolean removeFormatFactory)
Utility method used for constructing a parameter values map for subreports, sub datasets and crosstabs.
|
protected Collection<JRPrintElement> |
getPrintElements() |
protected String |
getReportLocation() |
JRSubreportReturnValue[] |
getReturnValues()
Returns the list of subreport copied values.
|
protected JRSubreportRunnerFactory |
getRunnerFactory() |
Boolean |
getUsingCache()
Indicates if the engine is loading the current subreport from cache.
|
protected void |
initSubreportFiller(DatasetExpressionEvaluator evaluator) |
Boolean |
isOwnUsingCache()
Deprecated.
Replaced by
getUsingCache(). |
protected boolean |
isReorderBandElements() |
Boolean |
isRunToBottom()
Specifies whether the subreport element will consume the entire vertical
space available on the report page.
|
boolean |
isUsingCache()
Deprecated.
Replaced by
getUsingCache(). |
static JasperReport |
loadReport(Object source,
BaseReportFiller filler) |
protected DatasetExpressionEvaluator |
loadReportEvaluator() |
protected boolean |
prepare(int availableHeight,
boolean isOverflow) |
protected void |
registerReportStyles(List<JRStyle> styles) |
protected void |
resolveElement(JRPrintElement element,
byte evaluation)
Resolves an element.
|
void |
rewind() |
protected void |
setBand(JRFillBand band) |
void |
setOverflowType(OverflowType overflowType) |
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 |
subreportPageFilled() |
boolean |
usingCache() |
protected void |
validateReport() |
protected void |
verifyBandHeights() |
void |
visit(JRVisitor visitor) |
_moveDependantElements, _stretchElement, _stretchElementToHeight, addDependantElement, addDynamicProperty, clone, clone, clone, collectDelayedEvaluations, collectDelayedEvaluations, collectDelayedEvaluations, collectStyleDelayedEvaluations, collectStyleProviderDelayedEvaluations, delayedEvaluate, delayedEvaluationUpdatesTemplate, evaluateExpression, evaluatePrintWhenExpression, evaluateProperties, evaluateStyle, getBackcolor, getBand, getCollapsedHeightAbove, getCollapsedHeightBelow, getConditionalStylesContainer, getDefaultStyleProvider, getDependantElements, getDynamicProperties, getElementGroup, getElementOrigin, getElementTemplate, getEvaluatedProperties, getEvaluationTimeValue, getField, getFiller, getForecolor, getGroupElements, getHeight, getInitStyle, getKey, getOwnBackcolor, getOwnForecolor, getOwnModeValue, getParent, getParentProperties, getPositionTypeValue, getPrepareHeight, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertiesMap, getPropertyExpressions, getRelativeY, getStretchHeight, getStretchTypeValue, getStyle, getStyleNameReference, getStyleResolver, getTemplate, getUUID, getVariable, getWidth, getX, getY, hasDynamicProperties, hasDynamicProperty, hasProperties, initDelayedEvaluationPrint, initDelayedEvaluations, initStyleProviders, isAlreadyPrinted, isAutoEvaluateNow, isDelayedStyleEvaluation, isEvaluateAuto, isEvaluateNow, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isPrintWhenExpressionNull, isPrintWhenTrue, isRemoveLineWhenBlank, isReprinted, isToPrint, isValueRepeating, moveDependantElements, performDelayedEvaluation, registerTemplate, reset, resolveElement, setAlreadyPrinted, setBackcolor, setCollapsedHeightAbove, setCollapsedHeightBelow, setConditionalStylesContainer, setCurrentEvaluation, setExpressionEvaluator, setForecolor, setHeight, setMode, setOriginProvider, setPositionType, setPrepareHeight, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setPrintWhenExpressionNull, setPrintWhenTrue, setRelativeY, setRemoveLineWhenBlank, setReprinted, setShrinkable, setStretchHeight, setStretchType, setStyle, setStyleNameReference, setToPrint, setValueRepeating, setWidth, setX, setY, stretchElement, stretchElementToContainer, stretchElementToElementGroup, stretchElementToHeight, stretchHeightFinal, transferProperties, transferPropertiesequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitclone, getElementGroup, getKey, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertyExpressions, getStretchTypeValue, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setXclonegetBackcolor, getForecolor, getHeight, getOwnBackcolor, getOwnForecolor, getOwnModeValue, getWidth, setBackcolor, setForecolor, setModegetDefaultStyleProvider, getStyle, getStyleNameReferencegetParentProperties, getPropertiesMap, hasPropertiesgetUUIDpublic static final String EXCEPTION_MESSAGE_KEY_PROPERTY_NOT_SET
public static final String EXCEPTION_MESSAGE_KEY_NO_REWINDABLE_DATA_SOURCE
public static final String EXCEPTION_MESSAGE_KEY_UNSUPPORTED_SECTION_TYPE
public static final String EXCEPTION_MESSAGE_KEY_UNKNOWN_SOURCE_CLASS
public static final String PROPERTY_SUBREPORT_GENERATE_RECTANGLE
public static final String SUBREPORT_GENERATE_RECTANGLE_ALWAYS
protected JRBaseFiller subreportFiller
protected FillerSubreportParent subFillerParent
protected JRPrintPage printPage
protected JRFillSubreport(JRBaseFiller filler, JRSubreport subreport, JRFillObjectFactory factory)
protected JRFillSubreport(JRFillSubreport subreport, JRFillCloneFactory factory)
protected void setBand(JRFillBand band)
setBand in class JRFillElementpublic ModeEnum getModeValue()
JRCommonElementgetModeValue in interface JRCommonElementgetModeValue in class JRFillElementpublic boolean isUsingCache()
getUsingCache().JRSubreportisUsingCache in interface JRSubreportpublic boolean usingCache()
public Boolean isRunToBottom()
JRSubreportisRunToBottom in interface JRSubreportJRSubreport.setRunToBottom(Boolean)public void setRunToBottom(Boolean runToBottom)
JRSubreport
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.
setRunToBottom in interface JRSubreportrunToBottom - whether the subreport element will consume the entire
space down to the bottom of the pagepublic OverflowType getOverflowType()
getOverflowType in interface JRSubreportpublic void setOverflowType(OverflowType overflowType)
setOverflowType in interface JRSubreportpublic JRExpression getParametersMapExpression()
getParametersMapExpression in interface JRSubreportpublic JRSubreportParameter[] getParameters()
getParameters in interface JRSubreportpublic JRExpression getConnectionExpression()
getConnectionExpression in interface JRSubreportpublic JRExpression getDataSourceExpression()
getDataSourceExpression in interface JRSubreportpublic JRExpression getExpression()
getExpression in interface JRSubreportprotected JRTemplateRectangle getJRTemplateRectangle()
protected JRTemplateElement createElementTemplate()
createElementTemplate in class JRFillElementprotected Collection<JRPrintElement> getPrintElements()
public void subreportPageFilled()
protected void evaluate(byte evaluation)
throws JRException
evaluate in class JRFillElementJRExceptionprotected JasperReport evaluateReport(byte evaluation) throws JRException
JRExceptionpublic static JasperReport loadReport(Object source, BaseReportFiller filler) throws JRException
JRExceptionprotected void evaluateSubreport(byte evaluation)
throws JRException
JRExceptionprotected Map<String,Object> evaluateParameterValues(byte evaluation) throws JRException
JRExceptionprotected DatasetExpressionEvaluator loadReportEvaluator() throws JRException
JRExceptionprotected void evictReportEvaluator()
protected DatasetExpressionEvaluator createEvaluator() throws JRException
JRExceptionprotected boolean isReorderBandElements()
protected void initSubreportFiller(DatasetExpressionEvaluator evaluator) throws JRException
JRExceptionpublic static Map<String,Object> getParameterValues(BaseReportFiller filler, JRExpression parametersMapExpression, JRDatasetParameter[] subreportParameters, byte evaluation, boolean ignoreNullExpressions, boolean removeResourceBundle, boolean removeFormatFactory) throws JRException
filler - report fillerparametersMapExpression - expression that yields bulk parameter values mapsubreportParameters - list of individual parameter valuesevaluation - evaluation typeignoreNullExpressions - whether to ignore individual parameter value expressionsremoveResourceBundle - whether to remove the REPORT_RESOURCE_BUNDLE
value from the bulk values mapJRExceptionpublic static Map<String,Object> getParameterValues(BaseReportFiller filler, JRFillExpressionEvaluator expressionEvaluator, JRExpression parametersMapExpression, JRDatasetParameter[] subreportParameters, byte evaluation, boolean ignoreNullExpressions, boolean removeResourceBundle, boolean removeFormatFactory) throws JRException
filler - report fillerexpressionEvaluator - expression evaluatorparametersMapExpression - expression that yields bulk parameter values mapsubreportParameters - list of individual parameter valuesevaluation - evaluation typeignoreNullExpressions - whether to ignore individual parameter value expressionsremoveResourceBundle - whether to remove the REPORT_RESOURCE_BUNDLE
value from the bulk values mapJRExceptionprotected void fillSubreport()
throws JRException
JRExceptionprotected boolean prepare(int availableHeight,
boolean isOverflow)
throws JRException
prepare in class JRFillElementJRExceptionpublic void rewind()
throws JRException
rewind in class JRFillElementJRExceptionprotected void cancelSubreportFill()
throws JRException
JRExceptionprotected JRPrintElement fill()
fill in class JRFillElementprotected String generateRectangleOption()
public void collectExpressions(JRExpressionCollector collector)
collectExpressions in interface JRElementpublic void visit(JRVisitor visitor)
visit in interface JRVisitablepublic JRSubreportReturnValue[] getReturnValues()
JRSubreportgetReturnValues in interface JRSubreportprotected void validateReport()
throws JRException
JRExceptionprotected void verifyBandHeights()
throws JRException
JRExceptionprotected void resolveElement(JRPrintElement element, byte evaluation)
JRFillElementresolveElement in class JRFillElementelement - the elementevaluation - the evaluation typepublic Boolean isOwnUsingCache()
getUsingCache().JRSubreportisOwnUsingCache in interface JRSubreportpublic Boolean getUsingCache()
JRSubreportgetUsingCache in interface JRSubreportpublic void setUsingCache(Boolean isUsingCache)
JRSubreportIf 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.
setUsingCache in interface JRSubreportpublic JRFillCloneable createClone(JRFillCloneFactory factory)
JRFillCloneablecreateClone in interface JRFillCloneablefactory - the clone factory to use while creating the cloneprotected JRSubreportRunnerFactory getRunnerFactory() throws JRException
JRExceptionprotected int getContentsStretchHeight()
protected String getReportLocation()
Copyright © 2017. All rights reserved.