netcharts.server.api
Class NSWebToolKit

java.lang.Object
  |
  +--netcharts.server.api.NSToolKit
        |
        +--netcharts.server.api.NSWebToolKit

public class NSWebToolKit

extends NSToolKit

Extends NSToolkit and provides methods to simplify the display of charts in HTML.

Fields inherited from class netcharts.server.api.NSToolKit

PROJECTS, TOOLKIT_USER_AGENT

Constructor Summary

NSWebToolKit()
Constructs a local toolkit with no communication information and no security credentials.

NSWebToolKit(java.lang.String projectName)
Constructs a local toolkit with no security credentials.

NSWebToolKit(java.lang.String serverName, int portNumber, java.lang.String projectName)
Constructs a toolkit with communication information and no security credentials.

NSWebToolKit(java.lang.String serverName, int portNumber, java.lang.String projectName, java.lang.String userName, java.lang.String userPassword)
Constructs a toolkit with communication information and security credentials.

NSWebToolKit(java.lang.String serverName, int portNumber, java.lang.String projectName, java.lang.String userName, java.lang.String userPassword, boolean secure)
Constructs a toolkit with communication information and security credentials.

NSWebToolKit(java.lang.String projectName, java.lang.String userName, java.lang.String userPassword)
Constructs a local toolkit with security credentials.

Method Summary

boolean	getAccessibilityMode() Get the Accessibility Mode.
java.lang.String	getAMActiveLabelTextTemplate() Get the text template used to construct alt tags on the active regions of a drill down image (map area tags).
java.lang.String	getAMChartDescription() Get the description to be used in the alt tag on chart images.
java.lang.String	getChartAsImageAndMap(java.lang.String chartFile, java.util.Hashtable variables, javax.servlet.http.HttpServletRequest request, boolean includeJavaScript) Retrieves a chart and returns the HTML tags representing the chart and imagemap.
java.lang.String	getChartAsImageAndMap(java.lang.String chartFile, java.util.Hashtable variables, javax.servlet.http.HttpServletRequest request, boolean includeJavaScript, java.lang.String defaultHREF) Retrieves a chart and returns the HTML tags representing the chart and imagemap.
java.lang.String	getChartAsImageTag(java.lang.String chartFile, java.util.Hashtable variables, javax.servlet.http.HttpServletRequest request) Retrieves a chart and returns the HTML <img> tag representing the chart.
static java.lang.String	getRolloverJavaScript() Return the JavaScript and <div> tag used for chart interactivity.
void	setAccessibilityMode(boolean accessibilityMode) Enable or disable Accessibility Mode.
void	setAMActiveLabelTextTemplate(java.lang.String amActiveLabelTextTemplate) Set the text template used to construct alt tags on the active regions of a drill down image (map area tags).
void	setAMChartDescription(java.lang.String amChartDescription) Set the description to be used in the alt tag on chart images.

Methods inherited from class netcharts.server.api.NSToolKit

getChart, getChart, getChartPage, getChartPage, getDataCacheEntry, getDataCacheEntryAsNCXML, getDataCacheEntryAsResultSet, getEncoding, getNDSData, getNDSDataAsCSV, getNDSDataAsNCXML, getNDSDataAsResultSet, getNDSDataAsVector, getPDFReport, getServerReply, getTable, getTable, putDataCacheEntry, putDataCacheEntry, putDataCacheEntry, putDataCacheEntry, removeDataCacheEntry, setEncoding, setProject, setServerInfo, setUserCredentials

Methods inherited from class java.lang.Object

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

Constructor Detail

NSWebToolKit

public NSWebToolKit()

Constructs a local toolkit with no communication information and no security credentials.

NSWebToolKit

public NSWebToolKit(java.lang.String projectName)

Constructs a local toolkit with no security credentials.

Parameters:

projectName - The project within NetCharts Server to access files.

NSWebToolKit

public NSWebToolKit(java.lang.String projectName,
                    java.lang.String userName,
                    java.lang.String userPassword)

Constructs a local toolkit with security credentials.

Parameters:

projectName - The project within NetCharts Server to access files.

userName - The name of a NetCharts Server user with proper security credentials.

userPassword - The password of a NetCharts Server user with proper security credentials.

NSWebToolKit

public NSWebToolKit(java.lang.String serverName,
                    int portNumber,
                    java.lang.String projectName)

Constructs a toolkit with communication information and no security credentials.

Parameters:

serverName - The name of the server.

portNumber - The port of the server.

