netcharts.server.util
Class PageCreator

java.lang.Object
  |
  +--netcharts.server.util.PageCreator

Direct Known Subclasses:

DefaultPageCreator, PortletPageCreator

public class PageCreator

extends java.lang.Object

Utility class for adding basic drill down and popup label capability to applications.

Field Summary

static java.lang.String	ACCESSIBLE_IMAGE_PAGE
static java.lang.String	ACCESSIBLE_PAGE
static java.lang.String	ALT_VAR
static java.lang.String	DEFAULT_ALT_TEMPLATE
static java.lang.String	DEFAULT_URL
static java.lang.String	DRILLDOWN_PAGE
static java.lang.String	HEIGHT_VAR
static java.lang.String	IMAGE_PAGE
static java.lang.String	IMAGE_PARAMETER
static java.lang.String	MAP_VAR
static java.lang.String	MAPNAME_VAR
static java.lang.String	MIN_DRILLDOWN_PAGE
static java.lang.String	SRC_VAR
static java.lang.String	WIDTH_VAR

Constructor Summary

PageCreator()

Method Summary

static java.lang.String	getDrillDownPage(ServerGeneratedImage chart, java.lang.String imgSRC) Get the HTML which allows drill down and popup labels on the given chart.
static java.lang.String	getDrillDownPage(ServerGeneratedImage chart, java.lang.String imgSRC, boolean fullPage) Get the HTML which allows drill down and popup labels on the given chart.
static java.lang.String	getDrillDownPage(ServerGeneratedImage chart, java.lang.String imgSRC, boolean fullPage, java.lang.String defaultImageMapURL) Get the HTML which allows drill down and popup labels on the given chart.
static java.lang.String	getDrillDownPage(ServerGeneratedImage chart, java.lang.String imgSRC, boolean fullPage, java.lang.String defaultImageMapURL, boolean accessible, java.lang.String altTemplate, java.lang.String chartDescription) Get the HTML which allows drill down and popup labels on the given chart.
static java.lang.String	getDrillDownPage(ServerGeneratedImage chart, java.lang.String imgSRC, boolean fullPage, java.lang.String defaultImageMapURL, boolean accessible, java.lang.String altTemplate, java.lang.String chartDescription, java.lang.String encoding) Deprecated. Encoding no longer needed, instead use getDrillDownPage(ServerGeneratedImage, String, boolean, String, boolean, String, String)
static java.lang.String	getDrillDownPage(ServerGeneratedImage chart, java.lang.String imgSRC, boolean fullPage, java.lang.String defaultImageMapURL, java.lang.String encoding) Deprecated. Encoding no longer needed, instead use getDrillDownPage(ServerGeneratedImage, String, boolean, String)
static java.lang.String	getImagePage(ServerGeneratedImage chart, java.lang.String imgSRC, boolean accessible, java.lang.String chartDescription) Get the HTML which only shows the image of the given chart.
static java.lang.String	getImagePage(ServerGeneratedImage chart, java.lang.String imgSRC, boolean accessible, java.lang.String chartDescription, java.lang.String encoding) Deprecated. Encoding no longer needed, instead use getImagePage(ServerGeneratedImage, String, boolean, String)
static java.lang.String	getRolloverJavaScript() Return the JavaScript and tag used for chart interactivity.

Methods inherited from class java.lang.Object

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

Field Detail

IMAGE_PARAMETER

public static final java.lang.String IMAGE_PARAMETER

DEFAULT_URL

public static final java.lang.String DEFAULT_URL

DEFAULT_ALT_TEMPLATE

public static final java.lang.String DEFAULT_ALT_TEMPLATE

IMAGE_PAGE

public static final java.lang.String IMAGE_PAGE

ACCESSIBLE_IMAGE_PAGE

public static final java.lang.String ACCESSIBLE_IMAGE_PAGE

ACCESSIBLE_PAGE

public static final java.lang.String ACCESSIBLE_PAGE

DRILLDOWN_PAGE

public static final java.lang.String DRILLDOWN_PAGE

MIN_DRILLDOWN_PAGE

public static final java.lang.String MIN_DRILLDOWN_PAGE

MAP_VAR

public static final java.lang.String MAP_VAR

MAPNAME_VAR

public static final java.lang.String MAPNAME_VAR

SRC_VAR

public static final java.lang.String SRC_VAR

WIDTH_VAR

public static final java.lang.String WIDTH_VAR

HEIGHT_VAR

public static final java.lang.String HEIGHT_VAR

ALT_VAR

public static final java.lang.String ALT_VAR

Constructor Detail

PageCreator

public PageCreator()

Method Detail

getRolloverJavaScript

public static java.lang.String getRolloverJavaScript()

Return the JavaScript and

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

tag used for interactivity.

getDrillDownPage

public static java.lang.String getDrillDownPage(ServerGeneratedImage chart,
                                                java.lang.String imgSRC)

Get the HTML which allows drill down and popup labels on the given chart. This should be written to the browser via the response object. By default the browser will ask the current servlet for the image data after it reads the HTML.

Parameters:

chart - The chart to convert to an image.

imgSRC - The src to use in the img tag.

Returns:

A String containing HTML which supports drill down and popup labels on an image of the given chart.

getDrillDownPage

public static java.lang.String getDrillDownPage(ServerGeneratedImage chart,
                                                java.lang.String imgSRC,
                                                boolean fullPage)

