com.crystaldecisions.sdk.occa.report.definition
Interface ISubreportObject

All Superinterfaces:
IClone, IReportObject
All Known Implementing Classes:
SubreportObject

public interface ISubreportObject
extends IReportObject

Use this interface to get or set a subreport name.

A subreport is a free-standing or linked report in the main report. This object contains information about the subreport such as layout and formatting. A subreport object is equivalent to a report object in that it contains the same properties.


Method Summary
 boolean getEnableOnDemand()
          Deprecated. As of Version 11. Use the getEnableOnDemand method instead.
 IFontColor getFontColor()
          For internal use only
 java.lang.String getOnDemandCaption()
          For internal use only
 java.lang.String getPreviewTabCaption()
          For internal use only
 java.lang.String getSubreportName()
          Returns the subreport name.
 SubreportObjectConditionFormulas getSubreportObjectConditionFormulas()
          For internal use only
 boolean getSuppressBlankSubreport()
          For internal use only
 void setEnableOnDemand(boolean enableOnDemand)
          Deprecated. As of Version 11. Use the setEnableOnDemand method instead.
 void setFontColor(IFontColor fontColor)
          For internal use only
 void setOnDemandCaption(java.lang.String caption)
          For internal use only
 void setPreviewTabCaption(java.lang.String caption)
          For internal use only
 void setSubreportName(java.lang.String subreportName)
          Sets the subreport name.
 void setSubreportObjectConditionFormulas(SubreportObjectConditionFormulas conditionFormulas)
          For internal use only
 void setSuppressBlankSubreport(boolean suppressBlankSubreport)
          For internal use only
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.definition.IReportObject
getBorder, getBorderMargins, getFormat, getHeight, getKind, getLeft, getLinkedURI, getName, getReplacementConditionFormulas, getReportPartBookmark, getSectionCode, getSectionName, getTop, getWidth, setBorder, setFormat, setHeight, setLeft, setLinkedURI, setName, setReplacementConditionFormulas, setReportPartBookmark, setSectionCode, setSectionName, setTop, setWidth
 

Method Detail

getEnableOnDemand

boolean getEnableOnDemand()
Deprecated. As of Version 11. Use the getEnableOnDemand method instead.

Returns whether the subreport is on-demand. On-demand subreports appear only as hyperlinks in the main report. The actual data is not read from the database until the user drills down on the hyperlink. Only data for the on-demand subreport that is actually viewed will be retrieved from the database. On-demand subreports may also be called "real time" subreports in some cases.

Returns:
true if the subreport is on-demand, and otherwise false.

getSubreportName

java.lang.String getSubreportName()

Returns the subreport name.

Returns:
The name of the subreport as a String.

getOnDemandCaption

java.lang.String getOnDemandCaption()
For internal use only


getPreviewTabCaption

java.lang.String getPreviewTabCaption()
For internal use only


setEnableOnDemand

void setEnableOnDemand(boolean enableOnDemand)
Deprecated. As of Version 11. Use the setEnableOnDemand method instead.

Sets whether the subreport is on-demand. On-demand subreports appear only as hyperlinks in the main report. The actual data is not read from the database until the user drills down on the hyperlink. Only data for the on-demand subreport that is actually viewed will be retrieved from the database. On-demand subreports may also be called "real time" subreports in some cases.

Parameters:
enableOnDemand - true if the subreport is on-demand, and otherwise false.

setSubreportName

void setSubreportName(java.lang.String subreportName)

Sets the subreport name.

Parameters:
subreportName - The name of the subreport as a String.

setOnDemandCaption

void setOnDemandCaption(java.lang.String caption)
For internal use only


setPreviewTabCaption

void setPreviewTabCaption(java.lang.String caption)
For internal use only


getSuppressBlankSubreport

boolean getSuppressBlankSubreport()
For internal use only


setSuppressBlankSubreport

void setSuppressBlankSubreport(boolean suppressBlankSubreport)
For internal use only


getFontColor

IFontColor getFontColor()
For internal use only


setFontColor

void setFontColor(IFontColor fontColor)
For internal use only


getSubreportObjectConditionFormulas

SubreportObjectConditionFormulas getSubreportObjectConditionFormulas()
For internal use only


setSubreportObjectConditionFormulas

void setSubreportObjectConditionFormulas(SubreportObjectConditionFormulas conditionFormulas)
For internal use only