jet.web.dhtml

Interface DHTMLWriter

public interface DHTMLWriter

Method Summary

Modifier and Type	Method and Description
byte[]	buildTOC(String sessionId, String rptSetId, String rptName, String nodeValue, String pageNum, String x, String y, int level) Returns a byte array of XML files about TOC tree.
byte[]	exportReport(String sessionId, String rptSetId, String rptName) Deprecated. Returns the result of the current page of the active report.
byte[]	exportReport(String sessionId, String rptSetId, String rptName, Map context) Returns the result of the current page of the active report.
byte[]	getBuildInNavigateStatus(String sessionId, String rptSetId, String rptName) Returns a string build in Navigate Status
String	getConnectFrame(String RptName) Returns a string of the connecting frame. If no frame setting is true, eturn HTML div tag; otherwise HTML iframe tag.
String	getReportBrowser(String rptName, int left, int top, String width, String height, boolean isDisplay, String bgColor, String position) Returns a string of the report. If no frame setting is true, return HTML div tag; otherwise HTML iframe tag.
byte[]	publishCss(String sessionId, String rptSetId, String rptName) Returns the style sheet of the current page of the active report.
byte[]	writeBuildinFilter(String sessionId, String rptSetId, String rptName, String height) Returns a string filter control html.
byte[]	writeBusinessCubeTree(String rptSetId, String rptName, String subRptKey, String businessCubeName, boolean includeDetail, String[] filterInBLnames, String includeRCName) Returns a byte array of XML files about business cube tree.
String	writeDSTreeofComponent(String sessionId, String rptSetId, String rptName, String dsid) Returns a string of XML files about DSO tree of the specified component.
String	writeDSTreeofComponentByInstanceName(String sessionId, String rptSetId, String rptName, String instName) Returns a string of XML files about DSO tree of the specified component.
String	writeHeader(String RptName, boolean isConnectPage, String[] JsFiles, String[] CssFiles, String PageTitle) Returns a string of HTML script and link tags. This method should be used with the early V7.3 version.

Method Detail

writeBusinessCubeTree

byte[] writeBusinessCubeTree(String rptSetId,
                             String rptName,
                             String subRptKey,
                             String businessCubeName,
                             boolean includeDetail,
                             String[] filterInBLnames,
                             String includeRCName)

Returns a byte array of XML files about business cube tree.

An example of the method:

%serverhome%/public_html/dhtmljsp/builddso.jsp.

Parameters:

rptSetId - the report set id.

rptName - the report name.

subRptKey - the key of the engine.

businessCubeName - the business cube name.

includeDetail - whether to include the detail information objects.

filterInBLnames - not used.

includeRCName - whether to include the RC objects.

sessionId - the user session id.

Returns:

a byte array of XML files about business cube tree.

publishCss

byte[] publishCss(String sessionId,
                  String rptSetId,
                  String rptName)
           throws jet.JDException

Returns the style sheet of the current page of the active report.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

the style sheet of the current page of the active report.

Throws:

jet.JDException

exportReport

byte[] exportReport(String sessionId,
                    String rptSetId,
                    String rptName)
             throws jet.JDException

Deprecated. Returns the result of the current page of the active report.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

the result of the current page of the active report.

Throws:

jet.JDException

See Also:

#exportReport(String, String, String, java.util.Map)}

buildTOC

byte[] buildTOC(String sessionId,
                String rptSetId,
                String rptName,
                String nodeValue,
                String pageNum,
                String x,
                String y,
                int level)

Returns a byte array of XML files about TOC tree.

An example of the method:

%serverhome%/public_html/dhtmljsp/builddso.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

nodeValue - the current node value. If it is null, returns the toc tree from the root; otherwise, return the toc tree from the specified node.

pageNum - not used.

x - not used.

y - not used.

level - not used.

Returns:

a byte array of XML files about TOC tree.

getConnectFrame

String getConnectFrame(String RptName)

Returns a string of the connecting frame.
If no frame setting is true, eturn HTML div tag; otherwise HTML iframe tag.

An example of the method:

%serverhome%/public_html/dhtmljsp/connect.jsp.

Parameters:

rptName - the report name.

Returns:

a string of the connecting frame.

getReportBrowser

String getReportBrowser(String rptName,
                        int left,
                        int top,
                        String width,
                        String height,
                        boolean isDisplay,
                        String bgColor,
                        String position)

Returns a string of the report.
If no frame setting is true, return HTML div tag; otherwise HTML iframe tag.

An example of the method:

%serverhome%/public_html/dhtmljsp/rptmain.jsp.

Parameters:

rptName - the report name.

left - refer to CSS left property.

top - refer to CSS top property.

width - refer to CSS width property.

height - refer to CSS height property.

isDisplay - refer to CSS display property, if false, 'style.display=none'; otherwise, default value.

bgColor - refer to CSS background property.

position - refer to CSS position property.

Returns:

a string of the report.

writeHeader

String writeHeader(String RptName,
                   boolean isConnectPage,
                   String[] JsFiles,
                   String[] CssFiles,
                   String PageTitle)

Returns a string of HTML script and link tags.
This method should be used with the early V7.3 version.

An example of the method:

%serverhome%/public_html/dhtmljsp/header.jsp.

Parameters:

RptName - the report name.

isConnectPage - if true, it is connecting page; otherwise HTML script tag.

JsFiles - the javascript files which are used in the HTML page.

CssFiles - the CSS files which are used in the HTML page.

PageTitle - the title which is used in the HTML page. Not used.

Returns:

Returns a string of HTML.

writeDSTreeofComponent

String writeDSTreeofComponent(String sessionId,
                              String rptSetId,
                              String rptName,
                              String dsid)

Returns a string of XML files about DSO tree of the specified component.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

dsid - ID of the result object.

Returns:

a string of XML files about DSO tree.

writeBuildinFilter

byte[] writeBuildinFilter(String sessionId,
                          String rptSetId,
                          String rptName,
                          String height)

Returns a string filter control html.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

height - the filter panel height.

Returns:

a string of Filter Control component (filtercontrol.html).

getBuildInNavigateStatus

byte[] getBuildInNavigateStatus(String sessionId,
                                String rptSetId,
                                String rptName)

Returns a string build in Navigate Status

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

a string of Build in Navigate Status (ex:[false,false]).

writeDSTreeofComponentByInstanceName

String writeDSTreeofComponentByInstanceName(String sessionId,
                                            String rptSetId,
                                            String rptName,
                                            String instName)

Returns a string of XML files about DSO tree of the specified component.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

instName - the component name.

Returns:

a string of XML files about DSO tree.

exportReport

byte[] exportReport(String sessionId,
                    String rptSetId,
                    String rptName,
                    Map context)
             throws jet.JDException

Returns the result of the current page of the active report.

An example of the method:

%serverhome%/public_html/dhtmljsp/report.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

context - the informations when exporting reports. Includes "jrd.param.getfileurl", "jrd.param.encoding";

Returns:

the result of the current page of the active report.

Throws:

jet.JDException