com.esri.arcgis.output
Class ExportPS

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

All Implemented Interfaces:

IOutputRasterSettings, com.esri.arcgis.interop.RemoteObjRef, IExport, IExportColorspaceSettings, IExportPS, IExportPS2, IExportVector, IExportVectorOptions, IExportVectorOptionsEx, ISettingsInRegistry, ISupportErrorInfo, java.io.Serializable

public class ExportPS
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IExportVector, IExportVectorOptions, IExportVectorOptionsEx, IExportPS, IExportPS2, IExport, ISettingsInRegistry, IExportColorspaceSettings, ISupportErrorInfo, IOutputRasterSettings

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

Description 'Class used to export maps to PS (PostScript) and EPS (Encapsulated PostScript) 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.IExportVector

IID, IIDd29aa471_3e7c_41ec_b502_9e888a3d4bcb, xxDummy

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

IID, IID1c16bcac_81dd_4662_a6ab_810a205fc645, xxDummy

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

IID, IIDccf50555_74e3_4f29_9ffe_1fc489d1552c, xxDummy

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

IID, IIDefcd8d47_8d2a_47a4_b35b_15ca74bce73c, xxDummy

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

IID, IID36ce3f37_30c9_4544_afa6_89a7315abce7, xxDummy

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

IID, IID55c11165_0c2d_4e2d_afea_10b4186c4364, xxDummy

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

IID, IIDbb518176_e7e3_420a_9787_ae6e3487eb68, xxDummy

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

IID, IIDc42431dc_237a_4628_996a_39a89af74158, xxDummy

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

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Fields inherited from interface com.esri.arcgis.display.IOutputRasterSettings

IID, IID28444834_e9cb_44f8_806a_d313373f69b8, xxDummy

Constructor Summary

ExportPS()
Constructs a ExportPS using ArcGIS Engine.

