com.esri.arcgis.output
Class JpegExporter

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

All Implemented Interfaces:

IExporter, IExporterPriority, IJpegExporter, IOutputCleanup, IStepProgressorSetup, ISupportErrorInfo, ITrackCancelSetup, java.io.Serializable

public class JpegExporter

extends java.lang.Object

implements IJpegExporter, IExporter, IExporterPriority, ISupportErrorInfo, IOutputCleanup, IStepProgressorSetup, ITrackCancelSetup

Superseded by ExportJPEG. Class used to export maps to JPEG (Joint Photographic Experts Group) format.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

JpegExporter()
Constructs a JpegExporter using ArcGIS Engine.

JpegExporter(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

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.
IExporter	getAsIExporter() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IExporterPriority	getAsIExporterPriority() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IJpegExporter	getAsIJpegExporter() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IOutputCleanup	getAsIOutputCleanup() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IStepProgressorSetup	getAsIStepProgressorSetup() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ISupportErrorInfo	getAsISupportErrorInfo() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ITrackCancelSetup	getAsITrackCancelSetup() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IColor	getBackgroundColor() The background color of the JPEG.
static java.lang.String	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 JPEG.
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	getQuality() The JPEG compression / image quality.
short	getResolution() The Resolution of the Exporter.
short	getWidth() The width of the JPEG.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) Supported Platforms
boolean	isClipToGraphicExtent() Indicates if the Output will be clipped to the Graphics Extent.
void	setBackgroundColor(IColor ppBackgroundColor) The background color of the JPEG.
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	setHeight(short pHeight) The height of the JPEG.
void	setPixelBounds(IEnvelope pixelBounds) The Pixel Bounds of the Exporter.
void	setQuality(short quality) The JPEG compression / image quality.
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 JPEG.
int	startExporting() Initializes the Exporter.

Methods inherited from class java.lang.Object

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

Constructor Detail

JpegExporter

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

Constructs a JpegExporter using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

JpegExporter

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a JpegExporter using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to JpegExporter.
JpegExporter theJpegExporter = (JpegExporter) obj;

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

getAsIJpegExporter

public IJpegExporter getAsIJpegExporter()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIExporter

public IExporter getAsIExporter()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIExporterPriority

public IExporterPriority getAsIExporterPriority()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISupportErrorInfo

public ISupportErrorInfo getAsISupportErrorInfo()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIOutputCleanup

public IOutputCleanup getAsIOutputCleanup()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIStepProgressorSetup

public IStepProgressorSetup getAsIStepProgressorSetup()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsITrackCancelSetup

public ITrackCancelSetup getAsITrackCancelSetup()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

setBackgroundColor

public void setBackgroundColor(IColor ppBackgroundColor)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IJpegExporter

The background color of the JPEG.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBackgroundColor in interface IJpegExporter

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

Description copied from interface: IJpegExporter

The background color of the JPEG.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBackgroundColor in interface IJpegExporter

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

Description copied from interface: IJpegExporter

The width of the JPEG. If width or height is zero, screen size is used.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setWidth in interface IJpegExporter

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

Description copied from interface: IJpegExporter

The width of the JPEG. If width or height is zero, screen size is used.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWidth in interface IJpegExporter

Returns:

The pWidth

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setHeight

public void setHeight(short pHeight)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IJpegExporter

The height of the JPEG. If width or height is zero, screen size is used.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setHeight in interface IJpegExporter

Parameters:

pHeight - The pHeight (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getHeight

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

Description copied from interface: IJpegExporter

The height of the JPEG. If width or height is zero, screen size is used.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getHeight in interface IJpegExporter

Returns:

The pHeight

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setQuality

public void setQuality(short quality)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IJpegExporter

The JPEG compression / image quality.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setQuality in interface IJpegExporter

Parameters:

quality - The quality (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getQuality

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

Description copied from interface: IJpegExporter

The JPEG compression / image quality.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getQuality in interface IJpegExporter

Returns:

The quality

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getName

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

Description copied from interface: IExporter

The Name of the Exporter.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IExporter

Returns:

The name

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getFilter

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

Description copied from interface: IExporter

Filter String used in the CFileDialog class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFilter in interface IExporter

Returns:

The filter

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getFileExtension

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

Description copied from interface: IExporter

File Extension associated with Exporter.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IExporter

The Pixel Bounds of the Exporter.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IExporter

The Pixel Bounds of the Exporter.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IExporter

The Export File Name.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IExporter

The Export File Name.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IExporter

The Resolution of the Exporter.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IExporter

The Resolution of the Exporter.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IExporter

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

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IExporter

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setClipToGraphicExtent in interface IExporter

Parameters:

clipToGraphicsExtent - The clipToGraphicsExtent (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

startExporting

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

Description copied from interface: IExporter

Initializes the Exporter.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IExporter

Shuts down the Exporter.

Supported Platforms

Windows, Solaris, Linux

Specified by:

finishExporting in interface IExporter

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getPriority

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

Description copied from interface: IExporterPriority

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

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: ISupportErrorInfo

Supported Platforms

Windows, Solaris, Linux

Description

Indicates whether the interface supports IErrorInfo.

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

cleanup

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

Description copied from interface: IOutputCleanup

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

cleanup in interface IOutputCleanup

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setStepProgressor

public void setStepProgressor(IStepProgressor rhs1)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IStepProgressorSetup

Updates a Progress Bar.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: ITrackCancelSetup

Reacts to a Cancel.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTrackCancel in interface ITrackCancelSetup

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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