Get the HTML which allows drill down and popup labels on the given chart. This should be written to the browser via the response object. By default the browser will ask the current servlet for the image data after it reads the HTML.

Parameters:

chart - The chart to convert to an image.

imgSRC - The src to use in the img tag.

fullPage - Specifies whether or not to return the full HTML code or just the image related elements only.

Returns:

A String containing HTML which supports drill down and popup labels on an image of the given chart.

getDrillDownPage

public static java.lang.String getDrillDownPage(ServerGeneratedImage chart,
                                                java.lang.String imgSRC,
                                                boolean fullPage,
                                                java.lang.String defaultImageMapURL)

Get the HTML which allows drill down and popup labels on the given chart. This should be written to the browser via the response object. By default the browser will ask the current servlet for the image data after it reads the HTML.

Parameters:

chart - The chart to convert to an image.

fullPage - Specifies whether or not to return the full HTML code or just the image related elements only.

imgSRC - The src to use in the img tag.

defaultImageMapURL - The URL to use when creating imagemap HREF attributes.

Returns:

A String containing HTML which supports drill down and popup labels on an image of the given chart.

getDrillDownPage

public static java.lang.String getDrillDownPage(ServerGeneratedImage chart,
                                                java.lang.String imgSRC,
                                                boolean fullPage,
                                                java.lang.String defaultImageMapURL,
                                                java.lang.String encoding)

Deprecated. Encoding no longer needed, instead use getDrillDownPage(ServerGeneratedImage, String, boolean, String)

Get the HTML which allows drill down and popup labels on the given chart. This should be written to the browser via the response object. By default the browser will ask the current servlet for the image data after it reads the HTML.

Parameters:

chart - The chart to convert to an image.

fullPage - Specifies whether or not to return the full HTML code or just the image related elements only.

imgSRC - The src to use in the img tag.

defaultImageMapURL - The URL to use when creating imagemap HREF attributes.

encoding - The encoding used by the server to convert Strings to bytes.

Returns:

A String containing HTML which supports drill down and popup labels on an image of the given chart.

getDrillDownPage

public static java.lang.String getDrillDownPage(ServerGeneratedImage chart,
                                                java.lang.String imgSRC,
                                                boolean fullPage,
                                                java.lang.String defaultImageMapURL,
                                                boolean accessible,
                                                java.lang.String altTemplate,
                                                java.lang.String chartDescription,
                                                java.lang.String encoding)

Deprecated. Encoding no longer needed, instead use getDrillDownPage(ServerGeneratedImage, String, boolean, String, boolean, String, String)

Get the HTML which allows drill down and popup labels on the given chart. This should be written to the browser via the response object. By default the browser will ask the current servlet for the image data after it reads the HTML.

Parameters:

chart - The chart to convert to an image.

fullPage - Specifies whether or not to return the full HTML code or just the image related elements only.

imgSRC - The src to use in the img tag.

defaultImageMapURL - The URL to use when creating imagemap HREF attributes.

accessible - Whether accessibility features (like alt tags) should be used in the drill down page instead of javascript based popup labels

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

chartDescription - The description to be used in the alt tag on chart images.

encoding - The encoding used by the server to convert Strings to bytes.

Returns:

A String containing HTML which supports drill down and popup labels on an image of the given chart.

getDrillDownPage

public static java.lang.String getDrillDownPage(ServerGeneratedImage chart,
                                                java.lang.String imgSRC,
                                                boolean fullPage,
                                                java.lang.String defaultImageMapURL,
                                                boolean accessible,
                                                java.lang.String altTemplate,
                                                java.lang.String chartDescription)

Get the HTML which allows drill down and popup labels on the given chart. This should be written to the browser via the response object. By default the browser will ask the current servlet for the image data after it reads the HTML.

Parameters:

chart - The chart to convert to an image.

fullPage - Specifies whether or not to return the full HTML code or just the image related elements only.

imgSRC - The src to use in the img tag.

defaultImageMapURL - The URL to use when creating imagemap HREF attributes.

accessible - Whether accessibility features (like alt tags) should be used in the drill down page instead of javascript based popup labels

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

chartDescription - The description to be used in the alt tag on chart images.

Returns:

A String containing HTML which supports drill down and popup labels on an image of the given chart.

getImagePage

public static java.lang.String getImagePage(ServerGeneratedImage chart,
                                            java.lang.String imgSRC,
                                            boolean accessible,
                                            java.lang.String chartDescription,
                                            java.lang.String encoding)

Deprecated. Encoding no longer needed, instead use getImagePage(ServerGeneratedImage, String, boolean, String)

Get the HTML which only shows the image of the given chart.

Parameters:

chart - The chart to convert to an image.

imgSRC - The src to use in the img tag.

accessible - Whether accessibility features (like alt tags) should be used in the page.

chartDescription - The description to be used in the alt tag on chart images.

encoding - The encoding used by the server to convert Strings to bytes.

Returns:

A String containing HTML which only shows the image of the given chart.

getImagePage

public static java.lang.String getImagePage(ServerGeneratedImage chart,
                                            java.lang.String imgSRC,
                                            boolean accessible,
                                            java.lang.String chartDescription)

Get the HTML which only shows the image of the given chart.

Parameters:

chart - The chart to convert to an image.

imgSRC - The src to use in the img tag.

accessible - Whether accessibility features (like alt tags) should be used in the page.

chartDescription - The description to be used in the alt tag on chart images.

Returns:

A String containing HTML which only shows the image of the given chart.