com.esri.arcgis.output
Class PSDriver

java.lang.Object
  extended by com.esri.arcgis.output.PSDriver
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IColorCorrection, IPSDriver, IPSDriver2, ISpotPlateCollection, ITrackCancelSetup, ISupportErrorInfo, Serializable

public class PSDriver
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPSDriver, IPSDriver2, ISpotPlateCollection, IColorCorrection, ISupportErrorInfo, ITrackCancelSetup

Class used to print maps with the PostScript Driver.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
PSDriver()
          Constructs a PSDriver using ArcGIS Engine.
PSDriver(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PSDriver thePSDriver = (PSDriver) obj;
 
Method Summary
 void add(ISpotPlate spotPlate)
          Add an ISpotPlate to the Spot Plate collection.
 void createPS(String inputFileName, String outputFileName)
          Converts the EMF file to a EPS File.
 boolean equals(Object o)
          Compare this object with another
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.
 int getEmulsion()
          The Emulsion setting for the PostScript Driver.
 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.
 short getOrientation()
          The printer page orientation (1 = portrait.
 String getPPDFile()
          The PPD (PostScript Printer Description) file to be used.
 IEnvelope getPrintableBounds()
          The printers Printable Bounds - Used for Marks.
 int getPSLanguageLevel()
          The PostScript Driver Language Level.
 short getSaturation(int dataType)
          The Saturation Value of the HLS Color Model.
 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 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.
 boolean isOneBitImageTransparency()
          Indicates if the 1-bit Image Transparency setting for the PostScript Driver is set to true.
 boolean isUseEMFFrameBoxForPSBoundingBox()
          Indicates whether the PostScript Driver should use the ENHMETAHEADER rclFrame instead of rclBounds for the PostScript Bounding Box.
 void remove(int index)
          Remove ISpotPlate at index from the Spot Plate collection.
 void removeAll()
          Remove all ISpotPlates from the Spot Plate collection.
 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 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 setPPDFile(String pPDFile)
          The PPD (PostScript Printer Description) file to be used.
 void setPrintableBounds(IEnvelope ppBounds)
          The printers Printable Bounds - Used for Marks.
 void setPSLanguageLevel(int pslevel)
          The PostScript Driver Language Level.
 void setSaturation(int dataType, short val)
          The Saturation Value of the HLS Color Model.
 void setStepProgressor(IStepProgressor rhs1)
          PostScript Driver will update a Progress Bar.
 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.
 
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

PSDriver

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

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

PSDriver

public PSDriver(Object obj)
         throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PSDriver thePSDriver = (PSDriver) obj;

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

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

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

getPPDFile

public String getPPDFile()
                  throws IOException,
                         AutomationException
The PPD (PostScript Printer Description) file to be used.

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
Returns:
The pPDFile
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPPDFile

public void setPPDFile(String pPDFile)
                throws IOException,
                       AutomationException
The PPD (PostScript Printer Description) file to be used.

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
Parameters:
pPDFile - The pPDFile (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.

getPrintableBounds

public IEnvelope getPrintableBounds()
                             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:
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.

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.

setStepProgressor

public void setStepProgressor(IStepProgressor rhs1)
                       throws IOException,
                              AutomationException
PostScript Driver will update a Progress Bar.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

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.

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.

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.