com.esri.arcgis.output
Class PsPrinter

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IColorCorrection, IFontMapEnvironment, IOutputCleanup, IPrinter, IPrinterMPage, IPSDriver, IPSDriver2, IPsPrinter, ISpotPlateCollection, ITrackCancelSetup, IClone, IPersist, IPersistStream, ISupportErrorInfo, Externalizable, Serializable

public class PsPrinter
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPsPrinter, IPrinter, IPrinterMPage, IPSDriver, IPSDriver2, ISpotPlateCollection, IColorCorrection, IFontMapEnvironment, IPersistStream, IClone, ISupportErrorInfo, IOutputCleanup, ITrackCancelSetup, Externalizable

Class used to print maps with the PostScript Printer Driver.

Product Availability

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

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

PsPrinter()
Constructs a PsPrinter using ArcGIS Engine.

PsPrinter(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PsPrinter thePsPrinter = (PsPrinter) obj;

Method Summary

void	add(ISpotPlate spotPlate) Add an ISpotPlate to the Spot Plate collection.
void	assign(IClone src) Assigns the properties of src to the receiver.
void	cleanup() Cleanup should clean all temporary files, free used memory, etc...
void	createPS(String inputFileName, String outputFileName) Converts the EMF file to a EPS File.
boolean	doesDriverSupportPrinter(String printerName) Indicates if the Printer Name passed into function is supported by the IPrinter Driver.
void	endMapDocument() End map document.
void	endPage() Finalize current page output.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	finishPrinting() Finish up Printing.
String	getApplyDefaultMappingDesc() The Font Mapping checkbox description string.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
short	getCMYKCorrection(int dataType, int index) The Color Correction for the CMYK color model.
short	getCopies() The number of copies.
int	getCount() The count of the Spot Plate collection.
String	getDefaultMapping() The Default Font Mapping string.
Object	getDefaultMappingsChoices() The Default Mapping Choices for Font Substitution.
String	getDriverName() The name of Windows Printer Driver.
int	getEmulsion() The Emulsion setting for the PostScript Driver.
String	getFileExtension() File Extension associated with the Printer Driver.
String	getFilter() Filter used in CFileDialog.
IFontMapCollection	getFontMapCollection() The Font Map Collection for Font Mapping.
String	getFormName() The printer page form.
int	getHalfTone(int halfTone) The Halftone DPI / LPI.
int	getImage() The Image setting (Positive or Negative) for the PostScript Driver.
int	getImageCompression() The Image Compression of the PostScript Driver.
short	getLightness(int dataType) The Lightness Value of the HLS Color Model.
short	getMarks() The PostScript Marks.
String	getName() Name of the IPrinter Driver.
short	getOrientation() The printer page orientation (1 = portrait.
IPaper	getPaper() The IPaper interface.
String	getPPDFile() The PPD file for the PostScript file.
IEnvelope	getPrintableBounds() The area of the printer page that can be printed on.
String	getPrintToFile() The name of file if saving to Disk.
int	getPSLanguageLevel() The PostScript Driver Language Level.
short	getResolution() The Printer Driver Resolution.
short	getSaturation(int dataType) The Saturation Value of the HLS Color Model.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
String	getSpoolFileName() The Spool File Name which shows up in the Print Manager.
ISpotPlate	getSpotPlate(int index) An ISpotPlate from the Spot Plate collection.
short	getSupportedColorCorrections() The dataType supported: 1 Total, 2 Raster, 4 Vector.
short	getUnderColorRemoval(int dataType) The Undercolor Removal Value.
int	getUnits() The units for PaperSize and PrintableBounds.
int	hashCode() the hashcode for this object
void	insert(int index, ISpotPlate spotPlate) Insert an ISpotPlate into the Spot Plate collection at position index.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isArcPressSeparateImage() Indicates whether a separate Image file should be created for ArcPress.
boolean	isArcPressSeparateImageRotate() Indicates whether the Image should be rotated 90 degress for ArcPress.
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isOneBitImageTransparency() Indicates if the 1-bit Image Transparency setting for the PostScript Driver is set to true.
boolean	isSaveMappings() Indicates whether to save font mappings.
boolean	isUseEMFFrameBoxForPSBoundingBox() Indicates whether the PostScript Driver should use the ENHMETAHEADER rclFrame instead of rclBounds for the PostScript Bounding Box.
void	load(IStream pstm) load
void	queryPaperSize(double[] width, double[] height) Returns Page Size for Printer.
void	readExternal(ObjectInput in)
void	remove(int index) Remove ISpotPlate at index from the Spot Plate collection.
void	removeAll() Remove all ISpotPlates from the Spot Plate collection.
void	save(IStream pstm, int fClearDirty) save
void	setApplyDefaultMappingDesc(String applyDefaultMappingDesc) The Font Mapping checkbox description string.
void	setArcPressSeparateImage(boolean sepImage) Indicates whether a separate Image file should be created for ArcPress.
void	setArcPressSeparateImageRotate(boolean sepImage) Indicates whether the Image should be rotated 90 degress for ArcPress.
void	setCMYKCorrection(int dataType, int index, short val) The Color Correction for the CMYK color model.
void	setCopies(short copies) The number of copies.
void	setDefaultMapping(String defaultMapping) The Default Font Mapping string.
void	setDefaultMappingsChoices(Object defaultMappingChoices) The Default Mapping Choices for Font Substitution.
void	setEmulsion(int emulsion) The Emulsion setting for the PostScript Driver.
void	setFontMapCollectionByRef(IFontMapCollection fontMapCollection) The Font Map Collection for Font Mapping.
void	setFormName(String formName) The printer page form.
void	setHalfTone(int halfTone, int value) The Halftone DPI / LPI.
void	setImage(int image) The Image setting (Positive or Negative) for the PostScript Driver.
void	setImageCompression(int imageCompression) The Image Compression of the PostScript Driver.
void	setLightness(int dataType, short val) The Lightness Value of the HLS Color Model.
void	setMarks(short marks) The PostScript Marks.
void	setOneBitImageTransparency(boolean imageTransparency) Indicates if the 1-bit Image Transparency setting for the PostScript Driver is set to true.
void	setOrientation(short orientation) The printer page orientation (1 = portrait.
void	setPaperByRef(IPaper paper) The IPaper interface.
void	setPPDFile(String pPDFile) The PPD file for the PostScript file.
void	setPrintableBounds(IEnvelope ppBounds) The printers Printable Bounds - Used for Marks.
void	setPrintToFile(String fileName) The name of file if saving to Disk.
void	setPSLanguageLevel(int pslevel) The PostScript Driver Language Level.
void	setResolution(short res) The Printer Driver Resolution.
void	setSaturation(int dataType, short val) The Saturation Value of the HLS Color Model.
void	setSaveMappings(boolean saveMappings) Indicates whether to save font mappings.
void	setSpoolFileName(String spoolFileName) The Spool File Name which shows up in the Print Manager.
void	setStepProgressor(IStepProgressor rhs1) Updates a Progress Bar is set.
void	setTrackCancel(ITrackCancel rhs1) Reacts to a Cancel.
void	setUnderColorRemoval(int dataType, short val) The Undercolor Removal Value.
void	setUseEMFFrameBoxForPSBoundingBox(boolean useFrameBox) Indicates whether the PostScript Driver should use the ENHMETAHEADER rclFrame instead of rclBounds for the PostScript Bounding Box.
void	startMapDocument() Begin map document.
int	startPage(IEnvelope pixelBounds, int hDcPrinter) Start new page output.
int	startPrinting(IEnvelope pixelBounds, int hDcPrinter) Initialize Printing.
boolean	verifyDriverSettings() Indicates if the Printer Driver should validate Printer Driver's local settings.
void	writeExternal(ObjectOutput out)

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

PsPrinter

public PsPrinter()
          throws IOException,
                 UnknownHostException

Constructs a PsPrinter using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

PsPrinter

public PsPrinter(Object obj)
          throws IOException

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

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

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

setPPDFile

public void setPPDFile(String pPDFile)
                throws IOException,
                       AutomationException

The PPD file for the PostScript file.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPPDFile in interface IPSDriver

Specified by:

setPPDFile in interface IPSDriver2

Specified by:

setPPDFile in interface IPsPrinter

Parameters:

pPDFile - The pPDFile (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPPDFile

public String getPPDFile()
                  throws IOException,
                         AutomationException

The PPD file for the PostScript file.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPPDFile in interface IPSDriver

Specified by:

getPPDFile in interface IPSDriver2

Specified by:

getPPDFile in interface IPsPrinter

Returns:

The pPDFile

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the IPrinter Driver.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IPrinter

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 used in CFileDialog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFilter in interface IPrinter

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 the Printer Driver.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFileExtension in interface IPrinter

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPrintToFile

public void setPrintToFile(String fileName)
                    throws IOException,
                           AutomationException

The name of file if saving to Disk.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPrintToFile in interface IPrinter

Parameters:

fileName - The fileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPrintToFile

public String getPrintToFile()
                      throws IOException,
                             AutomationException

The name of file if saving to Disk.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPrintToFile in interface IPrinter

Returns:

The fileName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDriverName

public String getDriverName()
                     throws IOException,
                            AutomationException

The name of Windows Printer Driver.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDriverName in interface IPrinter

Returns:

The driverName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpoolFileName

public void setSpoolFileName(String spoolFileName)
                      throws IOException,
                             AutomationException

The Spool File Name which shows up in the Print Manager.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSpoolFileName in interface IPrinter

Parameters:

spoolFileName - The spoolFileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpoolFileName

public String getSpoolFileName()
                        throws IOException,
                               AutomationException

The Spool File Name which shows up in the Print Manager.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSpoolFileName in interface IPrinter

Returns:

The spoolFileName

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 Printer Driver Resolution.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setResolution in interface IPrinter

Parameters:

res - The res (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResolution

public short getResolution()
                    throws IOException,
                           AutomationException

The Printer Driver Resolution.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getResolution in interface IPrinter

Returns:

The res

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 is set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setStepProgressor in interface IPrinter

Specified by:

setStepProgressor in interface IPSDriver

Specified by:

setStepProgressor in interface IPSDriver2

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.

setPaperByRef

public void setPaperByRef(IPaper paper)
                   throws IOException,
                          AutomationException

The IPaper interface.

Product Availability

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

Specified by:

setPaperByRef in interface IPrinter

Parameters:

paper - A reference to a com.esri.arcgis.output.IPaper (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPaper

public IPaper getPaper()
                throws IOException,
                       AutomationException

The IPaper interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPaper in interface IPrinter

Returns:

A reference to a com.esri.arcgis.output.IPaper

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryPaperSize

public void queryPaperSize(double[] width,
                           double[] height)
                    throws IOException,
                           AutomationException

Returns Page Size for Printer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryPaperSize in interface IPrinter

Parameters:

width - The width (out: use single element array)

height - The height (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPrintableBounds

public IEnvelope getPrintableBounds()
                             throws IOException,
                                    AutomationException

The area of the printer page that can be printed on.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPrintableBounds in interface IPrinter

Specified by:

getPrintableBounds in interface IPSDriver

Specified by:

getPrintableBounds in interface IPSDriver2

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.

getUnits

public int getUnits()
             throws IOException,
                    AutomationException

The units for PaperSize and PrintableBounds.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getUnits in interface IPrinter

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

verifyDriverSettings

public boolean verifyDriverSettings()
                             throws IOException,
                                    AutomationException

Indicates if the Printer Driver should validate Printer Driver's local settings.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

verifyDriverSettings in interface IPrinter

Returns:

The ok

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

doesDriverSupportPrinter

public boolean doesDriverSupportPrinter(String printerName)
                                 throws IOException,
                                        AutomationException

Indicates if the Printer Name passed into function is supported by the IPrinter Driver.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

doesDriverSupportPrinter in interface IPrinter

Parameters:

printerName - The printerName (in)

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startPrinting

public int startPrinting(IEnvelope pixelBounds,
                         int hDcPrinter)
                  throws IOException,
                         AutomationException

Initialize Printing.

Remarks

The StartPrinting method returns a long that represents the hDC (Windows GDI Device Context handle) of the printer object. After this method is called, the printer object is ready to receive GDI draw instructions directed to its hDC.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

startPrinting in interface IPrinter

Parameters:

pixelBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

hDcPrinter - The hDcPrinter (A COM typedef) (in)

Returns:

The hDcRet (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

finishPrinting

public void finishPrinting()
                    throws IOException,
                           AutomationException

Finish up Printing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

finishPrinting in interface IPrinter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startMapDocument

public void startMapDocument()
                      throws IOException,
                             AutomationException

Begin map document. Document consists of one or more pages.

Product Availability

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

Specified by:

startMapDocument in interface IPrinterMPage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startPage

public int startPage(IEnvelope pixelBounds,
                     int hDcPrinter)
              throws IOException,
                     AutomationException

Start new page output.

Product Availability

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

Specified by:

startPage in interface IPrinterMPage

Parameters:

pixelBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

hDcPrinter - The hDcPrinter (A COM typedef) (in)

Returns:

The hDcRet (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

endPage

public void endPage()
             throws IOException,
                    AutomationException

Finalize current page output.

Product Availability

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

Specified by:

endPage in interface IPrinterMPage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

endMapDocument

public void endMapDocument()
                    throws IOException,
                           AutomationException

End map document.

Product Availability

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

Specified by:

endMapDocument in interface IPrinterMPage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImageCompression

public int getImageCompression()
                        throws IOException,
                               AutomationException

The Image Compression of the PostScript Driver.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getImageCompression in interface IPSDriver

Specified by:

getImageCompression in interface IPSDriver2

Returns:

A com.esri.arcgis.output.esriPSDriverImageCompression constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setImageCompression

public void setImageCompression(int imageCompression)
                         throws IOException,
                                AutomationException

The Image Compression of the PostScript Driver.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setImageCompression in interface IPSDriver

Specified by:

setImageCompression in interface IPSDriver2

Parameters:

imageCompression - A com.esri.arcgis.output.esriPSDriverImageCompression constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isArcPressSeparateImage

public boolean isArcPressSeparateImage()
                                throws IOException,
                                       AutomationException

Indicates whether a separate Image file should be created for ArcPress.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isArcPressSeparateImage in interface IPSDriver

Specified by:

isArcPressSeparateImage in interface IPSDriver2

Returns:

The sepImage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setArcPressSeparateImage

public void setArcPressSeparateImage(boolean sepImage)
                              throws IOException,
                                     AutomationException

Indicates whether a separate Image file should be created for ArcPress.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setArcPressSeparateImage in interface IPSDriver

Specified by:

setArcPressSeparateImage in interface IPSDriver2

Parameters:

sepImage - The sepImage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isArcPressSeparateImageRotate

public boolean isArcPressSeparateImageRotate()
                                      throws IOException,
                                             AutomationException

Indicates whether the Image should be rotated 90 degress for ArcPress.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isArcPressSeparateImageRotate in interface IPSDriver

Specified by:

isArcPressSeparateImageRotate in interface IPSDriver2

Returns:

The sepImage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setArcPressSeparateImageRotate

public void setArcPressSeparateImageRotate(boolean sepImage)
                                    throws IOException,
                                           AutomationException

Indicates whether the Image should be rotated 90 degress for ArcPress.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setArcPressSeparateImageRotate in interface IPSDriver

Specified by:

setArcPressSeparateImageRotate in interface IPSDriver2

Parameters:

sepImage - The sepImage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFontMapCollection

public IFontMapCollection getFontMapCollection()
                                        throws IOException,
                                               AutomationException

The Font Map Collection for Font Mapping.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFontMapCollection in interface IFontMapEnvironment

Specified by:

getFontMapCollection in interface IPSDriver

Specified by:

getFontMapCollection in interface IPSDriver2

Returns:

A reference to a com.esri.arcgis.output.IFontMapCollection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFontMapCollectionByRef

public void setFontMapCollectionByRef(IFontMapCollection fontMapCollection)
                               throws IOException,
                                      AutomationException

The Font Map Collection for Font Mapping.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFontMapCollectionByRef in interface IPSDriver

Specified by:

setFontMapCollectionByRef in interface IPSDriver2

Parameters:

fontMapCollection - A reference to a com.esri.arcgis.output.IFontMapCollection (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMarks

public short getMarks()
               throws IOException,
                      AutomationException

The PostScript Marks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMarks in interface IPSDriver

Specified by:

getMarks in interface IPSDriver2

Returns:

The marks

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMarks

public void setMarks(short marks)
              throws IOException,
                     AutomationException

The PostScript Marks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMarks in interface IPSDriver

Specified by:

setMarks in interface IPSDriver2

Parameters:

marks - The marks (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHalfTone

public int getHalfTone(int halfTone)
                throws IOException,
                       AutomationException

The Halftone DPI / LPI.

Product Availability

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

Specified by:

getHalfTone in interface IPSDriver

Specified by:

getHalfTone in interface IPSDriver2

Parameters:

halfTone - A com.esri.arcgis.output.esriPSDriverHalfTone constant (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHalfTone

public void setHalfTone(int halfTone,
                        int value)
                 throws IOException,
                        AutomationException

The Halftone DPI / LPI.

Product Availability

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

Specified by:

setHalfTone in interface IPSDriver

Specified by:

setHalfTone in interface IPSDriver2

Parameters:

halfTone - A com.esri.arcgis.output.esriPSDriverHalfTone constant (in)

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFormName

public String getFormName()
                   throws IOException,
                          AutomationException

The printer page form. Use Win32 DMPAPER_xxx constants.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFormName in interface IPSDriver

Specified by:

getFormName in interface IPSDriver2

Returns:

The formName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFormName

public void setFormName(String formName)
                 throws IOException,
                        AutomationException

The printer page form. Use Win32 DMPAPER_xxx constants.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFormName in interface IPSDriver

Specified by:

setFormName in interface IPSDriver2

Parameters:

formName - The formName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPrintableBounds

public void setPrintableBounds(IEnvelope ppBounds)
                        throws IOException,
                               AutomationException

The printers Printable Bounds - Used for Marks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPrintableBounds in interface IPSDriver

Specified by:

setPrintableBounds in interface IPSDriver2

Parameters:

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

getOrientation

public short getOrientation()
                     throws IOException,
                            AutomationException

The printer page orientation (1 = portrait. 2 = landscape).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOrientation in interface IPSDriver

Specified by:

getOrientation in interface IPSDriver2

Returns:

The orientation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOrientation

public void setOrientation(short orientation)
                    throws IOException,
                           AutomationException

The printer page orientation (1 = portrait. 2 = landscape).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOrientation in interface IPSDriver

Specified by:

setOrientation in interface IPSDriver2

Parameters:

orientation - The orientation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEmulsion

public int getEmulsion()
                throws IOException,
                       AutomationException

The Emulsion setting for the PostScript Driver.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getEmulsion in interface IPSDriver

Specified by:

getEmulsion in interface IPSDriver2

Returns:

A com.esri.arcgis.output.esriPSDriverEmulsion constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEmulsion

public void setEmulsion(int emulsion)
                 throws IOException,
                        AutomationException

The Emulsion setting for the PostScript Driver.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setEmulsion in interface IPSDriver

Specified by:

setEmulsion in interface IPSDriver2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImage

public int getImage()
             throws IOException,
                    AutomationException

The Image setting (Positive or Negative) for the PostScript Driver.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getImage in interface IPSDriver

Specified by:

getImage in interface IPSDriver2

Returns:

A com.esri.arcgis.output.esriPSDriverImage constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setImage

public void setImage(int image)
              throws IOException,
                     AutomationException

The Image setting (Positive or Negative) for the PostScript Driver.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setImage in interface IPSDriver

Specified by:

setImage in interface IPSDriver2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOneBitImageTransparency

public boolean isOneBitImageTransparency()
                                  throws IOException,
                                         AutomationException

Indicates if the 1-bit Image Transparency setting for the PostScript Driver is set to true.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isOneBitImageTransparency in interface IPSDriver

Specified by:

isOneBitImageTransparency in interface IPSDriver2

Returns:

The imageTransparency

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOneBitImageTransparency

public void setOneBitImageTransparency(boolean imageTransparency)
                                throws IOException,
                                       AutomationException

Indicates if the 1-bit Image Transparency setting for the PostScript Driver is set to true.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOneBitImageTransparency in interface IPSDriver

Specified by:

setOneBitImageTransparency in interface IPSDriver2

Parameters:

imageTransparency - The imageTransparency (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseEMFFrameBoxForPSBoundingBox

public boolean isUseEMFFrameBoxForPSBoundingBox()
                                         throws IOException,
                                                AutomationException

Indicates whether the PostScript Driver should use the ENHMETAHEADER rclFrame instead of rclBounds for the PostScript Bounding Box.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isUseEMFFrameBoxForPSBoundingBox in interface IPSDriver

Specified by:

isUseEMFFrameBoxForPSBoundingBox in interface IPSDriver2

Returns:

The useFrameBox

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseEMFFrameBoxForPSBoundingBox

public void setUseEMFFrameBoxForPSBoundingBox(boolean useFrameBox)
                                       throws IOException,
                                              AutomationException

Indicates whether the PostScript Driver should use the ENHMETAHEADER rclFrame instead of rclBounds for the PostScript Bounding Box.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUseEMFFrameBoxForPSBoundingBox in interface IPSDriver

Specified by:

setUseEMFFrameBoxForPSBoundingBox in interface IPSDriver2

Parameters:

useFrameBox - The useFrameBox (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPSLanguageLevel

public int getPSLanguageLevel()
                       throws IOException,
                              AutomationException

The PostScript Driver Language Level.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPSLanguageLevel in interface IPSDriver

Specified by:

getPSLanguageLevel in interface IPSDriver2

Returns:

A com.esri.arcgis.output.esriPSDriverPSLanguageLevel constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPSLanguageLevel

public void setPSLanguageLevel(int pslevel)
                        throws IOException,
                               AutomationException

The PostScript Driver Language Level.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPSLanguageLevel in interface IPSDriver

Specified by:

setPSLanguageLevel in interface IPSDriver2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createPS

public void createPS(String inputFileName,
                     String outputFileName)
              throws IOException,
                     AutomationException

Converts the EMF file to a EPS File.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

createPS in interface IPSDriver

Specified by:

createPS in interface IPSDriver2

Parameters:

inputFileName - The inputFileName (in)

outputFileName - The outputFileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCopies

public short getCopies()
                throws IOException,
                       AutomationException

The number of copies.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCopies in interface IPSDriver2

Returns:

The copies

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCopies

public void setCopies(short copies)
               throws IOException,
                      AutomationException

The number of copies.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCopies in interface IPSDriver2

Parameters:

copies - The copies (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException

The count of the Spot Plate collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCount in interface ISpotPlateCollection

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpotPlate

public ISpotPlate getSpotPlate(int index)
                        throws IOException,
                               AutomationException

An ISpotPlate from the Spot Plate collection.

Product Availability

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

Specified by:

getSpotPlate in interface ISpotPlateCollection

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.output.ISpotPlate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

public void add(ISpotPlate spotPlate)
         throws IOException,
                AutomationException

Add an ISpotPlate to the Spot Plate collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

add in interface ISpotPlateCollection

Parameters:

spotPlate - A reference to a com.esri.arcgis.output.ISpotPlate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

public void insert(int index,
                   ISpotPlate spotPlate)
            throws IOException,
                   AutomationException

Insert an ISpotPlate into the Spot Plate collection at position index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

insert in interface ISpotPlateCollection

Parameters:

index - The index (in)

spotPlate - A reference to a com.esri.arcgis.output.ISpotPlate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(int index)
            throws IOException,
                   AutomationException

Remove ISpotPlate at index from the Spot Plate collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

remove in interface ISpotPlateCollection

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws IOException,
                      AutomationException

Remove all ISpotPlates from the Spot Plate collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

removeAll in interface ISpotPlateCollection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSupportedColorCorrections

public short getSupportedColorCorrections()
                                   throws IOException,
                                          AutomationException

The dataType supported: 1 Total, 2 Raster, 4 Vector.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSupportedColorCorrections in interface IColorCorrection

Returns:

The val

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLightness

public short getLightness(int dataType)
                   throws IOException,
                          AutomationException

The Lightness Value of the HLS Color Model.

Product Availability

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

Specified by:

getLightness in interface IColorCorrection

Parameters:

dataType - A com.esri.arcgis.output.esriColorCorrectionDataType constant (in)

Returns:

The val

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLightness

public void setLightness(int dataType,
                         short val)
                  throws IOException,
                         AutomationException

The Lightness Value of the HLS Color Model.

Product Availability

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

Specified by:

setLightness in interface IColorCorrection

Parameters:

dataType - A com.esri.arcgis.output.esriColorCorrectionDataType constant (in)

val - The val (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSaturation

public short getSaturation(int dataType)
                    throws IOException,
                           AutomationException

The Saturation Value of the HLS Color Model.

Product Availability

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

Specified by:

getSaturation in interface IColorCorrection

Parameters:

dataType - A com.esri.arcgis.output.esriColorCorrectionDataType constant (in)

Returns:

The val

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSaturation

public void setSaturation(int dataType,
                          short val)
                   throws IOException,
                          AutomationException

The Saturation Value of the HLS Color Model.

Product Availability

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

Specified by:

setSaturation in interface IColorCorrection

Parameters:

dataType - A com.esri.arcgis.output.esriColorCorrectionDataType constant (in)

val - The val (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUnderColorRemoval

public short getUnderColorRemoval(int dataType)
                           throws IOException,
                                  AutomationException

The Undercolor Removal Value.

Product Availability

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

Specified by:

getUnderColorRemoval in interface IColorCorrection

Parameters:

dataType - A com.esri.arcgis.output.esriColorCorrectionDataType constant (in)

Returns:

The val

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUnderColorRemoval

public void setUnderColorRemoval(int dataType,
                                 short val)
                          throws IOException,
                                 AutomationException

The Undercolor Removal Value.

Product Availability

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

Specified by:

setUnderColorRemoval in interface IColorCorrection

Parameters:

dataType - A com.esri.arcgis.output.esriColorCorrectionDataType constant (in)

val - The val (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCMYKCorrection

public short getCMYKCorrection(int dataType,
                               int index)
                        throws IOException,
                               AutomationException

The Color Correction for the CMYK color model.

Product Availability

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

Specified by:

getCMYKCorrection in interface IColorCorrection

Parameters:

dataType - A com.esri.arcgis.output.esriColorCorrectionDataType constant (in)

index - A com.esri.arcgis.output.esriCMYKIndex constant (in)

Returns:

The val

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCMYKCorrection

public void setCMYKCorrection(int dataType,
                              int index,
                              short val)
                       throws IOException,
                              AutomationException

The Color Correction for the CMYK color model.

Product Availability

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

Specified by:

setCMYKCorrection in interface IColorCorrection

Parameters:

dataType - A com.esri.arcgis.output.esriColorCorrectionDataType constant (in)

index - A com.esri.arcgis.output.esriCMYKIndex constant (in)

val - The val (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSaveMappings

public void setSaveMappings(boolean saveMappings)
                     throws IOException,
                            AutomationException

Indicates whether to save font mappings.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSaveMappings in interface IFontMapEnvironment

Parameters:

saveMappings - The saveMappings (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSaveMappings

public boolean isSaveMappings()
                       throws IOException,
                              AutomationException

Indicates whether to save font mappings.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSaveMappings in interface IFontMapEnvironment

Returns:

The saveMappings

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultMappingsChoices

public void setDefaultMappingsChoices(Object defaultMappingChoices)
                               throws IOException,
                                      AutomationException

The Default Mapping Choices for Font Substitution.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefaultMappingsChoices in interface IFontMapEnvironment

Parameters:

defaultMappingChoices - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultMappingsChoices

public Object getDefaultMappingsChoices()
                                 throws IOException,
                                        AutomationException

The Default Mapping Choices for Font Substitution.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefaultMappingsChoices in interface IFontMapEnvironment

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultMapping

public void setDefaultMapping(String defaultMapping)
                       throws IOException,
                              AutomationException

The Default Font Mapping string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefaultMapping in interface IFontMapEnvironment

Parameters:

defaultMapping - The defaultMapping (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultMapping

public String getDefaultMapping()
                         throws IOException,
                                AutomationException

The Default Font Mapping string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefaultMapping in interface IFontMapEnvironment

Returns:

The defaultMapping

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setApplyDefaultMappingDesc

public void setApplyDefaultMappingDesc(String applyDefaultMappingDesc)
                                throws IOException,
                                       AutomationException

The Font Mapping checkbox description string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setApplyDefaultMappingDesc in interface IFontMapEnvironment

Parameters:

applyDefaultMappingDesc - The applyDefaultMappingDesc (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getApplyDefaultMappingDesc

public String getApplyDefaultMappingDesc()
                                  throws IOException,
                                         AutomationException

The Font Mapping checkbox description string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getApplyDefaultMappingDesc in interface IFontMapEnvironment

Returns:

The applyDefaultMappingDesc

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

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.

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.

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.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException