com.esri.arcgis.output
Class AIExporter

java.lang.Object
  extended by com.esri.arcgis.output.AIExporter
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IAIExporter, IExporter, IExporterPriority, IOutputCleanup, IStepProgressorSetup, ITrackCancelSetup, java.io.Serializable

public class AIExporter
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IAIExporter, IExporter, IExporterPriority, IOutputCleanup, IStepProgressorSetup, ITrackCancelSetup

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

Description 'Superseded by ExportAI. Class used to export maps to AI (Adobe Illustrator) 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.IAIExporter
IID, IID722a2714_cd07_4c68_b07a_86a8d7b925e3, 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.output.IOutputCleanup
IID, IID2b8765ec_8808_474c_8fd3_869d08df20f6, xxDummy
 
Fields inherited from interface com.esri.arcgis.output.IStepProgressorSetup
IID, IID1c538193_8806_489c_8a79_4b54c8c18b37, xxDummy
 
Fields inherited from interface com.esri.arcgis.output.ITrackCancelSetup
IID, IID5e091c46_d015_471f_8187_f774c7ad9d48, xxDummy
 
Constructor Summary
AIExporter()
          Constructs a AIExporter using ArcGIS Engine.
AIExporter(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AIExporter theAIExporter = (AIExporter) 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 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.
 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
 boolean isClipToGraphicExtent()
          Indicates if the Output will be clipped to the Graphics Extent.
 IAIDriver queryAIDriver()
          Returns Interface IAIDriver.
 void release()
          Release a AIExporter.
 void setClipToGraphicExtent(boolean clipToGraphicsExtent)
          Indicates if the Output will be clipped to the Graphics Extent.
 void setExportFileName(java.lang.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 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
 

Constructor Detail

AIExporter

public AIExporter()
           throws java.io.IOException,
                  java.net.UnknownHostException
Constructs a AIExporter using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

AIExporter

public AIExporter(java.lang.Object obj)
           throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AIExporter theAIExporter = (AIExporter) obj;

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

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 AIExporter.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

queryAIDriver

public IAIDriver queryAIDriver()
                        throws java.io.IOException,
                               AutomationException
Returns Interface IAIDriver.

Specified by:
queryAIDriver in interface IAIExporter
Returns:
A reference to a com.esri.arcgis.output.IAIDriver
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.

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.

setStepProgressor

public void setStepProgressor(IStepProgressor rhs1)
                       throws java.io.IOException,
                              AutomationException
Updates a Progress Bar.

Specified by:
setStepProgressor in interface IStepProgressorSetup
Parameters:
rhs1 - A reference to a com.esri.arcgis.system.IStepProgressor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTrackCancel

public void setTrackCancel(ITrackCancel rhs1)
                    throws java.io.IOException,
                           AutomationException
Reacts to a Cancel.

Specified by:
setTrackCancel in interface ITrackCancelSetup
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.