com.stimulsoft.webviewer
Class StiWebViewer

java.lang.Object
  com.stimulsoft.webviewer.StiWebViewer

public class StiWebViewer
extends Object

WebViewer main class Copyright Stimulsoft

Field Summary

static String	ACTION_DESIGN_REPORT
static String	ACTION_EMAIL_REPORT
static String	ACTION_EXPORT_REPORT
static String	ACTION_ITERACTION
static String	ACTION_JS
static String	ACTION_PRINT_REPORT
static String	ACTION_REPORT_SNAPSHOT
static String	ACTION_VIEWER_EVENT
static String	EXCEPTION_HANDLER
protected static Logger	LOG
static String	MAIL_PROPERTIES
static String	PAGE_SEPARATOR
static String	PARAMETERS_ATTRIBUTE
static String	SESSION_ATTRIBUTE_DEMO_REPORT_NAME
static String	VERSION
static String	VIEWER_ID_PARAM
static String	VIEWER_PARAMETER_ATTRIBUTE

Constructor Summary

StiWebViewer(StiWebViewerOptions options, URL context)

Method Summary

void	clearStoredObjects(javax.servlet.http.HttpServletRequest request, StiWebViewerOptions options)
protected String	createChildControls(Element root, Document doc, URL context, javax.servlet.ServletContext servletContext)
static String	emailReportResult(javax.servlet.http.HttpServletRequest httpContext)
static String	emailReportResult(javax.servlet.http.HttpServletRequest httpContext, StiJavascriptParameters jsParams) Export the report action result by the client request and send it by Email.
static String	emailReportResult(javax.servlet.http.HttpServletRequest httpContext, StiReport report, StiMailProperties options) Export the report action result by the client request and send it by Email.
static StiFileResult	exportReportResult(javax.servlet.http.HttpServletRequest httpContext, StiReport report) Export the report action result by the specified report and client request.
static StiMailProperties	getEmailOptions(javax.servlet.http.HttpServletRequest httpContext) Get the Email options, sent by the client.
static StiReport	getReportObject(javax.servlet.http.HttpServletRequest httpContext, StiJavascriptParameters jsParams)
static StiReport	getReportObject(javax.servlet.http.HttpServletRequest httpContext, String paramsGuid, StiJavascriptParameters jsParams) Get the report template or report snapshot, sent by the client.
static Object	getStoredObject(javax.servlet.http.HttpServletRequest httpContext, String viewerId) return stored in session object.
String	getViewer(URL context, javax.servlet.ServletContext servletContext)
static Object	interactionResult(javax.servlet.http.HttpServletRequest httpContext) Get the requested interaction result.
static Object	interactionResult(javax.servlet.http.HttpServletRequest httpContext, StiReport report, StiJavascriptParameters jsParams) Get the requested interaction result of the specified report.
static Object	printReportResult(javax.servlet.http.HttpServletRequest httpContext, StiJavascriptParameters jsParams) Get the prepared report for printing.
static Object	printReportResult(javax.servlet.http.HttpServletRequest httpContext, StiReport report) Get the prepared specified report for printing.
static Object	processExport(javax.servlet.http.HttpServletRequest httpContext, StiReport report, StiMailProperties properies)
static void	saveReportObject(javax.servlet.http.HttpServletRequest httpContext, StiReport report, boolean ignorjsParam, StiJavascriptParameters jsParams)
static void	saveReportObject(javax.servlet.http.HttpServletRequest httpContext, StiReport report, StiJavascriptParameters jsParams)
static String	serialize(Document doc, boolean omitXMLDeclaration)
void	storeObject(javax.servlet.http.HttpServletRequest httpContext, Object object, String viewerId) Store object in session
static Object	viewerEventResult(javax.servlet.http.HttpServletRequest httpContext, StiReport report, boolean detectActionResult, StiJavascriptParameters jsParams) Get the requested report page of the specified report.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION

public static final String VERSION

LOG

protected static final Logger LOG

PAGE_SEPARATOR

public static final String PAGE_SEPARATOR

See Also:

Constant Field Values

ACTION_REPORT_SNAPSHOT

public static final String ACTION_REPORT_SNAPSHOT

See Also:

Constant Field Values