ExportPS(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ExportPS theExportPS = (ExportPS) 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.
int	getColorspace() Colorspace option.
int	getEmulsion() The Emulsion setting for the PostScript.
java.lang.String	getExportFileName() The Export File Name.
int	getExportPictureSymbolOptions() Options describing what to do with Picture Symbol on export.
java.lang.String	getFilter() Filter String used in the CFileDialog class.
int	getImage() The Image setting for the PostScript.
int	getImageCompression() The PostScript Image Compression.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
short	getJPEGCompressionQuality() Specifies the raster image quality setting, when JPEG compression is used.
int	getLanguageLevel() The PostScript Language Level.
int	getMaxVertexNumber() Maximum number of vertices in feature.
java.lang.String	getName() The Name of the Exporter.
IEnvelope	getPixelBounds() The Export Bounds in Pixels (The Pixel Bounds of the Export surface).
int	getPriority() Exporter's priority - the order of appearance in the user interface.
int	getResampleRatio() This coefficient states the scale level for the raster when it goes to output.
double	getResolution() The Export Resolution.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isEmbedFonts() The Embed Fonts option.
boolean	isPolygonizeMarkers() Polygonize (represent as vectors instead of fonts) marker symbols option.
void	release() Release a ExportPS.
void	restoreDefault() Restore the default object settings.
void	restoreForCurrentUser(java.lang.String bstrRegPath) Restore object settings.
void	setColorspace(int pcolorspace) Colorspace option.
void	setEmbedFonts(boolean embedFonts) The Embed Fonts option.
void	setEmulsion(int emulsion) The Emulsion setting for the PostScript.
void	setExportFileName(java.lang.String fileName) The Export File Name.
void	setExportPictureSymbolOptions(int opt) Options describing what to do with Picture Symbol on export.
void	setImage(int image) The Image setting for the PostScript.
void	setImageCompression(int compression) The PostScript Image Compression.
void	setJPEGCompressionQuality(short pImageQuality) Specifies the raster image quality setting, when JPEG compression is used.
void	setLanguageLevel(int pslevel) The PostScript Language Level.
void	setMaxVertexNumber(int lMaxVertices) Maximum number of vertices in feature.
void	setPixelBounds(IEnvelope pixelBounds) The Export Bounds in Pixels (The Pixel Bounds of the Export surface).
void	setPolygonizeMarkers(boolean bPolygonizeMarkers) Polygonize (represent as vectors instead of fonts) marker symbols option.
void	setResampleRatio(int pRatio) This coefficient states the scale level for the raster when it goes to output.
void	setResolution(double res) The Export Resolution.
void	setStepProgressorByRef(IStepProgressor rhs1) Export will update a Progress Bar if StepProgressor is not NULL.
void	setTrackCancelByRef(ITrackCancel rhs1) Export will react on Cancel if TrackCancel is not NULL.
int	startExporting() Initializes the Exporter.
void	storeForCurrentUser(java.lang.String bstrRegPath) Store object settings.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExportPS

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

Constructs a ExportPS using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ExportPS

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

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

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

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

Specified by:

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

setPolygonizeMarkers

public void setPolygonizeMarkers(boolean bPolygonizeMarkers)
                          throws java.io.IOException,
                                 AutomationException

Polygonize (represent as vectors instead of fonts) marker symbols option.

Specified by:

setPolygonizeMarkers in interface IExportVectorOptions

Parameters:

bPolygonizeMarkers - The bPolygonizeMarkers (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isPolygonizeMarkers

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

Polygonize (represent as vectors instead of fonts) marker symbols option.

Specified by:

isPolygonizeMarkers in interface IExportVectorOptions

Returns:

The bPolygonizeMarkers

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaxVertexNumber

public void setMaxVertexNumber(int lMaxVertices)
                        throws java.io.IOException,
                               AutomationException

Maximum number of vertices in feature.

Specified by:

setMaxVertexNumber in interface IExportVectorOptions

Parameters:

lMaxVertices - The lMaxVertices (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxVertexNumber

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

Maximum number of vertices in feature.

Specified by:

getMaxVertexNumber in interface IExportVectorOptions

Returns:

The lMaxVertices

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExportPictureSymbolOptions

public void setExportPictureSymbolOptions(int opt)
                                   throws java.io.IOException,
                                          AutomationException

Options describing what to do with Picture Symbol on export.

Specified by:

setExportPictureSymbolOptions in interface IExportVectorOptionsEx

Parameters:

opt - A com.esri.arcgis.display.esriPictureSymbolOptions constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExportPictureSymbolOptions

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

Options describing what to do with Picture Symbol on export.

Specified by:

getExportPictureSymbolOptions in interface IExportVectorOptionsEx

Returns:

A com.esri.arcgis.display.esriPictureSymbolOptions constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEmulsion

public void setEmulsion(int emulsion)
                 throws java.io.IOException,
                        AutomationException

The Emulsion setting for the PostScript.

Specified by:

setEmulsion in interface IExportPS

Parameters:

emulsion - A com.esri.arcgis.output.esriExportPSEmulsion constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEmulsion

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

The Emulsion setting for the PostScript.

Specified by:

getEmulsion in interface IExportPS

Returns:

A com.esri.arcgis.output.esriExportPSEmulsion constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setImage

public void setImage(int image)
              throws java.io.IOException,
                     AutomationException

The Image setting for the PostScript.

Specified by:

setImage in interface IExportPS

Parameters:

image - A com.esri.arcgis.output.esriExportPSImage constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getImage

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

The Image setting for the PostScript.

Specified by:

getImage in interface IExportPS

Returns:

A com.esri.arcgis.output.esriExportPSImage constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLanguageLevel

public void setLanguageLevel(int pslevel)
                      throws java.io.IOException,
                             AutomationException

The PostScript Language Level.

Specified by:

setLanguageLevel in interface IExportPS

Parameters:

pslevel - A com.esri.arcgis.output.esriExportPSLanguageLevel constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLanguageLevel

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

The PostScript Language Level.

Specified by:

getLanguageLevel in interface IExportPS

Returns:

A com.esri.arcgis.output.esriExportPSLanguageLevel constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setImageCompression

public void setImageCompression(int compression)
                         throws java.io.IOException,
                                AutomationException

The PostScript Image Compression.

Specified by:

setImageCompression in interface IExportPS

Parameters:

compression - A com.esri.arcgis.output.esriExportImageCompression constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getImageCompression

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

The PostScript Image Compression.

Specified by:

getImageCompression in interface IExportPS

Returns:

A com.esri.arcgis.output.esriExportImageCompression constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEmbedFonts

public void setEmbedFonts(boolean embedFonts)
                   throws java.io.IOException,
                          AutomationException

The Embed Fonts option.

Specified by:

setEmbedFonts in interface IExportPS

Parameters:

embedFonts - The embedFonts (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEmbedFonts

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

The Embed Fonts option.

Specified by:

isEmbedFonts in interface IExportPS

Returns:

The embedFonts

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setJPEGCompressionQuality

public void setJPEGCompressionQuality(short pImageQuality)
                               throws java.io.IOException,
                                      AutomationException

Specifies the raster image quality setting, when JPEG compression is used.

Specified by:

setJPEGCompressionQuality in interface IExportPS2

Parameters:

pImageQuality - The pImageQuality (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getJPEGCompressionQuality

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

Specifies the raster image quality setting, when JPEG compression is used.

Specified by:

getJPEGCompressionQuality in interface IExportPS2

Returns:

The pImageQuality

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 IExport

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 IExport

Returns:

The filter

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 IExport

Returns:

The pPriority

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStepProgressorByRef

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

Export will update a Progress Bar if StepProgressor is not NULL.

Specified by:

setStepProgressorByRef in interface IExport

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.

setTrackCancelByRef

public void setTrackCancelByRef(ITrackCancel rhs1)
                         throws java.io.IOException,
                                AutomationException

Export will react on Cancel if TrackCancel is not NULL.

Specified by:

setTrackCancelByRef in interface IExport

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.

setPixelBounds

public void setPixelBounds(IEnvelope pixelBounds)
                    throws java.io.IOException,
                           AutomationException

The Export Bounds in Pixels (The Pixel Bounds of the Export surface).

Specified by:

setPixelBounds in interface IExport

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 Export Bounds in Pixels (The Pixel Bounds of the Export surface).

Specified by:

getPixelBounds in interface IExport

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 IExport

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 IExport

Returns:

The fileName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResolution

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

The Export Resolution.

Specified by:

setResolution in interface IExport

Parameters:

res - The res (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getResolution

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

The Export Resolution.

Specified by:

getResolution in interface IExport

Returns:

The res

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 IExport

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 IExport

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 IExport

Throws:

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

AutomationException - If the ArcObject component throws an exception.

restoreForCurrentUser

public void restoreForCurrentUser(java.lang.String bstrRegPath)
                           throws java.io.IOException,
                                  AutomationException

Restore object settings.

Specified by:

restoreForCurrentUser in interface ISettingsInRegistry

Parameters:

bstrRegPath - The bstrRegPath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

storeForCurrentUser

public void storeForCurrentUser(java.lang.String bstrRegPath)
                         throws java.io.IOException,
                                AutomationException

Store object settings.

Specified by:

storeForCurrentUser in interface ISettingsInRegistry

Parameters:

bstrRegPath - The bstrRegPath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

restoreDefault

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

Restore the default object settings.

Specified by:

restoreDefault in interface ISettingsInRegistry

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setColorspace

public void setColorspace(int pcolorspace)
                   throws java.io.IOException,
                          AutomationException

Colorspace option.

Specified by:

setColorspace in interface IExportColorspaceSettings

Parameters:

pcolorspace - A com.esri.arcgis.output.esriExportColorspace constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColorspace

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

Colorspace option.

Specified by:

getColorspace in interface IExportColorspaceSettings

Returns:

A com.esri.arcgis.output.esriExportColorspace constant

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.

getResampleRatio

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

This coefficient states the scale level for the raster when it goes to output. 1 means 1:1; 2 means 1:2, i.e. 2 times less than the output quality.

Specified by:

getResampleRatio in interface IOutputRasterSettings

Returns:

The pRatio

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResampleRatio

public void setResampleRatio(int pRatio)
                      throws java.io.IOException,
                             AutomationException

This coefficient states the scale level for the raster when it goes to output. 1 means 1:1; 2 means 1:2, i.e. 2 times less than the output quality.

Specified by:

setResampleRatio in interface IOutputRasterSettings

Parameters:

pRatio - The pRatio (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.