com.esri.arcgis.output
Class EmfExporter

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IEmfExporter, IExporter, IExporterPriority, IOutputCleanup, ISupportErrorInfo, java.io.Serializable

public class EmfExporter
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IEmfExporter, IExporter, IExporterPriority, ISupportErrorInfo, IOutputCleanup

COM Class 'EmfExporter'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriOutput.olb'

Description 'Superseded by ExportEMF. Class used to export maps to Windows Enhanced Metafile (EMF) format.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.output.IEmfExporter

IID, IID7d4881e3_57c6_11d1_945e_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.output.IExporter

IID, IID7d4881e2_57c6_11d1_945e_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.output.IExporterPriority

IID, IID10aae67f_d5ab_4905_a0bf_82636ba2ed02, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Fields inherited from interface com.esri.arcgis.output.IOutputCleanup

IID, IID2b8765ec_8808_474c_8fd3_869d08df20f6, xxDummy

Constructor Summary

EmfExporter()
Constructs a EmfExporter using ArcGIS Engine.

EmfExporter(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
EmfExporter theEmfExporter = (EmfExporter) obj;

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.
static java.lang.String	getClsid() getClsid.
java.lang.String	getDescription() A description string to embed in the file.
java.lang.String	getExportFileName() The Export File Name.
java.lang.String	getFileExtension() File Extension associated with Exporter.
java.lang.String	getFilter() Filter String used in the CFileDialog class.
int	getHENHMETAFILE() Handle to in-memory metafile.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.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	isInMemory() Indicates if the metafile will be written to memory.
void	release() Release a EmfExporter.
void	setClipToGraphicExtent(boolean clipToGraphicsExtent) Indicates if the Output will be clipped to the Graphics Extent.
void	setDescription(java.lang.String pDescription) A description string to embed in the file.
void	setExportFileName(java.lang.String fileName) The Export File Name.
void	setIsInMemory(boolean pIsInMemory) Indicates if the metafile will be written to memory.
void	setPixelBounds(IEnvelope pixelBounds) The Pixel Bounds of the Exporter.
void	setResolution(short res) The Resolution of the Exporter.
int	startExporting() Initializes the Exporter.
int	takeHENHMETAFILE() Returns the handle to the in-memory metafile.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmfExporter

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

Constructs a EmfExporter using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

EmfExporter

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

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

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

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()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a EmfExporter.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setIsInMemory

public void setIsInMemory(boolean pIsInMemory)
                   throws java.io.IOException,
                          AutomationException

Indicates if the metafile will be written to memory.

Specified by:

setIsInMemory in interface IEmfExporter

Parameters:

pIsInMemory - The pIsInMemory (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isInMemory

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

Indicates if the metafile will be written to memory.

Specified by:

isInMemory in interface IEmfExporter

Returns:

The pIsInMemory

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHENHMETAFILE

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

Handle to in-memory metafile. Valid only after ReleaseDC has been called.

Specified by:

getHENHMETAFILE in interface IEmfExporter

Returns:

The pHandle (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

takeHENHMETAFILE

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

Returns the handle to the in-memory metafile. Valid only after ReleaseDC has been called. Ownership of the handle is transferred to the client who must call DeleteEnhMetafile on the returned handle. Subsequent calls to this routine will return 0.

Specified by:

takeHENHMETAFILE in interface IEmfExporter

Returns:

The pHandle (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(java.lang.String pDescription)
                    throws java.io.IOException,
                           AutomationException

A description string to embed in the file.

Specified by:

setDescription in interface IEmfExporter

Parameters:

pDescription - The pDescription (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

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

A description string to embed in the file.

Specified by:

getDescription in interface IEmfExporter

Returns:

The pDescription

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

The Name of the Exporter.

Specified by:

getName in interface IExporter

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

Filter String used in the CFileDialog class.

Specified by:

getFilter in interface IExporter

Returns:

The filter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFileExtension

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

File Extension associated with Exporter.

Specified by:

getFileExtension in interface IExporter

Returns:

The name

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

The Pixel Bounds of the Exporter.

Specified by:

setPixelBounds in interface IExporter

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPixelBounds

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

The Pixel Bounds of the Exporter.

Specified by:

getPixelBounds in interface IExporter

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

The Export File Name.

Specified by:

setExportFileName in interface IExporter

Parameters:

fileName - The fileName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExportFileName

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

The Export File Name.

Specified by:

getExportFileName in interface IExporter

Returns:

The fileName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getResolution

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

The Resolution of the Exporter.

Specified by:

getResolution in interface IExporter

Returns:

The res

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResolution

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

The Resolution of the Exporter.

Specified by:

setResolution in interface IExporter

Parameters:

res - The res (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isClipToGraphicExtent

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

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

Specified by:

isClipToGraphicExtent in interface IExporter

Returns:

The clipToGraphicsExtent

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setClipToGraphicExtent

public void setClipToGraphicExtent(boolean clipToGraphicsExtent)
                            throws java.io.IOException,
                                   AutomationException

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

Specified by:

setClipToGraphicExtent in interface IExporter

Parameters:

clipToGraphicsExtent - The clipToGraphicsExtent (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startExporting

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

Initializes the Exporter.

Specified by:

startExporting in interface IExporter

Returns:

The hDC (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

finishExporting

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

Shuts down the Exporter.

Specified by:

finishExporting in interface IExporter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPriority

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

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

Specified by:

getPriority in interface IExporterPriority

Returns:

The pPriority

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

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

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

cleanup

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

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

Specified by:

cleanup in interface IOutputCleanup

Throws:

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

AutomationException - If the ArcObject component throws an exception.