com.esri.arcgis.output
Class PDFExporter

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IExporter, IExporterPriority, IFontMapEnvironment, IOutputCleanup, IPDFExporter, IStepProgressorSetup, ITrackCancelSetup, ISupportErrorInfo, Serializable

public class PDFExporter
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPDFExporter, IExporter, IExporterPriority, IFontMapEnvironment, ISupportErrorInfo, IOutputCleanup, IStepProgressorSetup, ITrackCancelSetup

Superseded by ExportPDF. Provides access to the PDF (Portable Document Format) exporter.

Superseded By

ExportPDF

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

PDFExporter()
Constructs a PDFExporter using ArcGIS Engine.

PDFExporter(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PDFExporter thePDFExporter = (PDFExporter) obj;

Method Summary

void	cleanup() Cleanup should clean all temporary files, free used memory, etc...
boolean	equals(Object o) Compare this object with another
void	finishExporting() Shuts down the Exporter.
String	getApplyDefaultMappingDesc() The Font Mapping checkbox description string.
static String	getClsid() getClsid.
String	getDefaultMapping() The Default Font Mapping string.
Object	getDefaultMappingsChoices() The Default Mapping Choices for Font Substitution.
String	getExportFileName() The Export File Name.
String	getFileExtension() File Extension associated with Exporter.
String	getFilter() Filter String used in the CFileDialog class.
IFontMapCollection	getFontMapCollection() The FontMap Collection.
String	getName() The Name of the Exporter.
IEnvelope	getPixelBounds() The Pixel Bounds of the Exporter.
int	getPriority() Exporter's priority - the order of appearance in the user interface.
short	getResolution() The Resolution of the Exporter.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isClipToGraphicExtent() Indicates if the Output will be clipped to the Graphics Extent.
boolean	isSaveMappings() Indicates whether to save font mappings.
void	setApplyDefaultMappingDesc(String applyDefaultMappingDesc) The Font Mapping checkbox description string.
void	setClipToGraphicExtent(boolean clipToGraphicsExtent) Indicates if the Output will be clipped to the Graphics Extent.
void	setDefaultMapping(String defaultMapping) The Default Font Mapping string.
void	setDefaultMappingsChoices(Object defaultMappingChoices) The Default Mapping Choices for Font Substitution.
void	setExportFileName(String fileName) The Export File Name.
void	setPixelBounds(IEnvelope pixelBounds) The Pixel Bounds of the Exporter.
void	setResolution(short res) The Resolution of the Exporter.
void	setSaveMappings(boolean saveMappings) Indicates whether to save font mappings.
void	setStepProgressor(IStepProgressor rhs1) Updates a Progress Bar.
void	setTrackCancel(ITrackCancel rhs1) Reacts to a Cancel.
int	startExporting() Initializes the Exporter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

PDFExporter

public PDFExporter()
            throws IOException,
                   UnknownHostException

Constructs a PDFExporter using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

PDFExporter

public PDFExporter(Object obj)
            throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PDFExporter thePDFExporter = (PDFExporter) obj;

Construct a PDFExporter using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to PDFExporter.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getName

public String getName()
               throws IOException,
                      AutomationException

The Name of the Exporter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IExporter

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilter

public String getFilter()
                 throws IOException,
                        AutomationException

Filter String used in the CFileDialog class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFilter in interface IExporter

Returns:

The filter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFileExtension

public String getFileExtension()
                        throws IOException,
                               AutomationException

File Extension associated with Exporter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFileExtension in interface IExporter

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPixelBounds

public void setPixelBounds(IEnvelope pixelBounds)
                    throws IOException,
                           AutomationException

The Pixel Bounds of the Exporter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPixelBounds in interface IExporter

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPixelBounds

public IEnvelope getPixelBounds()
                         throws IOException,
                                AutomationException

The Pixel Bounds of the Exporter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPixelBounds in interface IExporter

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExportFileName

public void setExportFileName(String fileName)
                       throws IOException,
                              AutomationException

The Export File Name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExportFileName in interface IExporter

Parameters:

fileName - The fileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExportFileName

public String getExportFileName()
                         throws IOException,
                                AutomationException

The Export File Name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExportFileName in interface IExporter

Returns:

The fileName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResolution

public short getResolution()
                    throws IOException,
                           AutomationException

The Resolution of the Exporter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getResolution in interface IExporter

Returns:

The res

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResolution

public void setResolution(short res)
                   throws IOException,
                          AutomationException

The Resolution of the Exporter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setResolution in interface IExporter

Parameters:

res - The res (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isClipToGraphicExtent

public boolean isClipToGraphicExtent()
                              throws IOException,
                                     AutomationException

Indicates if the Output will be clipped to the Graphics Extent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isClipToGraphicExtent in interface IExporter

Returns:

The clipToGraphicsExtent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClipToGraphicExtent

public void setClipToGraphicExtent(boolean clipToGraphicsExtent)
                            throws IOException,
                                   AutomationException

Indicates if the Output will be clipped to the Graphics Extent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setClipToGraphicExtent in interface IExporter

Parameters:

clipToGraphicsExtent - The clipToGraphicsExtent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startExporting

public int startExporting()
                   throws IOException,
                          AutomationException

Initializes the Exporter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

startExporting in interface IExporter

Returns:

The hDC (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

finishExporting

public void finishExporting()
                     throws IOException,
                            AutomationException

Shuts down the Exporter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

finishExporting in interface IExporter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPriority

public int getPriority()
                throws IOException,
                       AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPriority in interface IExporterPriority

Returns:

The pPriority

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSaveMappings

public void setSaveMappings(boolean saveMappings)
                     throws IOException,
                            AutomationException

Indicates whether to save font mappings.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSaveMappings in interface IFontMapEnvironment

Parameters:

saveMappings - The saveMappings (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSaveMappings

public boolean isSaveMappings()
                       throws IOException,
                              AutomationException

Indicates whether to save font mappings.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSaveMappings in interface IFontMapEnvironment

Returns:

The saveMappings

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFontMapCollection

public IFontMapCollection getFontMapCollection()
                                        throws IOException,
                                               AutomationException

The FontMap Collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFontMapCollection in interface IFontMapEnvironment

Returns:

A reference to a com.esri.arcgis.output.IFontMapCollection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultMappingsChoices

public void setDefaultMappingsChoices(Object defaultMappingChoices)
                               throws IOException,
                                      AutomationException

The Default Mapping Choices for Font Substitution.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefaultMappingsChoices in interface IFontMapEnvironment

Parameters:

defaultMappingChoices - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultMappingsChoices

public Object getDefaultMappingsChoices()
                                 throws IOException,
                                        AutomationException

The Default Mapping Choices for Font Substitution.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefaultMappingsChoices in interface IFontMapEnvironment

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultMapping

public void setDefaultMapping(String defaultMapping)
                       throws IOException,
                              AutomationException

The Default Font Mapping string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefaultMapping in interface IFontMapEnvironment

Parameters:

defaultMapping - The defaultMapping (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultMapping

public String getDefaultMapping()
                         throws IOException,
                                AutomationException

The Default Font Mapping string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefaultMapping in interface IFontMapEnvironment

Returns:

The defaultMapping

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setApplyDefaultMappingDesc

public void setApplyDefaultMappingDesc(String applyDefaultMappingDesc)
                                throws IOException,
                                       AutomationException

The Font Mapping checkbox description string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setApplyDefaultMappingDesc in interface IFontMapEnvironment

Parameters:

applyDefaultMappingDesc - The applyDefaultMappingDesc (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getApplyDefaultMappingDesc

public String getApplyDefaultMappingDesc()
                                  throws IOException,
                                         AutomationException

The Font Mapping checkbox description string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getApplyDefaultMappingDesc in interface IFontMapEnvironment

Returns:

The applyDefaultMappingDesc

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cleanup

public void cleanup()
             throws IOException,
                    AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

cleanup in interface IOutputCleanup

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStepProgressor

public void setStepProgressor(IStepProgressor rhs1)
                       throws IOException,
                              AutomationException

Updates a Progress Bar.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setStepProgressor in interface IStepProgressorSetup

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTrackCancel

public void setTrackCancel(ITrackCancel rhs1)
                    throws IOException,
                           AutomationException

Reacts to a Cancel.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTrackCancel in interface ITrackCancelSetup

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.