com.esri.arcgis.output
Class ExportSVG

java.lang.Object
  com.esri.arcgis.output.ExportSVG

All Implemented Interfaces:

IExport, IExportColorspaceSettings, IExportSVG, IExportVector, IExportVectorOptions, IExportVectorOptionsEx, IOutputRasterSettings, ISettingsInRegistry, ISupportErrorInfo, java.io.Serializable

public class ExportSVG

extends java.lang.Object

implements IExportVector, IExportVectorOptions, IExportVectorOptionsEx, IExportSVG, IExport, ISettingsInRegistry, IExportColorspaceSettings, ISupportErrorInfo, IOutputRasterSettings

Class used to export maps to SVG (Scalable Vector Graphics) format.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Remarks

Use the ExportSVG CoClass to export your map to SVG (Scalable Vector Graphics) format. SVG is an XML-based file format that has been specifically designed for viewing on the Web. SVG can contain both vector and raster information. This is a good choice for displaying maps on a web page because it is rescalable and more easily edited than raster files. SVG has been gaining in popularity since the World Wide Web Consortium (W3C) selected it as their standard vector web format. Some web browsers may require a plug-in in order to view SVG files, and older browsers may not be able to view SVG files at all.

See Also:

Serialized Form

Constructor Summary

ExportSVG()
Constructs a ExportSVG using ArcGIS Engine.

ExportSVG(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

void	cleanup() Cleanup should clean all temporary files, free used memory, etc...
boolean	equals(java.lang.Object o) Compare this object with another
void	finishExporting() Shuts down the Exporter.
IExport	getAsIExport() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IExportColorspaceSettings	getAsIExportColorspaceSettings() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IExportSVG	getAsIExportSVG() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IExportVector	getAsIExportVector() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IExportVectorOptions	getAsIExportVectorOptions() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IExportVectorOptionsEx	getAsIExportVectorOptionsEx() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IOutputRasterSettings	getAsIOutputRasterSettings() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ISettingsInRegistry	getAsISettingsInRegistry() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ISupportErrorInfo	getAsISupportErrorInfo() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
static java.lang.String	getClsid()
int	getColorspace() Colorspace option.
java.lang.String	getExportFileName() The Export File Name.
int	getExportPictureSymbolOptions() Options describing what to do with Picture Symbol on export.
java.lang.String	getFilter() Filter String used in the CFileDialog class.
int	getMaxVertexNumber() Maximum number of vertices in feature.
java.lang.String	getName() The Name of the Exporter.
IEnvelope	getPixelBounds() The Export Bounds in Pixels (The Pixel Bounds of the Export surface).
int	getPriority() Exporter's priority - the order of appearance in the user interface.
int	getResampleRatio() This coefficient states the scale level for the raster when it goes to output.
double	getResolution() The Export Resolution.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) Supported Platforms
boolean	isCompressed() Indicates if the SVG file is compressed.
boolean	isEmbedFonts() The Embed Fonts option.
boolean	isPolygonizeMarkers() Polygonize (represent as vectors instead of fonts) marker symbols option.
void	restoreDefault() Restore the default object settings.
void	restoreForCurrentUser(java.lang.String bstrRegPath) Restore object settings.
void	setColorspace(int pcolorspace) Colorspace option.
void	setCompressed(boolean compressed) Indicates if the SVG file is compressed.
void	setEmbedFonts(boolean embedFonts) The Embed Fonts option.
void	setExportFileName(java.lang.String fileName) The Export File Name.
void	setExportPictureSymbolOptions(int opt) Options describing what to do with Picture Symbol on export.
void	setMaxVertexNumber(int lMaxVertices) Maximum number of vertices in feature.
void	setPixelBounds(IEnvelope pixelBounds) The Export Bounds in Pixels (The Pixel Bounds of the Export surface).
void	setPolygonizeMarkers(boolean bPolygonizeMarkers) Polygonize (represent as vectors instead of fonts) marker symbols option.
void	setResampleRatio(int pRatio) This coefficient states the scale level for the raster when it goes to output.
void	setResolution(double res) The Export Resolution.
void	setStepProgressorByRef(IStepProgressor rhs1) Export will update a Progress Bar if StepProgressor is not NULL.
void	setTrackCancelByRef(ITrackCancel rhs1) Export will react on Cancel if TrackCancel is not NULL.
int	startExporting() Initializes the Exporter.
void	storeForCurrentUser(java.lang.String bstrRegPath) Store object settings.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExportSVG

public ExportSVG()
          throws java.io.IOException,
                 java.net.UnknownHostException

Constructs a ExportSVG using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ExportSVG

public ExportSVG(java.lang.Object obj)
          throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a ExportSVG using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ExportSVG.
ExportSVG theExportSVG = (ExportSVG) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIExportVector

public IExportVector getAsIExportVector()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIExportVectorOptions

public IExportVectorOptions getAsIExportVectorOptions()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIExportVectorOptionsEx

