NetCharts Pro

netcharts.pro.common.image.svg
Class NFSVGImageParams

java.lang.Object
  extended by netcharts.pro.common.image.NFImageParams
      extended by netcharts.pro.common.image.NFZoomableImageParams
          extended by netcharts.pro.common.image.svg.NFSVGImageParams
All Implemented Interfaces:
java.io.Serializable

public class NFSVGImageParams
extends NFZoomableImageParams

Used to specify the parameters of the image generation when outputting SVG based images.

See Also:
Serialized Form

Field Summary
static java.lang.String MIME_TYPE_SVG
          image/svg+xml
 
Constructor Summary
NFSVGImageParams()
          Constructs a default NFSVGImageParams instance.
NFSVGImageParams(boolean embedFonts)
          Constructs a NFSVGImageParams instance specifying whether to embed fonts in the rendered image.
NFSVGImageParams(java.lang.String defaultHref)
          Constructs a NFSVGImageParams instance specifying the default URL to use for user interactivity actions.
 
Method Summary
 java.lang.String getEncoding()
          Returns the encoding of the rendered image.
 boolean isDoctypeIncluded()
          Returns if the DocType should be included in the rendered image.
 boolean isEmbeddedFontsEnabled()
          Returns if fonts will be embedded in the rendered image.
 boolean isInternalZoomEnabled()
          Returns if internal zoom will be enabled in the rendered image.
 boolean isPrettyPrintEnabled()
          Returns if the SVG pretty printer utility will be enabled.
 boolean isXMLDeclarationIncluded()
          Returns if the XML declaration should be included in the rendered image.
 void setDoctypeIncluded(boolean doctypeIncluded)
          Sets if the DocType should be included in the rendered image.
 void setEmbeddedFontsEnabled(boolean embedFonts)
          Sets if fonts should be embedded in the rendered image.
 void setEncoding(java.lang.String encoding)
          Sets the encoding of the rendered image.
 void setInternalZoomEnabled(boolean useSVGZoom)
          Sets if internal zoom should be enabled in the rendered image.
 void setPrettyPrintEnabled(boolean prettyPrint)
          Sets if the SVG pretty printer utility should be enabled.
 void setXMLDeclarationIncluded(boolean xmlDeclarationIncluded)
          Sets if the XML declaration should be included in the rendered image.
 
Methods inherited from class netcharts.pro.common.image.NFZoomableImageParams
getZoomInHandler, getZoomOutHandler, isZoomOutButtonVisible, setZoomInHandler, setZoomOutButtonVisible, setZoomOutHandler
 
Methods inherited from class netcharts.pro.common.image.NFImageParams
getAltTemplate, getDefaultHref, getDescription, getInternalParams, getMimeType, setAltTemplate, setDefaultHref, setDescription
 
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

NFSVGImageParams

public NFSVGImageParams()
Constructs a default NFSVGImageParams instance.


NFSVGImageParams

public NFSVGImageParams(java.lang.String defaultHref)
Constructs a NFSVGImageParams instance specifying the default URL to use for user interactivity actions.

Parameters:
defaultHref - The default URL of the graph image for user interactivity actions.

NFSVGImageParams

public NFSVGImageParams(boolean embedFonts)
Constructs a NFSVGImageParams instance specifying whether to embed fonts in the rendered image.

Parameters:
embedFonts - True to embed fonts in the rendered image, false otherwise.
Method Detail

isEmbeddedFontsEnabled

public boolean isEmbeddedFontsEnabled()
Returns if fonts will be embedded in the rendered image.

Returns:
True if fonts will be embedded in the rendered image, false otherwise.

setEmbeddedFontsEnabled

public void setEmbeddedFontsEnabled(boolean embedFonts)
Sets if fonts should be embedded in the rendered image.

Parameters:
embedFonts - True to embed fonts in the rendered image, false otherwise.

isInternalZoomEnabled

public boolean isInternalZoomEnabled()
Returns if internal zoom will be enabled in the rendered image.

Returns:
True if internal zoom will be enabled in the rendered image, false otherwise.

setInternalZoomEnabled

public void setInternalZoomEnabled(boolean useSVGZoom)
Sets if internal zoom should be enabled in the rendered image.

Parameters:
useSVGZoom - True to enable internal zoom in the rendered image, false otherwise.

isPrettyPrintEnabled

public boolean isPrettyPrintEnabled()
Returns if the SVG pretty printer utility will be enabled.

Returns:
True the SVG pretty printer utility will be enabled, false otherwise.

setPrettyPrintEnabled

public void setPrettyPrintEnabled(boolean prettyPrint)
Sets if the SVG pretty printer utility should be enabled.

Parameters:
prettyPrint - True to enable the SVG pretty printer utility, false otherwise.

getEncoding

public java.lang.String getEncoding()
Returns the encoding of the rendered image.

Returns:
The encoding of the rendered image.

setEncoding

public void setEncoding(java.lang.String encoding)
Sets the encoding of the rendered image.

Parameters:
encoding - The encoding of the rendered image.

isXMLDeclarationIncluded

public boolean isXMLDeclarationIncluded()
Returns if the XML declaration should be included in the rendered image.

Returns:
True if the XML declaration should be included in the rendered image, false otherwise.

setXMLDeclarationIncluded

public void setXMLDeclarationIncluded(boolean xmlDeclarationIncluded)
Sets if the XML declaration should be included in the rendered image.

Parameters:
xmlDeclarationIncluded - True if the XML declaration should be included in the rendered image, false otherwise.

isDoctypeIncluded

public boolean isDoctypeIncluded()
Returns if the DocType should be included in the rendered image.

Returns:
True if the DocType should be included in the rendered image, false otherwise.

setDoctypeIncluded

public void setDoctypeIncluded(boolean doctypeIncluded)
Sets if the DocType should be included in the rendered image.

Parameters:
doctypeIncluded - True if the DocType should be included in the rendered image, false otherwise.

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