netcharts.pro.common.page
Class NFPageParams

java.lang.Object
  netcharts.pro.common.page.NFPageParams

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

NFRasterPageParams, NFSVGPageParams

public abstract class NFPageParams
extends java.lang.Object
implements java.io.Serializable

Used to specify the parameters of the page generation. These parameters define the expected content type of the output, if the output will be included with other page content rendered by NetCharts Pro, if accessible mode is enabled, etc. Each category of output (e.g. raster images, vector based, etc.) should have a subclass implementation of NFPageParams.

See Also:

Serialized Form

Method Summary

NFImageParams	getImageParams() Returns the set of parameters defining how the image should be generated.
java.lang.String	getMimeType() Returns the MIME type of the output.
java.lang.String	getServletName() Returns the Java Servlet used to return the generated chart image.
boolean	isAccessible() Returns if accessible mode is enabled for the output.
boolean	isFullPage() Returns whether the generated page should include the required user interactivity code.
void	setAccessible(boolean accessible) Sets if accessible mode should be enabled for the output.
void	setFullPage(boolean fullPage) Sets whether the generated page should include the required user interactivity code.
void	setImageParams(NFImageParams imageParams) Sets the set of parameters defining how the image should be generated.
void	setServletName(java.lang.String servletName) Sets the Java Servlet used to return the generated chart image.

Methods inherited from class java.lang.Object

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

Method Detail

getImageParams

public NFImageParams getImageParams()

Returns the set of parameters defining how the image should be generated.

Returns:

The set of parameters defining how the image should be generated.

getMimeType

public java.lang.String getMimeType()

Returns the MIME type of the output. This type will be dependent on the output type category.

Returns:

The MIME type of the output

getServletName

public java.lang.String getServletName()

Returns the Java Servlet used to return the generated chart image.

Returns:

The name of the Java Servlet used to return the generated chart image.

isAccessible

public boolean isAccessible()

Returns if accessible mode is enabled for the output.

Returns:

True if accessible mode is enabled, false otherwise.

isFullPage

public boolean isFullPage()

Returns whether the generated page should include the required user interactivity code. If other page content will be generated and added to the same response, use the getScript(NFPageParams) method of NFPageOutput to include the user interactivity code in a single location in the response.

Returns:

true if the required user interactivity code should be returned, false otherwise.

setAccessible

public void setAccessible(boolean accessible)

Sets if accessible mode should be enabled for the output.

Parameters:

accessible - True if accessible mode should be enabled, false otherwise.

setFullPage

public void setFullPage(boolean fullPage)

Sets whether the generated page should include the required user interactivity code. If other page content will be generated and added to the same response, use the getScript(NFPageParams) method of NFPageOutput to include the user interactivity code in a single location in the response.

Parameters:

fullPage - True if the required user interactivity code should be returned, false otherwise.

setImageParams

public void setImageParams(NFImageParams imageParams)

Sets the set of parameters defining how the image should be generated.

Parameters:

imageParams - The set of parameters defining how the image should be generated.

setServletName

public void setServletName(java.lang.String servletName)

Sets the Java Servlet used to return the generated chart image.

Parameters:

servletName - The name of the Java Servlet used to return the generated chart image.