public IExportVectorOptionsEx getAsIExportVectorOptionsEx()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIExportSVG

public IExportSVG getAsIExportSVG()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIExport

public IExport getAsIExport()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISettingsInRegistry

public ISettingsInRegistry getAsISettingsInRegistry()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIExportColorspaceSettings

public IExportColorspaceSettings getAsIExportColorspaceSettings()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISupportErrorInfo

public ISupportErrorInfo getAsISupportErrorInfo()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIOutputRasterSettings

public IOutputRasterSettings getAsIOutputRasterSettings()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

setPolygonizeMarkers

public void setPolygonizeMarkers(boolean bPolygonizeMarkers)
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IExportVectorOptions

Polygonize (represent as vectors instead of fonts) marker symbols option.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPolygonizeMarkers in interface IExportVectorOptions

Parameters:

bPolygonizeMarkers - The bPolygonizeMarkers (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPolygonizeMarkers

public boolean isPolygonizeMarkers()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IExportVectorOptions

Polygonize (represent as vectors instead of fonts) marker symbols option.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isPolygonizeMarkers in interface IExportVectorOptions

Returns:

The bPolygonizeMarkers

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setMaxVertexNumber

public void setMaxVertexNumber(int lMaxVertices)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IExportVectorOptions

Maximum number of vertices in feature.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaxVertexNumber in interface IExportVectorOptions

Parameters:

lMaxVertices - The lMaxVertices (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxVertexNumber

public int getMaxVertexNumber()
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IExportVectorOptions

Maximum number of vertices in feature.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMaxVertexNumber in interface IExportVectorOptions

Returns:

The lMaxVertices

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExportPictureSymbolOptions

public void setExportPictureSymbolOptions(int opt)
                                   throws java.io.IOException,
                                          AutomationException

Description copied from interface: IExportVectorOptionsEx

Options describing what to do with Picture Symbol on export.

Specified by:

setExportPictureSymbolOptions in interface IExportVectorOptionsEx

Parameters:

opt - A com.esri.arcgis.display.esriPictureSymbolOptions constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExportPictureSymbolOptions

public int getExportPictureSymbolOptions()
                                  throws java.io.IOException,
                                         AutomationException

Description copied from interface: IExportVectorOptionsEx

Options describing what to do with Picture Symbol on export.

Specified by:

getExportPictureSymbolOptions in interface IExportVectorOptionsEx

Returns:

A com.esri.arcgis.display.esriPictureSymbolOptions constant

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

isCompressed

public boolean isCompressed()
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IExportSVG

Indicates if the SVG file is compressed.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCompressed in interface IExportSVG

Returns:

The compressed

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setCompressed

public void setCompressed(boolean compressed)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IExportSVG

Indicates if the SVG file is compressed.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCompressed in interface IExportSVG

Parameters:

compressed - The compressed (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setEmbedFonts

public void setEmbedFonts(boolean embedFonts)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IExportSVG

The Embed Fonts option.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setEmbedFonts in interface IExportSVG

Parameters:

embedFonts - The embedFonts (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

isEmbedFonts

public boolean isEmbedFonts()
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IExportSVG

The Embed Fonts option.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEmbedFonts in interface IExportSVG

Returns:

The embedFonts

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IExport

The Name of the Exporter.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IExport

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilter

public java.lang.String getFilter()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IExport

Filter String used in the CFileDialog class.

Supported Platforms

Windows, Solaris, Linux

Remarks

This method is primarily used for defining the extension of the export file name within the Export Map dialog. The string contained in this value is a null-terminated pattern string that follows the standard for a Windows Open and Save As dialog filter. The value of this property can change according to the state of the export object. An ExportSVG object, for example, returns "SVG (*.svg)|*.svg" when its compression property is False, and "Compressed SVG (*.svgz)|*.svgz" when the compression property is True. This makes the Filter ideal for automatically assigning the appropriate file name extension for an export file.

Specified by:

getFilter in interface IExport

Returns:

The filter

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getPriority

public int getPriority()
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IExport

Exporter's priority - the order of appearance in the user interface.

Supported Platforms

Windows, Solaris, Linux

Remarks

Primarily used by export dialogs for ordering the appearance of export formats in the 'Save As...' pulldown list. By ordering through this property, the export dialog can group similar formats together. For example, all raster export formats are grouped together in the 'Save As...' list.

Specified by:

getPriority in interface IExport

Returns:

The pPriority

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStepProgressorByRef

public void setStepProgressorByRef(IStepProgressor rhs1)
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IExport

Export will update a Progress Bar if StepProgressor is not NULL.

Specified by:

setStepProgressorByRef in interface IExport

Parameters:

rhs1 - A reference to a com.esri.arcgis.system.IStepProgressor (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setTrackCancelByRef

public void setTrackCancelByRef(ITrackCancel rhs1)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IExport

Export will react on Cancel if TrackCancel is not NULL.

Specified by:

setTrackCancelByRef in interface IExport

Parameters:

rhs1 - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPixelBounds

public void setPixelBounds(IEnvelope pixelBounds)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IExport

The Export Bounds in Pixels (The Pixel Bounds of the Export surface).

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPixelBounds in interface IExport

Parameters:

pixelBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getPixelBounds

public IEnvelope getPixelBounds()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IExport

The Export Bounds in Pixels (The Pixel Bounds of the Export surface).

Supported Platforms

Windows, Solaris, Linux

Remarks

The PixelBounds represents the height and width of the export image in device units (usually pixels for a export file). To set up values to use in this property, get the height and width of the image draw to screen. Then multiply each dimension by the ratio of the output resolution to screen resolution.

Specified by:

getPixelBounds in interface IExport

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExportFileName

public void setExportFileName(java.lang.String fileName)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IExport

The Export File Name.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExportFileName in interface IExport

Parameters:

fileName - The fileName (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getExportFileName

public java.lang.String getExportFileName()
                                   throws java.io.IOException,
                                          AutomationException

Description copied from interface: IExport

The Export File Name.

Supported Platforms

Windows, Solaris, Linux

Remarks

You must assign a value to the ExportFileName property before calling the IExport::StartExporting() method. There are two exceptions to this. If IExport is controlling a ExportBMP or ExportEMF object, you can assign an empty string to the ExportFileName property without an error being raised on StartExporting(). This is to allow cases where the application will use the export object as a intermediate container for a drawing, and won't be written to an export file.

Specified by:

getExportFileName in interface IExport

Returns:

The fileName

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setResolution

public void setResolution(double res)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IExport

The Export Resolution.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setResolution in interface IExport

Parameters:

res - The res (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResolution

public double getResolution()
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IExport

The Export Resolution.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getResolution in interface IExport

Returns:

The res

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

startExporting

public int startExporting()
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IExport

Initializes the Exporter.

Supported Platforms

Windows, Solaris, Linux

Remarks

The StartExporting method causes the export object to allocate memory for the export based on resolution, bit depth, and pixel bounds. The method returns a long that represents the hDC (Windows GDI Device Context handle) of the export object. After this method is called, the export object is ready to receive GDI draw instructions directed to its hDC.

Specified by:

startExporting in interface IExport

Returns:

The hDC (A COM typedef)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

finishExporting

public void finishExporting()
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IExport

Shuts down the Exporter.

Supported Platforms

Windows, Solaris, Linux

Specified by:

finishExporting in interface IExport

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

cleanup

public void cleanup()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IExport

Cleanup should clean all temporary files, free used memory, etc...

Supported Platforms

Windows, Solaris, Linux

Specified by:

cleanup in interface IExport

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

restoreForCurrentUser

public void restoreForCurrentUser(java.lang.String bstrRegPath)
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: ISettingsInRegistry

Restore object settings.

Supported Platforms

Windows, Solaris, Linux

Specified by:

restoreForCurrentUser in interface ISettingsInRegistry

Parameters:

bstrRegPath - The bstrRegPath (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

storeForCurrentUser

public void storeForCurrentUser(java.lang.String bstrRegPath)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: ISettingsInRegistry

Store object settings.

Supported Platforms

Windows, Solaris, Linux

Specified by:

storeForCurrentUser in interface ISettingsInRegistry

Parameters:

bstrRegPath - The bstrRegPath (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

restoreDefault

public void restoreDefault()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: ISettingsInRegistry

Restore the default object settings.

Supported Platforms

Windows, Solaris, Linux

Specified by:

restoreDefault in interface ISettingsInRegistry

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColorspace

public void setColorspace(int pcolorspace)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IExportColorspaceSettings

Colorspace option.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setColorspace in interface IExportColorspaceSettings

Parameters:

pcolorspace - A com.esri.arcgis.output.esriExportColorspace constant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getColorspace

public int getColorspace()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IExportColorspaceSettings

Colorspace option.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getColorspace in interface IExportColorspaceSettings

Returns:

A com.esri.arcgis.output.esriExportColorspace constant

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: ISupportErrorInfo

Supported Platforms

Windows, Solaris, Linux

Description

Indicates whether the interface supports IErrorInfo.

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getResampleRatio

public int getResampleRatio()
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IOutputRasterSettings

This coefficient states the scale level for the raster when it goes to output. 1 means 1:1; 2 means 1:2, i.e. 2 times less than the output quality.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getResampleRatio in interface IOutputRasterSettings

Returns:

The pRatio

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResampleRatio

public void setResampleRatio(int pRatio)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IOutputRasterSettings

This coefficient states the scale level for the raster when it goes to output. 1 means 1:1; 2 means 1:2, i.e. 2 times less than the output quality.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setResampleRatio in interface IOutputRasterSettings

Parameters:

pRatio - The pRatio (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.