|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.crystaldecisions.sdk.occa.report.template.ReportTemplate
public class ReportTemplate
This class is used to apply a template to a report. The
applyToDocument method applies a template to an open report.
The applyTo method applies a template to a file on disk.
ReportTemplate object, use one of the following two methods:
ReportTemplate(String templateReportPath, String ras) constructor to create a report template
in unmanaged RAS environments. In this case, because you are not
using the ReportTemplateEngine to create the TemplateEngine object and to set the RAS server
before calling the createTemplate method, you must set the RAS server for the ReportTemplate object here.
Be sure to use the appropriate unmanaged RAS report path. ReportTemplate(ReportClientDocument templateClientDoc) constructor to create a report template. You can use
this method in both managed RAS or unmanaged RAS environments.
| Constructor Summary | |
|---|---|
ReportTemplate()
|
|
ReportTemplate(ReportClientDocument templateClientDoc)
|
|
ReportTemplate(java.lang.String templateReportPath,
java.lang.String ras)
|
|
| Method Summary | |
|---|---|
void |
applyTo(java.lang.String targetFile,
java.lang.String saveAsFileName,
java.lang.String saveAsFilePath)
Applies the template to the report specified by the file path. |
void |
applyToDocument(ReportClientDocument targetClientDoc)
Applies the template to the specified ReportClientDocument. |
java.util.Locale |
getLocale()
Deprecated. Replaced by ReportTemplate.getProductLocale(). See also ReportTemplate.getPreferredViewingLocale(). |
java.util.Locale |
getPreferredViewingLocale()
Returns the locale used to render the report. |
java.util.Locale |
getProductLocale()
Returns the locale of the application user interface and error messages. |
void |
setLocale(java.util.Locale locale)
Deprecated. Replaced by #setProductLocale(). See also #setPreferredViewingLocale(). |
void |
setPreferredViewingLocale(java.util.Locale preferredViewingLocale)
Sets the locale used to render the report. |
void |
setProductLocale(java.util.Locale productLocale)
Sets the locale of the application user interface and error messages. |
void |
setReportAppServer(ReportAppSession reportAppSession)
Sets the RAS server that is used to open the report. |
void |
setReportAppServer(java.lang.String rasserver)
Sets the RAS server that is used to open the report. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ReportTemplate()
public ReportTemplate(java.lang.String templateReportPath,
java.lang.String ras)
throws ReportTemplateException
ReportTemplateException
public ReportTemplate(ReportClientDocument templateClientDoc)
throws ReportTemplateException
ReportTemplateException| Method Detail |
|---|
public void applyTo(java.lang.String targetFile,
java.lang.String saveAsFileName,
java.lang.String saveAsFilePath)
throws ReportTemplateException,
java.io.IOException
Applies the template to the report specified by the file path.
targetFile - The target file (that the template is applied to).saveAsFileName - The file name of the report.saveAsFilePath - The file path of the report.
ReportTemplateException
java.io.IOException
public void applyToDocument(ReportClientDocument targetClientDoc)
throws ReportTemplateException
Applies the template to the specified ReportClientDocument. Use this method to apply the template to an open report.
targetClientDoc - The report to apply the template to.
ReportTemplateExceptionpublic java.util.Locale getLocale()
ReportTemplate.getProductLocale(). See also ReportTemplate.getPreferredViewingLocale().
Returns the locale used by this object for region and language settings.
Locale object used by this object for region and language settings.public java.util.Locale getProductLocale()
ReportTemplate.getPreferredViewingLocale()public java.util.Locale getPreferredViewingLocale()
ReportTemplate.getProductLocale()public void setLocale(java.util.Locale locale)
#setProductLocale(). See also #setPreferredViewingLocale().
Sets the locale used by this object for region and language settings.
locale - The Locale object used by this object for region and language settings.public void setProductLocale(java.util.Locale productLocale)
#setPreferredViewingLocale()public void setPreferredViewingLocale(java.util.Locale preferredViewingLocale)
#setProductLocale()public void setReportAppServer(ReportAppSession reportAppSession)
Sets the RAS server that is used to open the report.
reportAppSession - A ReportAppSession object that specifies the RAS server to be
used.
public void setReportAppServer(java.lang.String rasserver)
throws ReportSDKException
Sets the RAS server that is used to open the report.
rasserver - A String that specifies name of the RAS server to be
used.
ReportSDKException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||