projectName - The project to consider the root directory of the server files.

NSWebToolKit

public NSWebToolKit(java.lang.String serverName,
                    int portNumber,
                    java.lang.String projectName,
                    java.lang.String userName,
                    java.lang.String userPassword)

Constructs a toolkit with communication information and security credentials.

Parameters:

serverName - The name of the server.

portNumber - The port of the server.

projectName - The project to consider the root directory of the server files.

userName - The name of a user with proper security credentials.

userPassword - The password of a user with proper security credentials.

NSWebToolKit

public NSWebToolKit(java.lang.String serverName,
                    int portNumber,
                    java.lang.String projectName,
                    java.lang.String userName,
                    java.lang.String userPassword,
                    boolean secure)

Constructs a toolkit with communication information and security credentials.

Parameters:

serverName - The name of the server.

portNumber - The port of the server.

projectName - The project to consider the root directory of the server files.

userName - The name of a user with proper security credentials.

userPassword - The password of a user with proper security credentials.

secure - Whether we are connected to a SSL based port.

Method Detail

setAccessibilityMode

public void setAccessibilityMode(boolean accessibilityMode)

Enable or disable Accessibility Mode. With Accessiblity Mode enabled the pages produced include accessibility features (such as alt tags) instead of the default javascript based popup labels.

getAccessibilityMode

public boolean getAccessibilityMode()

Get the Accessibility Mode.

setAMActiveLabelTextTemplate

public void setAMActiveLabelTextTemplate(java.lang.String amActiveLabelTextTemplate)

Set the text template used to construct alt tags on the active regions of a drill down image (map area tags). This template can include variable names from ImageMapCreator such as LABEL_REPLACE. This is only used when Accessibility Mode is enabled.

getAMActiveLabelTextTemplate

public java.lang.String getAMActiveLabelTextTemplate()

Get the text template used to construct alt tags on the active regions of a drill down image (map area tags).

setAMChartDescription

public void setAMChartDescription(java.lang.String amChartDescription)

Set the description to be used in the alt tag on chart images. This is only used when Accessibility Mode is enabled.

getAMChartDescription

public java.lang.String getAMChartDescription()

Get the description to be used in the alt tag on chart images.

getRolloverJavaScript

public static java.lang.String getRolloverJavaScript()

Return the JavaScript and <div> tag used for chart interactivity. This can be used to introduce the script code at any time during the page creation process. Commonly used when the final resultant page contains charts within tables.

Returns:

The JavaScript and <div> tag used for interactivity.

getChartAsImageTag

public java.lang.String getChartAsImageTag(java.lang.String chartFile,
                                           java.util.Hashtable variables,
                                           javax.servlet.http.HttpServletRequest request)
                                    throws java.lang.IllegalArgumentException,
                                           NSToolKitException

Retrieves a chart and returns the HTML <img> tag representing the chart.

Parameters:

chartFile - The specified chart template to retrieve.

request - The HTTP Request of the calling web application.

Returns:

The HTML tags to include the chart image in the page.

getChartAsImageAndMap

public java.lang.String getChartAsImageAndMap(java.lang.String chartFile,
                                              java.util.Hashtable variables,
                                              javax.servlet.http.HttpServletRequest request,
                                              boolean includeJavaScript)
                                       throws java.lang.IllegalArgumentException,
                                              NSToolKitException

Retrieves a chart and returns the HTML tags representing the chart and imagemap.

Parameters:

chartFile - The specified chart template to retrieve.

request - The HTTP Request of the calling web application.

includeJavaScript - Whether or not to include the JavaScript for chart interaction with the returned tags.

Returns:

The HTML tags and image related code to include the chart image in the page.

getChartAsImageAndMap

public java.lang.String getChartAsImageAndMap(java.lang.String chartFile,
                                              java.util.Hashtable variables,
                                              javax.servlet.http.HttpServletRequest request,
                                              boolean includeJavaScript,
                                              java.lang.String defaultHREF)
                                       throws java.lang.IllegalArgumentException,
                                              NSToolKitException

Retrieves a chart and returns the HTML tags representing the chart and imagemap.

Parameters:

chartFile - The specified chart template to retrieve.

request - The HTTP Request of the calling web application.

includeJavaScript - Whether or not to include the JavaScript for chart interaction with the returned tags.

defaultHREF - The URL to place in the HREF attribute of the imagemap <area> tags if no URL has been configured.

Returns:

The HTML tags and image related code to include the chart image in the page.