|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.crystaldecisions.sdk.occa.report.definition.ReportObject
com.crystaldecisions.sdk.occa.report.definition.SubreportObject
public class SubreportObject
This object represents a subreport placed in a report. A subreport is a free-standing or linked report found within the main report. This object provides properties for retrieving information on the subreport (for example, name, formatting options, and so on). This object is identical to the ReportObject object except that it also contains the name of the subreport.
The
SubreportController
object and the ISubreportClientDocument object are defined in the
com.crystaldecisions.sdk.occa.report.application package. Use the
SubreportController object to import a report as a subreport and to add or remove
subreport links. In addition, this object can be used to retrieve the names of all of the
subreports in a report. Then use the subreport name to access the associated
SubreportClientDocument object, which provides access to the various controllers
that are necessary to modify a subreport. You can also use the subreport name to get a list of
tables in the subreport, or to set a table's database to a different location.
| Constructor Summary | |
|---|---|
SubreportObject()
|
|
SubreportObject(ISubreportObject src)
|
|
| Method Summary | |
|---|---|
java.lang.Object |
clone(boolean deepClone)
|
void |
copyTo(java.lang.Object destObject,
boolean deepCopy)
|
java.lang.Object |
createMember(java.lang.String eleName,
org.xml.sax.Attributes attrs,
XMLSerializationContext ctxt,
java.util.Map objState,
boolean[] bLoaded)
For internal use only. |
void |
endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only. |
boolean |
getEnableOnDemand()
Deprecated. |
IFontColor |
getFontColor()
For internal use only |
IFormula |
getFormula(TranslatableStringId id)
For internal use only |
java.lang.String |
getImageKey()
For internal use only. |
java.lang.String |
getOnDemandCaption()
For internal use only |
java.lang.String |
getPreviewTabCaption()
For internal use only |
SubreportLinks |
getSubreportLinks()
Returns the SubreportLinks object, which contains the links between the main
report fields and the subreport fields. |
java.lang.String |
getSubreportName()
Returns the subreport name. |
SubreportObjectConditionFormulas |
getSubreportObjectConditionFormulas()
For internal use only |
boolean |
getSuppressBlankSubreport()
For internal use only |
java.lang.String |
getTranslatableString(TranslatableStringId id)
For internal use only |
java.util.List |
getTranslatableStringIds()
For internal use only |
java.lang.String |
getTranslatableStringLabelResourceID(TranslatableStringId id)
For internal use only |
boolean |
hasContent(java.lang.Object srcSubreportObject)
|
void |
readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
For internal use only. |
void |
save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
For internal use only. |
void |
save(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
setEnableOnDemand(boolean enableOnDemand)
Deprecated. |
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 |
setSubreportLinks(SubreportLinks subreportLinks)
Sets the SubreportLinks object, which contains the links between the main
report fields and the subreport fields. |
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 |
void |
setTranslatableString(TranslatableStringId id,
java.lang.String newText)
For internal use only |
void |
startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
For internal use only. |
| Methods inherited from class com.crystaldecisions.sdk.occa.report.definition.ReportObject |
|---|
getBorder, getBorderMargins, getFormat, getHeight, getKind, getLeft, getLinkedURI, getName, getReplacementConditionFormulas, getReportPartBookmark, getSectionCode, getSectionName, getTop, getTranslatableObject, getVersion, getWidth, setBorder, setFormat, setHeight, setKind, setLeft, setLinkedURI, setName, setReplacementConditionFormulas, setReportPartBookmark, setSectionCode, setSectionName, setTop, setVersion, setWidth |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| 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 |
| Constructor Detail |
|---|
public SubreportObject(ISubreportObject src)
public SubreportObject()
| Method Detail |
|---|
public java.lang.Object clone(boolean deepClone)
clone in class ReportObject
public void copyTo(java.lang.Object destObject,
boolean deepCopy)
copyTo in class ReportObject
public java.lang.Object createMember(java.lang.String eleName,
org.xml.sax.Attributes attrs,
XMLSerializationContext ctxt,
java.util.Map objState,
boolean[] bLoaded)
ReportObjectFor internal use only.
createMember in class ReportObject
public void endElement(java.lang.String eleName,
java.util.Map objState)
ReportObjectFor internal use only.
endElement in class ReportObject@Deprecated public boolean getEnableOnDemand()
ISubreportObjectReturns 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.
getEnableOnDemand in interface ISubreportObjecttrue if the subreport is on-demand, and otherwise false.public SubreportLinks getSubreportLinks()
Returns the SubreportLinks object, which contains the links between the main
report fields and the subreport fields.
SubreportLinks object, which contains the links between the main
report fields and the subreport fields..public java.lang.String getSubreportName()
ISubreportObjectReturns the subreport name.
getSubreportName in interface ISubreportObjectString.public boolean hasContent(java.lang.Object srcSubreportObject)
hasContent in class ReportObject
public void readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
ReportObjectFor internal use only.
readElement in class ReportObject
public void save(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
ReportObjectFor internal use only.
save in class ReportObjectjava.io.IOException
public void save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
throws java.io.IOException
ReportObjectFor internal use only.
save in class ReportObjectjava.io.IOException
public void saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
ReportObjectFor internal use only.
saveContents in class ReportObjectjava.io.IOException@Deprecated public void setEnableOnDemand(boolean enableOnDemand)
ISubreportObjectSets 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.
setEnableOnDemand in interface ISubreportObjectenableOnDemand - true if the subreport is on-demand, and otherwise false.public void setSubreportLinks(SubreportLinks subreportLinks)
Sets the SubreportLinks object, which contains the links between the main
report fields and the subreport fields.
subreportLinks - The SubreportLinks object, which contains the links
between the main report fields and the subreport fields.public void setSubreportName(java.lang.String subreportName)
ISubreportObjectSets the subreport name.
setSubreportName in interface ISubreportObjectsubreportName - The name of the subreport as a String.
public void startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
ReportObjectFor internal use only.
startElement in class ReportObjectpublic boolean getSuppressBlankSubreport()
ISubreportObject
getSuppressBlankSubreport in interface ISubreportObjectpublic void setSuppressBlankSubreport(boolean suppressBlankSubreport)
ISubreportObject
setSuppressBlankSubreport in interface ISubreportObjectpublic IFontColor getFontColor()
ISubreportObject
getFontColor in interface ISubreportObjectpublic void setFontColor(IFontColor fontColor)
ISubreportObject
setFontColor in interface ISubreportObjectpublic SubreportObjectConditionFormulas getSubreportObjectConditionFormulas()
ISubreportObject
getSubreportObjectConditionFormulas in interface ISubreportObjectpublic void setSubreportObjectConditionFormulas(SubreportObjectConditionFormulas conditionFormulas)
ISubreportObject
setSubreportObjectConditionFormulas in interface ISubreportObjectpublic java.lang.String getOnDemandCaption()
ISubreportObject
getOnDemandCaption in interface ISubreportObjectpublic java.lang.String getPreviewTabCaption()
ISubreportObject
getPreviewTabCaption in interface ISubreportObjectpublic void setOnDemandCaption(java.lang.String caption)
ISubreportObject
setOnDemandCaption in interface ISubreportObjectpublic void setPreviewTabCaption(java.lang.String caption)
ISubreportObject
setPreviewTabCaption in interface ISubreportObjectpublic java.util.List getTranslatableStringIds()
getTranslatableStringIds in class ReportObjectpublic java.lang.String getTranslatableString(TranslatableStringId id)
getTranslatableString in class ReportObject
public void setTranslatableString(TranslatableStringId id,
java.lang.String newText)
setTranslatableString in class ReportObjectpublic java.lang.String getTranslatableStringLabelResourceID(TranslatableStringId id)
getTranslatableStringLabelResourceID in class ReportObjectpublic IFormula getFormula(TranslatableStringId id)
getFormula in class ReportObjectpublic java.lang.String getImageKey()
For internal use only.
getImageKey in class ReportObject
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||