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, Serializable

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

Superseded by ExportTIFF. Class used to export maps to TIFF (Tag Image File Format).

Superseded By

ExportTIFF

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
TiffExporter()
          Constructs a TiffExporter using ArcGIS Engine.
TiffExporter(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(Object o)
          Compare this object with another
 void finishExporting()
          Shuts down the Exporter.
 IColor getBackgroundColor()
          The background color of the TIFF.
static String getClsid()
          getClsid.
 String getExportFileName()
          The Export File Name.
 String getFileExtension()
          File Extension associated with Exporter.
 String getFilter()
          Filter String used in the CFileDialog class.
 short getHeight()
          The height of the TIFF.
 IEnvelope getMapExtent()
          The Map Extent.
 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 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(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
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

TiffExporter

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

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

TiffExporter

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

setExportExtentByRef

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

Product Availability

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

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

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.

setBackgroundColor

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getBackgroundColor

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setWidth

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getWidth

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setHeight

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getHeight

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

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.

setMapExtent

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getMapExtent

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

Remarks

The MapExtent property holds the envelope that will be used during creation of a world file or writing of a GeoTIFF header. Get the map extent envelope from the Extent property IActiveView on a Map object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setOutputWorldFile

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isOutputWorldFile

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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