NetCharts Pro

netcharts.pro.common.page.svg
Class NFSVGPageParams

java.lang.Object
  extended by netcharts.pro.common.page.NFPageParams
      extended by netcharts.pro.common.page.svg.NFSVGPageParams
All Implemented Interfaces:
java.io.Serializable

public class NFSVGPageParams
extends NFPageParams

The implementation of NFPageParams to use when generating pages suitable for displaying generated SVG images. Instances of NFSVGPageParams are passed as a parameter when rendering NetCharts Pro chart instances as SVG based graphics. The NFSVGPageParams instance will define parameters of the output such as if and how SVGWeb should be run, the Java Servlet used to display the image to the browser, etc.

See Also:
Serialized Form

Field Summary
static java.lang.String MIME_TYPE_SVG
          image/svg+xml
 
Constructor Summary
NFSVGPageParams()
          Constructs a default NFSVGPageParams instance.
NFSVGPageParams(boolean fullPage)
          Constructs a NFSVGPageParams instance specifying if the generated page should return all of the required user interactivity code.
NFSVGPageParams(boolean svgWebIncluded, boolean svgWebForced)
          Constructs a NFSVGPageParams instance specifying if SVGWeb should be included in the output, and if SVGWeb should be forced to render all SVG images on the page itself.
NFSVGPageParams(boolean fullPage, boolean svgWebIncluded, boolean svgWebForced)
          Constructs a NFSVGPageParams instance specifying if the generated page should return all of the required user interactivity code, if SVGWeb should be included in the output, and if SVGWeb should be forced to render all SVG images on the page itself.
NFSVGPageParams(java.lang.String servletName)
          Constructs a NFSVGPageParams instance specifying the Java Servlet used to return the generated chart image.
NFSVGPageParams(java.lang.String servletName, boolean fullPage)
          Constructs a NFSVGPageParams instance specifying the Java Servlet used to return the generated chart image and if the generated page should return all of the required user interactivity code.
NFSVGPageParams(java.lang.String servletName, boolean fullPage, boolean svgWebIncluded)
          Constructs a NFSVGPageParams instance specifying the Java Servlet used to return the generated chart image, if the generated page should return all of the required user interactivity code, and if SVGWeb should be included in the output.
NFSVGPageParams(java.lang.String servletName, boolean fullPage, boolean svgWebIncluded, boolean svgWebForced)
          Constructs a NFSVGPageParams instance specifying the Java Servlet used to return the generated chart image, if the generated page should return all of the required user interactivity code, if SVGWeb should be included in the output, and if SVGWeb should be forced to render all SVG images on the page itself.
 
Method Summary
 boolean isSVGWebForced()
          Sets if SVGWeb should be forced to render all SVG images on the page itself, bypassing any available native renderers.
 boolean isSVGWebIncluded()
          Returns if SVGWeb should be included in the page.
 void setSVGWebForced(boolean svgWebForced)
          Sets if SVGWeb should be forced to render all SVG images on the page itself, bypassing any available native renderers.
 void setSVGWebIncluded(boolean svgWebIncluded)
          Sets if SVGWeb should be included in the page.
 
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
 

Field Detail

MIME_TYPE_SVG

public static final java.lang.String MIME_TYPE_SVG
image/svg+xml

See Also:
Constant Field Values
Constructor Detail

NFSVGPageParams

public NFSVGPageParams()
Constructs a default NFSVGPageParams instance.


NFSVGPageParams

public NFSVGPageParams(java.lang.String servletName)
Constructs a NFSVGPageParams instance specifying the Java Servlet used to return the generated chart image.

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

NFSVGPageParams

public NFSVGPageParams(java.lang.String servletName,
                       boolean fullPage)
Constructs a NFSVGPageParams instance specifying 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:
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.

NFSVGPageParams

public NFSVGPageParams(boolean fullPage)
Constructs a NFSVGPageParams instance specifying 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.

NFSVGPageParams

public NFSVGPageParams(java.lang.String servletName,
                       boolean fullPage,
                       boolean svgWebIncluded)
Constructs a NFSVGPageParams instance specifying the Java Servlet used to return the generated chart image, if the generated page should return all of the required user interactivity code, and if SVGWeb should be included in the output.

Parameters:
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.
svgWebIncluded - Whether SVGWeb should be included in the page.

NFSVGPageParams

public NFSVGPageParams(java.lang.String servletName,
                       boolean fullPage,
                       boolean svgWebIncluded,
                       boolean svgWebForced)
Constructs a NFSVGPageParams instance specifying the Java Servlet used to return the generated chart image, if the generated page should return all of the required user interactivity code, if SVGWeb should be included in the output, and if SVGWeb should be forced to render all SVG images on the page itself.

Parameters:
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.
svgWebIncluded - Whether SVGWeb should be included in the page.
svgWebForced - Whether SVGWeb should be forced to render all SVG images on the page itself.

NFSVGPageParams

public NFSVGPageParams(boolean svgWebIncluded,
                       boolean svgWebForced)
Constructs a NFSVGPageParams instance specifying if SVGWeb should be included in the output, and if SVGWeb should be forced to render all SVG images on the page itself.

Parameters:
svgWebIncluded - Whether SVGWeb should be included in the page.
svgWebForced - Whether SVGWeb should be forced to render all SVG images on the page itself.

NFSVGPageParams

public NFSVGPageParams(boolean fullPage,
                       boolean svgWebIncluded,
                       boolean svgWebForced)
Constructs a NFSVGPageParams instance specifying if the generated page should return all of the required user interactivity code, if SVGWeb should be included in the output, and if SVGWeb should be forced to render all SVG images on the page itself.

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.
svgWebIncluded - Whether SVGWeb should be included in the page.
svgWebForced - Whether SVGWeb should be forced to render all SVG images on the page itself.
Method Detail

isSVGWebIncluded

public boolean isSVGWebIncluded()
Returns if SVGWeb should be included in the page. By default SVGWeb only renders SVG images on the page if a native SVG renderer is unavailable.

Returns:
true If SVGWeb should be included in the page.

setSVGWebIncluded

public void setSVGWebIncluded(boolean svgWebIncluded)
Sets if SVGWeb should be included in the page. By default SVGWeb only renders SVG images on the page if a native SVG renderer is unavailable.

Parameters:
svgWebIncluded - If SVGWeb should be included in the page.

isSVGWebForced

public boolean isSVGWebForced()
Sets if SVGWeb should be forced to render all SVG images on the page itself, bypassing any available native renderers.

Returns:
true If SVGWeb should be forced to render all SVG images on the page itself.

setSVGWebForced

public void setSVGWebForced(boolean svgWebForced)
Sets if SVGWeb should be forced to render all SVG images on the page itself, bypassing any available native renderers.

Parameters:
svgWebForced - If SVGWeb should be forced to render all SVG images on the page itself.

NetCharts Pro


Visual Mining, Inc.
2099 Gaither Rd.
Suite 220
Rockville, MD 20850
800.308.0731
301.947.8293 FAX

Copyright © Visual Mining, Inc. 1996 - 2018
All Rights Reserved.

NetCharts Pro TM is a registered trademark of Visual Mining, Inc. Other brands and their products are trademarks of their respective holders.

Last Modified: Jan 7, 2018