com.esri.arcgis.output
Class TiffExporter

java.lang.Object
  extended by com.esri.arcgis.output.TiffExporter
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IExporter, IExporter2, IExporterPriority, IOutputCleanup, IStepProgressorSetup, ITiffExporter, ITrackCancelSetup, IWorldFileSettings, ISupportErrorInfo, java.io.Serializable

public class TiffExporter
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IExporter, IExporter2, ISupportErrorInfo, ITiffExporter, IExporterPriority, IOutputCleanup, IStepProgressorSetup, ITrackCancelSetup, IWorldFileSettings

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

Description 'Superseded by ExportTIFF. Class used to export maps to TIFF (Tag Image File 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.IExporter
IID, IID7d4881e2_57c6_11d1_945e_080009eebecb, xxDummy
 
Fields inherited from interface com.esri.arcgis.output.IExporter2
IID, IIDb87ad35e_1242_4c30_b67f_ff3cfa2f1928, 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.ITiffExporter
IID, IID71001418_565a_4588_90b7_3ffb04b74be7, 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
 
Fields inherited from interface com.esri.arcgis.output.IWorldFileSettings
IID, IID27bf29ca_71a8_422a_a66d_ff875a9de13b, xxDummy
 
Constructor Summary
TiffExporter()
          Constructs a TiffExporter using ArcGIS Engine.
TiffExporter(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TiffExporter theTiffExporter = (TiffExporter) 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.
 IColor getBackgroundColor()
          The background color of the TIFF.
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.
 short getHeight()
          The height of the TIFF.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 IEnvelope getMapExtent()
          The Map Extent.
 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.
 short getWidth()
          The width of the TIFF.
 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 isOutputWorldFile()
          Indicates if a World File will be created.
 void release()
          Release a TiffExporter.
 void setBackgroundColor(IColor ppBackgroundColor)
          The background color of the TIFF.
 void setClipToGraphicExtent(boolean clipToGraphicsExtent)
          Indicates if the Output will be clipped to the Graphics Extent.
 void setExportExtentByRef(IEnvelope rhs1)
          The Export Extent.
 void setExportFileName(java.lang.String fileName)
          The Export File Name.
 void setHeight(short pHeight)
          The height of the TIFF.
 void setMapExtent(IEnvelope mapExtent)
          The Map Extent.
 void setOutputWorldFile(boolean outputWorldFile)
          Indicates if a World File will be created.
 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.
 void setWidth(short pWidth)
          The width of the TIFF.
 int startExporting()
          Initializes the Exporter.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TiffExporter

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

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

TiffExporter

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

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

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

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

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
The Name of the Exporter.

Specified by:
getName in interface IExporter
Specified by:
getName in interface IExporter2
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
Specified by:
getFilter in interface IExporter2
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
Specified by:
getFileExtension in interface IExporter2
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
Specified by:
setPixelBounds in interface IExporter2
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
Specified by:
getPixelBounds in interface IExporter2
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
Specified by:
setExportFileName in interface IExporter2
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
Specified by:
getExportFileName in interface IExporter2
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
Specified by:
getResolution in interface IExporter2
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
Specified by:
setResolution in interface IExporter2
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
Specified by:
isClipToGraphicExtent in interface IExporter2
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
Specified by:
setClipToGraphicExtent in interface IExporter2
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
Specified by:
startExporting in interface IExporter2
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
Specified by:
finishExporting in interface IExporter2
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExportExtentByRef

public void setExportExtentByRef(IEnvelope rhs1)
                          throws java.io.IOException,
                                 AutomationException
The Export Extent.

Specified by:
setExportExtentByRef in interface IExporter2
Parameters:
rhs1 - 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.

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.

setBackgroundColor

public void setBackgroundColor(IColor ppBackgroundColor)
                        throws java.io.IOException,
                               AutomationException
The background color of the TIFF.

Specified by:
setBackgroundColor in interface ITiffExporter
Parameters:
ppBackgroundColor - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

public IColor getBackgroundColor()
                          throws java.io.IOException,
                                 AutomationException
The background color of the TIFF.

Specified by:
getBackgroundColor in interface ITiffExporter
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWidth

public void setWidth(short pWidth)
              throws java.io.IOException,
                     AutomationException
The width of the TIFF. If width or height is zero, screen size is used.

Specified by:
setWidth in interface ITiffExporter
Parameters:
pWidth - The pWidth (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWidth

public short getWidth()
               throws java.io.IOException,
                      AutomationException
The width of the TIFF. If width or height is zero, screen size is used.

Specified by:
getWidth in interface ITiffExporter
Returns:
The pWidth
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHeight

public void setHeight(short pHeight)
               throws java.io.IOException,
                      AutomationException
The height of the TIFF. If width or height is zero, screen size is used.

Specified by:
setHeight in interface ITiffExporter
Parameters:
pHeight - The pHeight (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHeight

public short getHeight()
                throws java.io.IOException,
                       AutomationException
The height of the TIFF. If width or height is zero, screen size is used.

Specified by:
getHeight in interface ITiffExporter
Returns:
The pHeight
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.

setMapExtent

public void setMapExtent(IEnvelope mapExtent)
                  throws java.io.IOException,
                         AutomationException
The Map Extent.

Specified by:
setMapExtent in interface IWorldFileSettings
Parameters:
mapExtent - 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.

getMapExtent

public IEnvelope getMapExtent()
                       throws java.io.IOException,
                              AutomationException
The Map Extent.

Specified by:
getMapExtent in interface IWorldFileSettings
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.

setOutputWorldFile

public void setOutputWorldFile(boolean outputWorldFile)
                        throws java.io.IOException,
                               AutomationException
Indicates if a World File will be created.

Specified by:
setOutputWorldFile in interface IWorldFileSettings
Parameters:
outputWorldFile - The outputWorldFile (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOutputWorldFile

public boolean isOutputWorldFile()
                          throws java.io.IOException,
                                 AutomationException
Indicates if a World File will be created.

Specified by:
isOutputWorldFile in interface IWorldFileSettings
Returns:
The outputWorldFile
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.