Class SVGGeneratorContext

java.lang.Object
org.apache.batik.svggen.SVGGeneratorContext
All Implemented Interfaces:
ErrorConstants
public class SVGGeneratorContext extends Object implements ErrorConstants
This class contains all non graphical contextual information that are needed by the SVGGraphics2D to generate SVG from Java 2D primitives. You can subclass it to change the defaults.
Version:
$Id$
See Also:

  • Field Details

    • domFactory

      Document domFactory
      Factory used by this Graphics2D to create Elements that make the SVG DOM Tree

    • imageHandler

      ImageHandler imageHandler
      Handler that defines how images are referenced in the generated SVG fragment. This allows different strategies to be used to handle images.
      See Also:

    • genericImageHandler

      GenericImageHandler genericImageHandler
      Generic image handler. This allows more sophisticated image handling strategies than the ImageHandler interfaces.

    • extensionHandler

      ExtensionHandler extensionHandler
      To deal with Java 2D extension (custom java.awt.Paint for example).

    • idGenerator

      SVGIDGenerator idGenerator
      To generate consitent ids.

    • styleHandler

      StyleHandler styleHandler
      To set style.

    • generatorComment

      String generatorComment
      The comment to insert at generation time.

    • errorHandler

      ErrorHandler errorHandler
      The error handler.

    • svgFont

      boolean svgFont
      Do we accept SVG Fonts generation?

    • gcDefaults

      SVGGeneratorContext.GraphicContextDefaults gcDefaults
      GraphicContextDefaults

    • precision

      int precision
      Number of decimal places to use in output values. 3 decimal places are used by default.

    • decimalFormat

      protected DecimalFormat decimalFormat
      Current double value formatter

    • dsf

      protected static DecimalFormatSymbols dsf

    • decimalFormats

      protected static DecimalFormat[] decimalFormats

  • Constructor Details

  • Method Details

    • createDefault

      public static SVGGeneratorContext createDefault(Document domFactory)
      Creates an instance of SVGGeneratorContext with the given domFactory and with the default values for the other information.
      See Also:

    • getGraphicContextDefaults

      public final SVGGeneratorContext.GraphicContextDefaults getGraphicContextDefaults()
      Returns the set of defaults which should be used for the GraphicContext.

    • setGraphicContextDefaults

      public final void setGraphicContextDefaults(SVGGeneratorContext.GraphicContextDefaults gcDefaults)
      Sets the default to be used for the graphic context. Note that gcDefaults may be null and that any of its attributes may be null.

    • getIDGenerator

      public final SVGIDGenerator getIDGenerator()
      Returns the SVGIDGenerator that has been set.

    • setIDGenerator

      public final void setIDGenerator(SVGIDGenerator idGenerator)
      Sets the SVGIDGenerator to be used. It should not be null.

    • getDOMFactory

      public final Document getDOMFactory()
      Returns the DOM Factory that has been set.

    • setDOMFactory

      public final void setDOMFactory(Document domFactory)
      Sets the DOM Factory to be used. It should not be null.

    • getExtensionHandler

      public final ExtensionHandler getExtensionHandler()
      Returns the ExtensionHandler that has been set.

    • setExtensionHandler

      public final void setExtensionHandler(ExtensionHandler extensionHandler)
      Sets the ExtensionHandler to be used. It should not be null.

    • getImageHandler

      public final ImageHandler getImageHandler()
      Returns the ImageHandler that has been set.

    • setImageHandler

      public final void setImageHandler(ImageHandler imageHandler)
      Sets the ImageHandler to be used. It should not be null.

    • setGenericImageHandler

      public final void setGenericImageHandler(GenericImageHandler genericImageHandler)
      Sets the GenericImageHandler to be used.

    • getStyleHandler

      public final StyleHandler getStyleHandler()
      Returns the StyleHandler that has been set.

    • setStyleHandler

      public final void setStyleHandler(StyleHandler styleHandler)
      Sets the StyleHandler to be used. It should not be null.

    • getComment

      public final String getComment()
      Returns the comment to be generated in the SVG file.

    • setComment

      public final void setComment(String generatorComment)
      Sets the comment to be used. It can be null if you want to disable it.

    • getErrorHandler

      public final ErrorHandler getErrorHandler()
      Returns the ErrorHandler that has been set.

    • setErrorHandler

      public final void setErrorHandler(ErrorHandler errorHandler)
      Sets the ErrorHandler to be used. It should not be null.

    • isEmbeddedFontsOn

      public final boolean isEmbeddedFontsOn()
      Returns true if we should generate SVG Fonts for texts.

    • setEmbeddedFontsOn

      public final void setEmbeddedFontsOn(boolean svgFont)
      Sets if we should generate SVG Fonts for texts. Default value is false.

    • getPrecision

      public final int getPrecision()
      Returns the current precision used by this context

    • setPrecision

      public final void setPrecision(int precision)
      Sets the precision used by this context. The precision controls the number of decimal places used in floating point values output by the SVGGraphics2D generator. Note that the precision is clipped to the [0,12] range.

    • doubleString

      public final String doubleString(double value)
      Converts the input double value to a string with a number of decimal places controlled by the precision attribute.