SVGDocumentBuilderConfigurator (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.svg.SVGDocumentBuilderConfigurator

```
public class SVGDocumentBuilderConfigurator
extends Object
```
This class allows you to configure an SVGDocumentBuilder instance. The generated SVG file will be different depending on this configuration.

See Also:

SVGDocumentBuilder

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SVGDocumentBuilderConfigurator.GraphicTranslator` This interface must be implemented by classes that want to translate an `IlvGraphic` to an instance of an SVG DOM `Element`.
`static interface`	`SVGDocumentBuilderConfigurator.RealToStringConverter` This interface must be implemented by classes that want to define how the SVG DOM used by the `SVGDocumentBuilder` will translate real number values to DOM strings.

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`BASIC_SVG` Generates SVG documents using the basic profile of SVG.
`static int`	`COMPACT_LOD` Performs compaction by not generating SVG for an `IlvManagerLayer` that can be loaded only on demand for an SVG client (layers that are not visible).
`static int`	`COMPACT_POLY` Performs compaction by reducing the number of points of polylines, polygons, and so forth.
`static int`	`COMPACT_STYLE` Performs style compaction on the generated SVG document.
`static int`	`COMPACT_VIEWBOX` Performs compaction by removing graphic elements outside of the `viewBox`.
`static int`	`COMPACT_VISIBLE` Performs compaction by removing invisible graphic elements from the generated file.
`static short`	`FULL_SVG` Generates SVG documents using the full profile of SVG.
`static String`	`JVIEWS_GF_NAMESPACE_PREFIX` Perforce JViews Graphics Framework XML Namespace default Prefix.
`static String`	`JVIEWS_GF_NAMESPACE_URI` Perforce JViews Graphics Framework XML Namespace URI.
`static short`	`LOCAL_DTD` Uses a local DTD.
`static int`	`NO_COMPACT` Performs no compaction on the generated SVG document.
`static short`	`SVG_CSS` Uses the CSS styling capabilities of SVG.
`static short`	`SVG_XML` Uses the XML styling capabilities (presentation attributes) of SVG.
`static short`	`WEB_DTD` Uses the official W3C DTD on the Web.

Constructor Summary

Constructors
Constructor and Description

SVGDocumentBuilderConfigurator()
Builds an SVGDocumentBuilderConfigurator instance.

Constructors
Constructor and Description
`SVGDocumentBuilderConfigurator()` Builds an `SVGDocumentBuilderConfigurator` instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAttribute(String attribute)` Returns the preset value of an attribute of the outermost SVG element.
`int`	`getCompactMode()` Returns the current compaction mode.
`String`	`getDTDID()` Returns the ID of the DTD.
`short`	`getDTDMode()` Returns the mode of the SVG DTD.
`String`	`getDTDURL()` Returns the URL string of the DTD location.
`String`	`getPrefix(String xmlNamespaceURI)` Returns the prefix used to generate metadata from the given XML namespace.
`SVGDocumentBuilderConfigurator.RealToStringConverter`	`getRealToStringConverter()` Returns the object that defines how real numbers are converted to `String`.
`short`	`getStylingMode()` Returns the SVG version output mode.
`short`	`getSVGProfile()` Returns the SVG profile used to generate SVG documents.
`IlvTransformer`	`getTransformer()` Returns the transformer used to dump the contents of the `IlvManager`.
`SVGDocumentBuilderConfigurator.GraphicTranslator`	`getTranslator(String className)` Returns the `GraphicTranslator` that will be used to translate the `IlvGraphic` instances of class `className`.
`IlvRect`	`getViewBox()` Returns the `viewBox` rectangle.
`boolean`	`isEmbeddedImagesOn()` Returns `true` if the translation of `IlvIcon` should embed the images in the SVG file instead of referencing them.
`boolean`	`isFullDocumentOn()` Returns `true` if the `SVGDocumentBuilder` is allowed to regenerate unknown SVG elements and attributes or properties that were stored when reading the SVG Document.
`boolean`	`isMetadataOn(String xmlNamespaceURI)` Returns `true` if the `SVGDocumentBuilder` will generate special metadata from the given XML namespace if available.
`boolean`	`isViewBoxOn()` Returns the `viewBox` policy.
`void`	`putTranslator(String className, SVGDocumentBuilderConfigurator.GraphicTranslator translator)` Allows you to specialize the generation for a particular `IlvGraphic` class by registering the `GraphicTranslator`.
`void`	`setAttribute(String attribute, String value)` Sets the value of an attribute of the outermost SVG element except the `viewBox` attribute.
`void`	`setCompactMode(int val)` Sets one or a combination of flags to generate smaller SVG documents.
`void`	`setDTDMode(short mode)` Sets the mode of the output stream SVG DTD.
`void`	`setEmbeddedImagesOn(boolean value)` Specifies whether images are embedded or referenced.
`void`	`setFullDocumentOn(boolean val)` Allows the `SVGDocumentBuilder` to regenerate unknown SVG elements and attributes or properties that were stored when reading the SVG Document.
`void`	`setMetadataOn(String xmlNamespaceURI, String xmlNamespacePrefix, boolean value)` Allows you to tell the `SVGDocumentBuilder` to generate special metadata from the given XML namespace if available.
`void`	`setRealToStringConverter(SVGDocumentBuilderConfigurator.RealToStringConverter converter)` Allows you to set the way real numbers are converted to `String`.
`void`	`setStylingMode(short style)` Sets the SVG styling mode.
`void`	`setSVGProfile(short profile)` Sets the SVG profile used to generate SVG documents.
`void`	`setTransformer(IlvTransformer t)` Allows you to change the transformer used to dump the contents of the `IlvManager` in SVG.
`void`	`setViewBox(IlvRect rect)` Sets the rectangle that will define the `viewBox` on the resulting SVG document, in `IlvManager` coordinates.
`void`	`setViewBoxOn(boolean value)` Sets the `viewBox` policy.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SVG_CSS
```
public static final short SVG_CSS
```
    Uses the CSS styling capabilities of SVG.
    
    See Also:
    
    setStylingMode(short), Constant Field Values
  - SVG_XML
```
public static final short SVG_XML
```
    Uses the XML styling capabilities (presentation attributes) of SVG.
    
    See Also:
    
    setStylingMode(short), Constant Field Values
  - WEB_DTD
```
public static final short WEB_DTD
```
    Uses the official W3C DTD on the Web.
    
    See Also:
    
    Constant Field Values
  - LOCAL_DTD
```
public static final short LOCAL_DTD
```
    Uses a local DTD.
    
    See Also:
    
    Constant Field Values
  - NO_COMPACT
```
public static final int NO_COMPACT
```
    Performs no compaction on the generated SVG document. This flag should not be combined with other compaction flags.
    
    See Also:
    
    Constant Field Values
  - COMPACT_STYLE
```
public static final int COMPACT_STYLE
```
    Performs style compaction on the generated SVG document. This flag could be combined with other compaction flags.
    
    See Also:
    
    Constant Field Values
  - COMPACT_VISIBLE
```
public static final int COMPACT_VISIBLE
```
    Performs compaction by removing invisible graphic elements from the generated file. This flag could be combined with other compaction flags.
    
    See Also:
    
    Constant Field Values
  - COMPACT_VIEWBOX
```
public static final int COMPACT_VIEWBOX
```
    Performs compaction by removing graphic elements outside of the viewBox. This flag could be combined with other compaction flags.
    
    See Also:
    
    Constant Field Values
  - COMPACT_POLY
```
public static final int COMPACT_POLY
```
    Performs compaction by reducing the number of points of polylines, polygons, and so forth. The simplification is done using an algorithm adapted from that of Douglas and Peucker. This flag could be combined with other compaction flags.
    
    See Also:
    
    Constant Field Values
  - COMPACT_LOD
```
public static final int COMPACT_LOD
```
    Performs compaction by not generating SVG for an IlvManagerLayer that can be loaded only on demand for an SVG client (layers that are not visible). This flag could be combined with other compaction flags. It will be taken into account only if the configurator also generated metadata that allows you to recover the layer later on, that is, if JVIEWS_GF_NAMESPACE_URI is set with setMetadataOn(java.lang.String, java.lang.String, boolean).
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    Constant Field Values
  - FULL_SVG
```
public static final short FULL_SVG
```
    Generates SVG documents using the full profile of SVG.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    Constant Field Values
  - BASIC_SVG
```
public static final short BASIC_SVG
```
    Generates SVG documents using the basic profile of SVG. This profile is a subset of the full profile designed with mobility in mind.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    Constant Field Values
  - JVIEWS_GF_NAMESPACE_URI
```
public static final String JVIEWS_GF_NAMESPACE_URI
```
    Perforce JViews Graphics Framework XML Namespace URI. If setMetadataOn(java.lang.String, java.lang.String, boolean) is called with this value, the SVGDocumentBuilder will generate some metadata to better describe Perforce JViews objects in the resulting SVG. When used with the correct ECMAScript code on the client and the IlvSVGManagerServlet on the server, the metadata data will allow the following on the SVG user agent, to:
    - display the tooltip of the IlvGraphic
    - enable fixed size behavior of IlvFixedSizeGraphic and IlvLabel instances
    - generate data to be able to load invisible layers on demand.
    This values must be used in conjunction with the JVIEWS_GF_NAMESPACE_PREFIX prefix.
    Since:
    
    JViews 5.5
    
    See Also:
    
    Constant Field Values
  - JVIEWS_GF_NAMESPACE_PREFIX
```
public static final String JVIEWS_GF_NAMESPACE_PREFIX
```
    Perforce JViews Graphics Framework XML Namespace default Prefix. It has to be used when using JVIEWS_GF_NAMESPACE_URI as a parameter of setMetadataOn(String, String, boolean)
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    JVIEWS_GF_NAMESPACE_URI, setMetadataOn(java.lang.String, java.lang.String, boolean), Constant Field Values
- Constructor Detail
  - SVGDocumentBuilderConfigurator
```
public SVGDocumentBuilderConfigurator()
```
    Builds an SVGDocumentBuilderConfigurator instance.
- Method Detail
  - setTransformer
```
public final void setTransformer(IlvTransformer t)
```
    Allows you to change the transformer used to dump the contents of the IlvManager in SVG. The default is a null value for the identity transformer.
    
    Parameters:
    
    t - The transformer to set.
  - getTransformer
```
public final IlvTransformer getTransformer()
```
    Returns the transformer used to dump the contents of the IlvManager.
    
    See Also:
    
    setTransformer(ilog.views.IlvTransformer)
  - setStylingMode
```
public final void setStylingMode(short style)
```
    Sets the SVG styling mode. It could be a CSS styling using CSS stylesheets or a pure XML styling using XML attributes. For more details, see the SVG specification. The default value is SVG_CSS.
    
    Parameters:
    
    style - The SVG styling mode to set.
    
    See Also:
    
    SVG_CSS, SVG_XML
  - getStylingMode
```
public final short getStylingMode()
```
    Returns the SVG version output mode.
    
    See Also:
    
    setStylingMode(short)
  - setDTDMode
```
public final void setDTDMode(short mode)
```
    Sets the mode of the output stream SVG DTD. The default value is to reference the official SVG DTD on the Web.
    
    Parameters:
    
    mode - The mode of the SVG DTD to set.
    
    See Also:
    
    WEB_DTD, LOCAL_DTD
  - getDTDMode
```
public final short getDTDMode()
```
    Returns the mode of the SVG DTD.
    
    See Also:
    
    setDTDMode(short)
  - getDTDURL
```
public String getDTDURL()
```
    Returns the URL string of the DTD location.
  - getDTDID
```
public String getDTDID()
```
    Returns the ID of the DTD.
  - setCompactMode
```
public final void setCompactMode(int val)
```
    Sets one or a combination of flags to generate smaller SVG documents. Please note that generating a compact file may slow down the generation but will speed up the download of the file on the Internet. You can also generate smaller SVG files by using a GZIP compression on the stream. The default value is NO_COMPACT.
    
    Parameters:
    
    val - A value representing one or more compaction flags.
    
    See Also:
    
    NO_COMPACT, COMPACT_STYLE, COMPACT_VISIBLE, COMPACT_VIEWBOX, COMPACT_POLY, COMPACT_LOD
  - getCompactMode
```
public final int getCompactMode()
```
    Returns the current compaction mode.
    
    See Also:
    
    setCompactMode(int)
  - setFullDocumentOn
```
public final void setFullDocumentOn(boolean val)
```
    Allows the SVGDocumentBuilder to regenerate unknown SVG elements and attributes or properties that were stored when reading the SVG Document. Examples are 'script' or 'filter' elements. The default value is false.
    
    Parameters:
    
    val - Set true to allow full regeneration.
  - isFullDocumentOn
```
public final boolean isFullDocumentOn()
```
    Returns true if the SVGDocumentBuilder is allowed to regenerate unknown SVG elements and attributes or properties that were stored when reading the SVG Document. The default value is false.
    
    See Also:
    
    setFullDocumentOn(boolean)
  - setViewBox
```
public final void setViewBox(IlvRect rect)
```
    Sets the rectangle that will define the viewBox on the resulting SVG document, in IlvManager coordinates. The viewBox is the rectangle defining the objects that will be visible in the drawing area of the generated SVG document. The default value is null; this means that the viewBox will be automatically computed to show all the visible objects of the manager.
    
    Parameters:
    
    rect - The defining rectangle, in IlvManager coordinates.
    
    See Also:
    
    setViewBoxOn(boolean)
  - getViewBox
```
public final IlvRect getViewBox()
```
    Returns the viewBox rectangle.
    
    See Also:
    
    setViewBox(ilog.views.IlvRect)
  - setViewBoxOn
```
public final void setViewBoxOn(boolean value)
```
    Sets the viewBox policy. If set to true, a viewBox will be computed or taken from getViewBox() and added to the generated file. If set to false, if the full parsing mode is on (isFullDocumentOn()), the values of the original SVGDocument are used; or no viewBox is set if there is no original document. The default value is true.
    
    Parameters:
    
    value - true to set a view box, or false otherwise.
  - isViewBoxOn
```
public final boolean isViewBoxOn()
```
    Returns the viewBox policy.
    
    See Also:
    
    setViewBoxOn(boolean)
  - setAttribute
```
public final void setAttribute(String attribute,
                               String value)
```
    Sets the value of an attribute of the outermost SVG element except the viewBox attribute. The attribute parameter should be a valid SVG attribute of the 'svg' element according to the SVG specification. This is the proper way to set the x, y, width, and height 'svg' element attributes or its preserveAspectRatio or zoomAndPan attribute.
    
    Parameters:
    
    attribute - The attribute.
    
    value - The value of the attribute to set.
    
    See Also:
    
    setViewBox(ilog.views.IlvRect)
  - getAttribute
```
public final String getAttribute(String attribute)
```
    Returns the preset value of an attribute of the outermost SVG element. It returns null if the attribute has not been preset.
    
    Parameters:
    
    attribute - The attribute to query.
    
    See Also:
    
    setAttribute(java.lang.String, java.lang.String)
  - getTranslator
```
public SVGDocumentBuilderConfigurator.GraphicTranslator getTranslator(String className)
```
    Returns the GraphicTranslator that will be used to translate the IlvGraphic instances of class className.
    
    Parameters:
    
    className - The name of the IlvGraphic class.
    
    Since:
    
    JViews 5.0
    
    See Also:
    
    putTranslator(java.lang.String, ilog.views.svg.SVGDocumentBuilderConfigurator.GraphicTranslator)
  - putTranslator
```
public final void putTranslator(String className,
                                SVGDocumentBuilderConfigurator.GraphicTranslator translator)
```
    Allows you to specialize the generation for a particular IlvGraphic class by registering the GraphicTranslator. This method is useful if you want replace the generic mechanism by your own IlvGraphic classes when saving your IlvManager in SVG:
    // IlvGraphic definition file package mycompany; public class MyGraphic { // ... } // GraphicTranslator definition file package mycompany; public class MyGraphicTranslator { public Element translate(IlvGraphic graphic, IlvTransformer t, SVGDocumentBuilder builder) { MyGraphic my = (MyGraphic)graphic; // for example we create an SVG g element Element elmt = builder.getDocument().createElementNS("http://www.w3.org/2000/svg", "g"); // ... fill the element ... return elmt; } } // used in another file: SVGStreamFactory factory = new SVGStreamFactory(); factory.getBuilderConfigurator().putTranslator("mycompany.MyGraphic", new MyGraphicTranslator()); myManager.setStreamFactory(factory); myManager.write("file.svg");
    Parameters:
    
    className - The name of the IlvGraphic class.
    
    translator - The graphic translator to register.
    
    Since:
    
    JViews 5.0
  - setRealToStringConverter
```
public final void setRealToStringConverter(SVGDocumentBuilderConfigurator.RealToStringConverter converter)
```
    Allows you to set the way real numbers are converted to String.
    
    Parameters:
    
    converter - The converter to set.
    
    Since:
    
    JViews 5.0
    
    See Also:
    
    SVGDocumentBuilderConfigurator.RealToStringConverter, getRealToStringConverter()
  - getRealToStringConverter
```
public final SVGDocumentBuilderConfigurator.RealToStringConverter getRealToStringConverter()
```
    Returns the object that defines how real numbers are converted to String. The default value is the instance of DefaultRealToStringConverter.
    
    Since:
    
    JViews 5.0
    
    See Also:
    
    SVGDocumentBuilderConfigurator.RealToStringConverter, setRealToStringConverter(ilog.views.svg.SVGDocumentBuilderConfigurator.RealToStringConverter)
  - getSVGProfile
```
public final short getSVGProfile()
```
    Returns the SVG profile used to generate SVG documents.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    FULL_SVG, BASIC_SVG, setSVGProfile(short)
  - setSVGProfile
```
public final void setSVGProfile(short profile)
```
    Sets the SVG profile used to generate SVG documents. Only two SVG profiles are recognized: the FULL_SVG profile and the BASIC_SVG profile of the SVG 1.1 specification.
    
    Parameters:
    
    profile - The SVG profile to set.
    
    Since:
    
    JViews 5.5
  - isEmbeddedImagesOn
```
public final boolean isEmbeddedImagesOn()
```
    Returns true if the translation of IlvIcon should embed the images in the SVG file instead of referencing them. The default is false.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    setEmbeddedImagesOn(boolean)
  - setEmbeddedImagesOn
```
public final void setEmbeddedImagesOn(boolean value)
```
    Specifies whether images are embedded or referenced. Setting this value to true will allow IlvIcon translations to embed the images in the SVG file instead of referencing them. The default is false.
    
    Parameters:
    
    value - Set true to embed the images, or false to reference the images.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    isEmbeddedImagesOn()
  - isMetadataOn
```
public final boolean isMetadataOn(String xmlNamespaceURI)
```
    Returns true if the SVGDocumentBuilder will generate special metadata from the given XML namespace if available. The only recognized namespace is JVIEWS_GF_NAMESPACE_URI.
    
    Parameters:
    
    xmlNamespaceURI - The URI of the namespace.
    
    Since:
    
    JViews 5.5
  - getPrefix
```
public final String getPrefix(String xmlNamespaceURI)
```
    Returns the prefix used to generate metadata from the given XML namespace.
    
    Parameters:
    
    xmlNamespaceURI - The URI of the namespace.
    
    Since:
    
    JViews 5.5
  - setMetadataOn
```
public final void setMetadataOn(String xmlNamespaceURI,
                                String xmlNamespacePrefix,
                                boolean value)
```
    Allows you to tell the SVGDocumentBuilder to generate special metadata from the given XML namespace if available. The only recognized namespace is JVIEWS_GF_NAMESPACE_URI, which must be used with the JVIEWS_GF_NAMESPACE_PREFIX prefix.
    
    Parameters:
    
    xmlNamespaceURI - The URI of the namespace.
    
    xmlNamespacePrefix - The prefix that will be used for this namespace.
    
    value - true to instruct the SVGDocumentBuilder to generate metadata from this namespace.
    
    Since:
    
    JViews 5.5

Class SVGDocumentBuilderConfigurator

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SVG_CSS

SVG_XML

WEB_DTD

LOCAL_DTD

NO_COMPACT

COMPACT_STYLE

COMPACT_VISIBLE

COMPACT_VIEWBOX

COMPACT_POLY

COMPACT_LOD

FULL_SVG

BASIC_SVG

JVIEWS_GF_NAMESPACE_URI

JVIEWS_GF_NAMESPACE_PREFIX

Constructor Detail

SVGDocumentBuilderConfigurator

Method Detail

setTransformer

getTransformer

setStylingMode

getStylingMode

setDTDMode

getDTDMode

getDTDURL

getDTDID

setCompactMode

getCompactMode

setFullDocumentOn

isFullDocumentOn

setViewBox

getViewBox

setViewBoxOn

isViewBoxOn

setAttribute

getAttribute

getTranslator

putTranslator

setRealToStringConverter

getRealToStringConverter

getSVGProfile

setSVGProfile

isEmbeddedImagesOn

setEmbeddedImagesOn

isMetadataOn

getPrefix

setMetadataOn