|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.jasperreports.engine.base.JRBaseElement
net.sf.jasperreports.engine.base.JRBaseSubreport
public class JRBaseSubreport
Field Summary | |
---|---|
protected JRExpression |
connectionExpression
|
protected JRExpression |
dataSourceExpression
|
protected JRExpression |
expression
|
protected java.lang.Boolean |
isUsingCache
|
protected JRSubreportParameter[] |
parameters
|
protected JRExpression |
parametersMapExpression
|
static java.lang.String |
PROPERTY_RUN_TO_BOTTOM
|
static java.lang.String |
PROPERTY_USING_CACHE
|
protected JRSubreportReturnValue[] |
returnValues
Values to be copied from the subreport into the master report. |
Fields inherited from interface net.sf.jasperreports.engine.JRElement |
---|
MODE_OPAQUE, MODE_TRANSPARENT, POSITION_TYPE_FIX_RELATIVE_TO_BOTTOM, POSITION_TYPE_FIX_RELATIVE_TO_TOP, POSITION_TYPE_FLOAT, STRETCH_TYPE_NO_STRETCH, STRETCH_TYPE_RELATIVE_TO_BAND_HEIGHT, STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT |
Constructor Summary | |
---|---|
protected |
JRBaseSubreport(JRSubreport subreport,
JRBaseObjectFactory factory)
|
Method Summary | |
---|---|
java.lang.Object |
clone()
|
void |
collectExpressions(JRExpressionCollector collector)
|
JRExpression |
getConnectionExpression()
|
JRExpression |
getDataSourceExpression()
|
JRExpression |
getExpression()
|
byte |
getMode()
Returns the element transparency mode. |
JRSubreportParameter[] |
getParameters()
|
JRExpression |
getParametersMapExpression()
|
JRSubreportReturnValue[] |
getReturnValues()
Returns the list of values to be copied from the subreport into the master. |
java.lang.Boolean |
isOwnUsingCache()
Indicates if the engine is loading the current subreport from cache. |
java.lang.Boolean |
isRunToBottom()
Specifies whether the subreport element will consume the entire vertical space available on the report page. |
boolean |
isUsingCache()
Indicates if the engine is loading the current subreport from cache. |
void |
setRunToBottom(java.lang.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)
Deprecated. Replaced by setUsingCache(Boolean) . |
void |
setUsingCache(java.lang.Boolean isUsingCache)
Specifies if the engine should be loading the current subreport from cache. |
void |
visit(JRVisitor visitor)
|
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.JRElement |
---|
getElementGroup, getHeight, getKey, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertyExpressions, getStretchType, getWidth, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setX |
Methods inherited from interface net.sf.jasperreports.engine.JRChild |
---|
clone |
Methods inherited from interface net.sf.jasperreports.engine.JRCommonElement |
---|
getBackcolor, getForecolor, getOwnBackcolor, getOwnForecolor, getOwnMode |
Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer |
---|
getDefaultStyleProvider, getStyle, getStyleNameReference |
Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder |
---|
getParentProperties, getPropertiesMap, hasProperties |
Field Detail |
---|
public static final java.lang.String PROPERTY_USING_CACHE
public static final java.lang.String PROPERTY_RUN_TO_BOTTOM
protected java.lang.Boolean isUsingCache
protected JRExpression parametersMapExpression
protected JRSubreportParameter[] parameters
protected JRExpression connectionExpression
protected JRExpression dataSourceExpression
protected JRExpression expression
protected JRSubreportReturnValue[] returnValues
Constructor Detail |
---|
protected JRBaseSubreport(JRSubreport subreport, JRBaseObjectFactory factory)
Method Detail |
---|
public byte getMode()
JRCommonElement
getMode
in interface JRCommonElement
getMode
in class JRBaseElement
public boolean isUsingCache()
JRSubreport
isUsingCache
in interface JRSubreport
public void setUsingCache(boolean isUsingCache)
setUsingCache(Boolean)
.
JRSubreport
For subreports that have expressions returning java.lang.String objects as the subreport source, representing file names, URLs or classpath resources, the default value for this flag is true.
setUsingCache
in interface JRSubreport
public JRExpression getParametersMapExpression()
getParametersMapExpression
in interface JRSubreport
public JRSubreportParameter[] getParameters()
getParameters
in interface JRSubreport
public JRExpression getConnectionExpression()
getConnectionExpression
in interface JRSubreport
public JRExpression getDataSourceExpression()
getDataSourceExpression
in interface JRSubreport
public JRExpression getExpression()
getExpression
in interface JRSubreport
public void collectExpressions(JRExpressionCollector collector)
collectExpressions
in interface JRElement
public void visit(JRVisitor visitor)
visit
in interface JRVisitable
public JRSubreportReturnValue[] getReturnValues()
getReturnValues
in interface JRSubreport
public java.lang.Boolean isOwnUsingCache()
JRSubreport
isOwnUsingCache
in interface JRSubreport
public void setUsingCache(java.lang.Boolean isUsingCache)
JRSubreport
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.
setUsingCache
in interface JRSubreport
public java.lang.Boolean isRunToBottom()
JRSubreport
isRunToBottom
in interface JRSubreport
JRSubreport.setRunToBottom(Boolean)
public void setRunToBottom(java.lang.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 JRSubreport
runToBottom
- whether the subreport element will consume the entire
space down to the bottom of the pagepublic java.lang.Object clone()
clone
in interface JRCloneable
clone
in class JRBaseElement
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |