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()
          Returns whether the subreport is on-demand.
 IFontColor getFontColor()
           
 java.lang.String getOnDemandCaption()
           
 java.lang.String getPreviewTabCaption()
           
 java.lang.String getSubreportName()
          Returns the subreport name.
 SubreportObjectConditionFormulas getSubreportObjectConditionFormulas()
           
 boolean getSuppressBlankSubreport()
           
 void setEnableOnDemand(boolean enableOnDemand)
          Sets whether the subreport is on-demand.
 void setFontColor(IFontColor fontColor)
           
 void setOnDemandCaption(java.lang.String caption)
           
 void setPreviewTabCaption(java.lang.String caption)
           
 void setSubreportName(java.lang.String subreportName)
          Sets the subreport name.
 void setSubreportObjectConditionFormulas(SubreportObjectConditionFormulas conditionFormulas)
           
 void setSuppressBlankSubreport(boolean suppressBlankSubreport)
           
 
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()

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()

getPreviewTabCaption

java.lang.String getPreviewTabCaption()

setEnableOnDemand

void setEnableOnDemand(boolean enableOnDemand)

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)

setPreviewTabCaption

void setPreviewTabCaption(java.lang.String caption)

getSuppressBlankSubreport

boolean getSuppressBlankSubreport()

setSuppressBlankSubreport

void setSuppressBlankSubreport(boolean suppressBlankSubreport)

getFontColor

IFontColor getFontColor()

setFontColor

void setFontColor(IFontColor fontColor)

getSubreportObjectConditionFormulas

SubreportObjectConditionFormulas getSubreportObjectConditionFormulas()

setSubreportObjectConditionFormulas

void setSubreportObjectConditionFormulas(SubreportObjectConditionFormulas conditionFormulas)