com.esri.arcgis.output
Class EmfPrinter

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IEmfPrinter, IOutputCleanup, IPrinter, IPrinterMPage, ITrackCancelSetup, IClone, IPersist, IPersistStream, ISupportErrorInfo, java.io.Externalizable, java.io.Serializable

public class EmfPrinter
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IEmfPrinter, IPrinter, IPrinterMPage, IPersistStream, IClone, ISupportErrorInfo, IOutputCleanup, ITrackCancelSetup, java.io.Externalizable

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

Description 'Class used to print maps with the EMF (Windows Enhanced Metafile) Printer Driver.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

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

IID, IIDde6dcd81_3f54_11d1_885e_0000f87808ee, xxDummy

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

IID, IID2ab49820_9406_11d0_87ef_080009ec732a, xxDummy

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

IID, IID4004040c_a184_4c77_ba78_0475d93a3803, xxDummy

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

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

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

IID0000010c_0000_0000_c000_000000000046

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

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

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

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

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

IID, IID2b8765ec_8808_474c_8fd3_869d08df20f6, xxDummy

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

IID, IID5e091c46_d015_471f_8187_f774c7ad9d48, xxDummy

Constructor Summary

EmfPrinter()
Constructs a EmfPrinter using ArcGIS Engine.

EmfPrinter(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
EmfPrinter theEmfPrinter = (EmfPrinter) obj;

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
void	cleanup() Cleanup should clean all temporary files, free used memory, etc...
boolean	doesDriverSupportPrinter(java.lang.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(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	finishPrinting() Finish up Printing.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.String	getDriverName() The name of Windows Printer Driver.
java.lang.String	getFileExtension() File Extension associated with the Printer Driver.
java.lang.String	getFilter() Filter used in CFileDialog.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getName() Name of the IPrinter Driver.
IPaper	getPaper() The IPaper interface.
IEnvelope	getPrintableBounds() The area of the printer page that can be printed on.
java.lang.String	getPrintToFile() The name of file if saving to Disk.
short	getResolution() The Printer Driver Resolution.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
java.lang.String	getSpoolFileName() The Spool File Name which shows up in the Print Manager.
int	getUnits() The units for PaperSize and PrintableBounds.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
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.
void	load(IStream pstm) load
void	queryPaperSize(double[] width, double[] height) Returns Page Size for Printer.
void	readExternal(java.io.ObjectInput in)
void	release() Release a EmfPrinter.
void	save(IStream pstm, int fClearDirty) save
void	setPaperByRef(IPaper paper) The IPaper interface.
void	setPrintToFile(java.lang.String fileName) The name of file if saving to Disk.
void	setResolution(short res) The Printer Driver Resolution.
void	setSpoolFileName(java.lang.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	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(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

EmfPrinter

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

Constructs a EmfPrinter using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

EmfPrinter

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

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

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

release

public void release()

Release a EmfPrinter.

Specified by:

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

getName

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

Name of the IPrinter Driver.

Specified by:

getName in interface IPrinter

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFilter

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

Filter used in CFileDialog.

Specified by:

getFilter in interface IPrinter

Returns:

The filter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFileExtension

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

File Extension associated with the Printer Driver.

Specified by:

getFileExtension in interface IPrinter

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPrintToFile

public void setPrintToFile(java.lang.String fileName)
                    throws java.io.IOException,
                           AutomationException

The name of file if saving to Disk.

Specified by:

setPrintToFile in interface IPrinter

Parameters:

fileName - The fileName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPrintToFile

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

The name of file if saving to Disk.

Specified by:

getPrintToFile in interface IPrinter

Returns:

The fileName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDriverName

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

The name of Windows Printer Driver.

Specified by:

getDriverName in interface IPrinter

Returns:

The driverName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpoolFileName

public void setSpoolFileName(java.lang.String spoolFileName)
                      throws java.io.IOException,
                             AutomationException

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

Specified by:

setSpoolFileName in interface IPrinter

Parameters:

spoolFileName - The spoolFileName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpoolFileName

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

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

Specified by:

getSpoolFileName in interface IPrinter

Returns:

The spoolFileName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResolution

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

The Printer Driver Resolution.

Specified by:

setResolution in interface IPrinter

Parameters:

res - The res (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getResolution

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

The Printer Driver Resolution.

Specified by:

getResolution in interface IPrinter

Returns:

The res

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStepProgressor

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

Updates a Progress Bar is set.

Specified by:

setStepProgressor in interface IPrinter

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPaperByRef

public void setPaperByRef(IPaper paper)
                   throws java.io.IOException,
                          AutomationException

The IPaper interface.

Specified by:

setPaperByRef in interface IPrinter

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPaper

public IPaper getPaper()
                throws java.io.IOException,
                       AutomationException

The IPaper interface.

Specified by:

getPaper in interface IPrinter

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryPaperSize

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

Returns Page Size for Printer.

Specified by:

queryPaperSize in interface IPrinter

Parameters:

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPrintableBounds

public IEnvelope getPrintableBounds()
                             throws java.io.IOException,
                                    AutomationException

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

Specified by:

getPrintableBounds in interface IPrinter

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUnits

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

The units for PaperSize and PrintableBounds.

Specified by:

getUnits in interface IPrinter

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

verifyDriverSettings

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

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

Specified by:

verifyDriverSettings in interface IPrinter

Returns:

The ok

Throws:

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

AutomationException - If the ArcObject component throws an exception.

doesDriverSupportPrinter

public boolean doesDriverSupportPrinter(java.lang.String printerName)
                                 throws java.io.IOException,
                                        AutomationException

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

Specified by:

doesDriverSupportPrinter in interface IPrinter

Parameters:

printerName - The printerName (in)

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startPrinting

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

Initialize Printing.

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:

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

AutomationException - If the ArcObject component throws an exception.

finishPrinting

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

Finish up Printing.

Specified by:

finishPrinting in interface IPrinter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startMapDocument

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

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

Specified by:

startMapDocument in interface IPrinterMPage

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startPage

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

Start new page output.

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:

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

AutomationException - If the ArcObject component throws an exception.

endPage

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

Finalize current page output.

Specified by:

endPage in interface IPrinterMPage

Throws:

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

AutomationException - If the ArcObject component throws an exception.

endMapDocument

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

End map document.

Specified by:

endMapDocument in interface IPrinterMPage

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

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

save

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

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

Returns:

The equal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

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

Returns:

The identical

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

cleanup

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

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

Specified by:

cleanup in interface IOutputCleanup

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTrackCancel

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

Reacts to a Cancel.

Specified by:

setTrackCancel in interface ITrackCancelSetup

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException