netcharts.pro.common.page.raster
Class NFRasterPageParams

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

All Implemented Interfaces:

java.io.Serializable, NFRasterImageTypes

public class NFRasterPageParams
extends NFPageParams
implements NFRasterImageTypes

The implementation of NFPageParams to use when generating pages suitable for displaying generated raster images such as JPEG and PNG. Instances of NFRasterPageParams are passed as a parameter when rendering NetCharts Pro chart instances as raster based graphics. The NFRasterPageParams instance will define parameters of the output such as the MIME type, the Java Servlet used to display the image to the browser, etc.

See Also:

Serialized Form

Field Summary

Fields inherited from interface netcharts.pro.common.image.raster.NFRasterImageTypes

DEFAULT_MIME_TYPE, MIME_TYPE_BMP, MIME_TYPE_JPG, MIME_TYPE_PICT, MIME_TYPE_PNG, MIME_TYPE_TGA, MIME_TYPE_TIFF, MIME_TYPE_WBMP, MIME_TYPE_XBM, MIME_TYPE_XPM

Constructor Summary

NFRasterPageParams()
Constructs a NFRasterPageParams instance using the default raster mime type.

NFRasterPageParams(boolean fullPage)
Constructs a NFPageParams instance using the default MIME type and if the generated page should return all of the required user interactivity code.

NFRasterPageParams(NFRasterImageParams params)
Constructs a NFRasterPageParams instance specifying the set of image generation parameters.

NFRasterPageParams(NFRasterImageParams params, boolean fullPage)
Constructs a NFRasterPageParams instance specifying the set of raster based content parameters and if the generated page should return all of the required user interactivity code.

NFRasterPageParams(NFRasterImageParams params, java.lang.String servletName)
Constructs a NFRasterPageParams instance specifying the set of image generation parameters.

NFRasterPageParams(NFRasterImageParams params, java.lang.String servletName, boolean fullPage)
Constructs a NFRasterPageParams instance specifying the set of raster based content parameters and the Java Servlet used to return the generated chart image and if the generated page should return all of the required user interactivity code.

NFRasterPageParams(java.lang.String mimeType)
Constructs a NFRasterPageParams instance specifying the MIME type.

NFRasterPageParams(java.lang.String mimeType, boolean fullPage)
Constructs a NFRasterPageParams instance specifying the MIME type and if the generated page should return all of the required user interactivity code.

NFRasterPageParams(java.lang.String mimeType, java.lang.String servletName)
Constructs a NFRasterPageParams instance specifying the MIME type and Java Servlet used to return the generated chart image.

NFRasterPageParams(java.lang.String mimeType, java.lang.String servletName, boolean fullPage)
Constructs a NFRasterPageParams instance specifying the MIME type, Java Servlet used to return the generated chart image and if the generated page should return all of the required user interactivity code.

Method Summary

Methods inherited from class netcharts.pro.common.page.NFPageParams

getImageParams, getMimeType, getServletName, isAccessible, isFullPage, setAccessible, setFullPage, setImageParams, setServletName

Methods inherited from class java.lang.Object

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

Constructor Detail

NFRasterPageParams

public NFRasterPageParams()

Constructs a NFRasterPageParams instance using the default raster mime type.

NFRasterPageParams

public NFRasterPageParams(boolean fullPage)

Constructs a NFPageParams instance using the default MIME type and if the generated page should return all of the required user interactivity code.

Parameters:

fullPage - 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.

NFRasterPageParams

public NFRasterPageParams(java.lang.String mimeType)

Constructs a NFRasterPageParams instance specifying the MIME type.

Parameters:

mimeType - The MIME type of the output, dependent on the category of the output.

NFRasterPageParams

public NFRasterPageParams(java.lang.String mimeType,
                          java.lang.String servletName)

Constructs a NFRasterPageParams instance specifying the MIME type and Java Servlet used to return the generated chart image.

Parameters:

mimeType - The MIME type of the output, dependent on the category of the output.

servletName - The Java Servlet that will present the generated chart image to the browser.

NFRasterPageParams

public NFRasterPageParams(java.lang.String mimeType,
                          java.lang.String servletName,
                          boolean fullPage)

Constructs a NFRasterPageParams instance specifying the MIME type, Java Servlet used to return the generated chart image and if the generated page should return all of the required user interactivity code.

Parameters:

mimeType - The MIME type of the output, dependent on the category of the output.

servletName - The Java Servlet that will present the generated chart image to the browser.

fullPage - 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.

NFRasterPageParams

public NFRasterPageParams(java.lang.String mimeType,
                          boolean fullPage)

Constructs a NFRasterPageParams instance specifying the MIME type and if the generated page should return all of the required user interactivity code.

Parameters:

mimeType - The MIME type of the output, dependent on the category of the output.

fullPage - 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.

NFRasterPageParams

public NFRasterPageParams(NFRasterImageParams params)

Constructs a NFRasterPageParams instance specifying the set of image generation parameters.

Parameters:

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

NFRasterPageParams

public NFRasterPageParams(NFRasterImageParams params,
                          java.lang.String servletName)

Constructs a NFRasterPageParams instance specifying the set of image generation parameters. and Java Servlet used to return the generated chart image.

Parameters:

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

servletName - The Java Servlet that will present the generated chart image to the browser.

NFRasterPageParams

public NFRasterPageParams(NFRasterImageParams params,
                          java.lang.String servletName,
                          boolean fullPage)

Constructs a NFRasterPageParams instance specifying the set of raster based content parameters and the Java Servlet used to return the generated chart image and if the generated page should return all of the required user interactivity code.

Parameters:

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

servletName - The Java Servlet that will present the generated chart image to the browser.

fullPage - 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.

NFRasterPageParams

public NFRasterPageParams(NFRasterImageParams params,
                          boolean fullPage)

Constructs a NFRasterPageParams instance specifying the set of raster based content parameters and if the generated page should return all of the required user interactivity code.

Parameters:

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

fullPage - 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.