|
||||||||||
| 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.design.JRDesignElement
net.sf.jasperreports.engine.design.JRDesignSubreport
public class JRDesignSubreport
| Field Summary | |
|---|---|
protected JRExpression |
connectionExpression
|
protected JRExpression |
dataSourceExpression
|
protected JRExpression |
expression
|
protected java.lang.Boolean |
isUsingCache
|
protected java.util.Map |
parametersMap
|
protected JRExpression |
parametersMapExpression
|
static java.lang.String |
PROPERTY_CONNECTION_EXPRESSION
|
static java.lang.String |
PROPERTY_DATASOURCE_EXPRESSION
|
static java.lang.String |
PROPERTY_EXPRESSION
|
static java.lang.String |
PROPERTY_PARAMETERS
|
static java.lang.String |
PROPERTY_PARAMETERS_MAP_EXPRESSION
|
static java.lang.String |
PROPERTY_RETURN_VALUES
|
protected java.util.List |
returnValues
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_Y |
| 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 | |
|---|---|
JRDesignSubreport(JRDefaultStyleProvider defaultStyleProvider)
|
|
| Method Summary | |
|---|---|
void |
addParameter(JRSubreportParameter subreportParameter)
|
void |
addReturnValue(JRSubreportReturnValue returnValue)
Adds a return value to the subreport. |
java.lang.Object |
clone()
|
void |
collectExpressions(JRExpressionCollector collector)
|
JRExpression |
getConnectionExpression()
|
JRExpression |
getDataSourceExpression()
|
JRExpression |
getExpression()
|
ModeEnum |
getModeValue()
Returns the element transparency mode. |
JRSubreportParameter[] |
getParameters()
|
java.util.Map |
getParametersMap()
|
JRExpression |
getParametersMapExpression()
|
JRSubreportReturnValue[] |
getReturnValues()
Returns the list of values to be copied from the subreport into the master. |
java.util.List |
getReturnValuesList()
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. |
JRSubreportParameter |
removeParameter(java.lang.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 |
setParametersMapExpression(JRExpression parametersMapExpression)
|
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 net.sf.jasperreports.engine.design.JRDesignElement |
|---|
addPropertyExpression, getPropertyExpressions, getPropertyExpressionsList, removePropertyExpression, removePropertyExpression, setElementGroup, setHeight, setKey, setPrintWhenExpression, setPrintWhenGroupChanges, setStyle, setStyleNameReference, setY |
| 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, getKey, getPositionType, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertyExpressions, getStretchType, getStretchTypeValue, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setPositionType, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setStretchType, setWidth, setX |
| Methods inherited from interface net.sf.jasperreports.engine.JRChild |
|---|
clone |
| Methods inherited from interface net.sf.jasperreports.engine.JRCommonElement |
|---|
getBackcolor, getForecolor, getHeight, getMode, getOwnBackcolor, getOwnForecolor, getOwnMode, getOwnModeValue, getWidth, setBackcolor, setForecolor, setMode, setMode, setMode |
| 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_CONNECTION_EXPRESSION
public static final java.lang.String PROPERTY_DATASOURCE_EXPRESSION
public static final java.lang.String PROPERTY_EXPRESSION
public static final java.lang.String PROPERTY_PARAMETERS_MAP_EXPRESSION
public static final java.lang.String PROPERTY_PARAMETERS
public static final java.lang.String PROPERTY_RETURN_VALUES
protected java.lang.Boolean isUsingCache
protected java.util.Map parametersMap
protected java.util.List returnValues
protected JRExpression parametersMapExpression
protected JRExpression connectionExpression
protected JRExpression dataSourceExpression
protected JRExpression expression
| Constructor Detail |
|---|
public JRDesignSubreport(JRDefaultStyleProvider defaultStyleProvider)
| Method Detail |
|---|
public ModeEnum getModeValue()
JRCommonElement
getModeValue in interface JRCommonElementgetModeValue in class JRBaseElementpublic boolean isUsingCache()
JRSubreport
isUsingCache in interface JRSubreportpublic void setUsingCache(boolean isUsingCache)
setUsingCache(Boolean).
JRSubreportFor 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 JRSubreportpublic JRExpression getParametersMapExpression()
getParametersMapExpression in interface JRSubreportpublic void setParametersMapExpression(JRExpression parametersMapExpression)
public JRSubreportParameter[] getParameters()
getParameters in interface JRSubreportpublic java.util.Map getParametersMap()
public void addParameter(JRSubreportParameter subreportParameter)
throws JRException
JRExceptionpublic JRSubreportParameter removeParameter(java.lang.String name)
public JRExpression getConnectionExpression()
getConnectionExpression in interface JRSubreportpublic void setConnectionExpression(JRExpression connectionExpression)
public JRExpression getDataSourceExpression()
getDataSourceExpression in interface JRSubreportpublic void setDataSourceExpression(JRExpression dataSourceExpression)
public JRExpression getExpression()
getExpression in interface JRSubreportpublic void setExpression(JRExpression expression)
public void collectExpressions(JRExpressionCollector collector)
collectExpressions in interface JRElementpublic void visit(JRVisitor visitor)
visit in interface JRVisitablepublic void addReturnValue(JRSubreportReturnValue returnValue)
returnValue - the return value to be added.public JRSubreportReturnValue[] getReturnValues()
getReturnValues in interface JRSubreportpublic java.util.List getReturnValuesList()
JRSubreportReturnValue objectspublic boolean removeReturnValue(JRSubreportReturnValue returnValue)
returnValue - the return value to be removed
true if the return value was found and removedpublic java.lang.Boolean isOwnUsingCache()
JRSubreport
isOwnUsingCache in interface JRSubreportpublic void setUsingCache(java.lang.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 java.lang.Boolean isRunToBottom()
JRSubreport
isRunToBottom in interface JRSubreportJRSubreport.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 JRSubreportrunToBottom - whether the subreport element will consume the entire
space down to the bottom of the pagepublic java.lang.Object clone()
clone in interface JRCloneableclone in class JRBaseElement
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||