ACTION_VIEWER_EVENT

public static final String ACTION_VIEWER_EVENT

See Also:

Constant Field Values

ACTION_PRINT_REPORT

public static final String ACTION_PRINT_REPORT

See Also:

Constant Field Values

ACTION_EXPORT_REPORT

public static final String ACTION_EXPORT_REPORT

See Also:

Constant Field Values

ACTION_DESIGN_REPORT

public static final String ACTION_DESIGN_REPORT

See Also:

Constant Field Values

ACTION_ITERACTION

public static final String ACTION_ITERACTION

See Also:

Constant Field Values

ACTION_EMAIL_REPORT

public static final String ACTION_EMAIL_REPORT

See Also:

Constant Field Values

ACTION_JS

public static final String ACTION_JS

See Also:

Constant Field Values

SESSION_ATTRIBUTE_DEMO_REPORT_NAME

public static final String SESSION_ATTRIBUTE_DEMO_REPORT_NAME

See Also:

Constant Field Values

VIEWER_PARAMETER_ATTRIBUTE

public static final String VIEWER_PARAMETER_ATTRIBUTE

See Also:

Constant Field Values

VIEWER_ID_PARAM

public static final String VIEWER_ID_PARAM

See Also:

Constant Field Values

PARAMETERS_ATTRIBUTE

public static final String PARAMETERS_ATTRIBUTE

See Also:

Constant Field Values

MAIL_PROPERTIES

public static final String MAIL_PROPERTIES

See Also:

Constant Field Values

EXCEPTION_HANDLER

public static final String EXCEPTION_HANDLER

See Also:

Constant Field Values

Constructor Detail

StiWebViewer

public StiWebViewer(StiWebViewerOptions options,
                    URL context)

Method Detail

getViewer

public String getViewer(URL context,
                        javax.servlet.ServletContext servletContext)
                 throws ParserConfigurationException,
                        IOException

Throws:

ParserConfigurationException

IOException

createChildControls

protected String createChildControls(Element root,
                                     Document doc,
                                     URL context,
                                     javax.servlet.ServletContext servletContext)
                              throws IOException

Throws:

IOException

serialize

public static String serialize(Document doc,
                               boolean omitXMLDeclaration)
                        throws IOException

Throws:

IOException

getReportObject

public static StiReport getReportObject(javax.servlet.http.HttpServletRequest httpContext,
                                        StiJavascriptParameters jsParams)

getReportObject

public static StiReport getReportObject(javax.servlet.http.HttpServletRequest httpContext,
                                        String paramsGuid,
                                        StiJavascriptParameters jsParams)

Get the report template or report snapshot, sent by the client.

Parameters:

httpContext -

Returns:

getStoredObject

public static Object getStoredObject(javax.servlet.http.HttpServletRequest httpContext,
                                     String viewerId)

return stored in session object.

Parameters:

httpContext -

viewerId -

Returns:

clearStoredObjects

public void clearStoredObjects(javax.servlet.http.HttpServletRequest request,
                               StiWebViewerOptions options)

storeObject

public void storeObject(javax.servlet.http.HttpServletRequest httpContext,
                        Object object,
                        String viewerId)
                 throws IOException,
                        StiException

Store object in session

Parameters:

httpContext -

object -

Throws:

IOException

StiException

saveReportObject

public static void saveReportObject(javax.servlet.http.HttpServletRequest httpContext,
                                    StiReport report,
                                    StiJavascriptParameters jsParams)

saveReportObject

public static void saveReportObject(javax.servlet.http.HttpServletRequest httpContext,
                                    StiReport report,
                                    boolean ignorjsParam,
                                    StiJavascriptParameters jsParams)

viewerEventResult

public static Object viewerEventResult(javax.servlet.http.HttpServletRequest httpContext,
                                       StiReport report,
                                       boolean detectActionResult,
                                       StiJavascriptParameters jsParams)
                                throws IOException,
                                       StiException,
                                       JSONException,
                                       NoSuchAlgorithmException,
                                       ParserConfigurationException

Get the requested report page of the specified report.

Parameters:

httpContext -

report -

Returns:

Throws:

IOException

StiException

JSONException

ParserConfigurationException

NoSuchAlgorithmException

printReportResult

public static Object printReportResult(javax.servlet.http.HttpServletRequest httpContext,
                                       StiJavascriptParameters jsParams)
                                throws StiException,
                                       IOException,
                                       JSONException

Get the prepared report for printing.

Parameters:

httpContext -

Returns:

Throws:

IOException

StiException

JSONException

printReportResult

public static Object printReportResult(javax.servlet.http.HttpServletRequest httpContext,
                                       StiReport report)
                                throws StiException,
                                       IOException,
                                       JSONException

Get the prepared specified report for printing.

Parameters:

httpContext -

report -

Returns:

Throws:

StiException

IOException

JSONException

emailReportResult

public static String emailReportResult(javax.servlet.http.HttpServletRequest httpContext)
                                throws NoSuchAlgorithmException,
                                       UnsupportedEncodingException,
                                       JSONException,
                                       IOException,
                                       StiException,
                                       ParserConfigurationException

Throws:

NoSuchAlgorithmException

UnsupportedEncodingException

JSONException

IOException

StiException

ParserConfigurationException

emailReportResult

public static String emailReportResult(javax.servlet.http.HttpServletRequest httpContext,
                                       StiJavascriptParameters jsParams)
                                throws NoSuchAlgorithmException,
                                       JSONException,
                                       IOException,
                                       StiException,
                                       ParserConfigurationException

Export the report action result by the client request and send it by Email.

Parameters:

httpContext -

options -

Returns:

Throws:

StiException

IOException

JSONException

NoSuchAlgorithmException

ParserConfigurationException

emailReportResult

public static String emailReportResult(javax.servlet.http.HttpServletRequest httpContext,
                                       StiReport report,
                                       StiMailProperties options)
                                throws NoSuchAlgorithmException,
                                       JSONException,
                                       IOException,
                                       StiException,
                                       ParserConfigurationException

Export the report action result by the client request and send it by Email.

Parameters:

httpContext -

report -

options -

Returns:

Throws:

StiException

IOException

JSONException

NoSuchAlgorithmException

ParserConfigurationException

exportReportResult

public static StiFileResult exportReportResult(javax.servlet.http.HttpServletRequest httpContext,
                                               StiReport report)
                                        throws JSONException,
                                               NoSuchAlgorithmException,
                                               IOException,
                                               StiException,
                                               ParserConfigurationException

Export the report action result by the specified report and client request.

Parameters:

httpContext -

report -

Returns:

Throws:

JSONException

NoSuchAlgorithmException

IOException

StiException

ParserConfigurationException

processExport

public static Object processExport(javax.servlet.http.HttpServletRequest httpContext,
                                   StiReport report,
                                   StiMailProperties properies)
                            throws JSONException,
                                   NoSuchAlgorithmException,
                                   IOException,
                                   StiException,
                                   ParserConfigurationException

Throws:

JSONException

NoSuchAlgorithmException

IOException

StiException

ParserConfigurationException

interactionResult

public static Object interactionResult(javax.servlet.http.HttpServletRequest httpContext)
                                throws JSONException,
                                       IOException,
                                       StiException,
                                       NoSuchAlgorithmException,
                                       ParserConfigurationException

Get the requested interaction result.

Parameters:

httpContext -

Returns:

Throws:

JSONException

IOException

StiException

ParserConfigurationException

NoSuchAlgorithmException

interactionResult

public static Object interactionResult(javax.servlet.http.HttpServletRequest httpContext,
                                       StiReport report,
                                       StiJavascriptParameters jsParams)
                                throws JSONException,
                                       IOException,
                                       StiException,
                                       NoSuchAlgorithmException,
                                       ParserConfigurationException

Get the requested interaction result of the specified report.

Parameters:

httpContext -

report -

Returns:

Throws:

JSONException

IOException

StiException

ParserConfigurationException

NoSuchAlgorithmException

getEmailOptions

public static StiMailProperties getEmailOptions(javax.servlet.http.HttpServletRequest httpContext)
                                         throws JSONException,
                                                UnsupportedEncodingException

Get the Email options, sent by the client.

Parameters:

httpContext -

Returns:

Throws:

JSONException

UnsupportedEncodingException