com.esri.arcgis.output
Class Paper

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IPaper, IPaper2, IClone, IPersist, IPersistStream, ISupportErrorInfo, java.io.Externalizable, java.io.Serializable

public class Paper
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IPaper, IPaper2, IClone, IPersistStream, ISupportErrorInfo, java.io.Externalizable

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

Description 'The default printer page settings.' 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.IPaper

IID, IID387bc1d1_3f54_11d1_885e_0000f87808ee, xxDummy

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

IID, IID6a319332_d3e2_413a_97f4_f25ce438feda, xxDummy

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

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, 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.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

Paper()
Constructs a Paper using ArcGIS Engine.

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

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
void	attach(int hDevMode, int hDevNames) Attach object to specified DEVMODE and DEVNAMES structures.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
short	getFormID() The printer page form.
java.lang.String	getFormName() The Form Name.
IEnumNamedID	getForms() Enumerate forms supported by the printer.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
short	getOrientation() The printer page orientation (1 = portrait.
IEnvelope	getPrintableBounds() The area of the printer page that can be printed on.
int	getPrinterInfo(int[] hDevMode) Display the Print Setup Dialog.
java.lang.String	getPrinterName() The Printer Name.
short	getResolution() The print resolution.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
short	getTrayID() The printer tray.
IEnumNamedID	getTrays() Enumerate trays supported by the printer.
int	getUnits() The units used by the other properties.
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 the size of the printer paper.
void	readExternal(java.io.ObjectInput in)
void	release() Release a Paper.
void	save(IStream pstm, int fClearDirty) save
void	setFormID(short formID) The printer page form.
void	setOrientation(short orientation) The printer page orientation (1 = portrait.
void	setPrinterName(java.lang.String printerName) The Printer Name.
void	setTrayID(short trayID) The printer tray.
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

Paper

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

Constructs a Paper using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

Paper

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

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

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

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

Specified by:

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

getUnits

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

The units used by the other properties.

Specified by:

getUnits in interface IPaper

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.

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 IPaper

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.

getOrientation

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

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

Specified by:

getOrientation in interface IPaper

Returns:

The orientation

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOrientation

public void setOrientation(short orientation)
                    throws java.io.IOException,
                           AutomationException

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

Specified by:

setOrientation in interface IPaper

Parameters:

orientation - The orientation (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getForms

public IEnumNamedID getForms()
                      throws java.io.IOException,
                             AutomationException

Enumerate forms supported by the printer.

Specified by:

getForms in interface IPaper

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFormName

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

The Form Name.

Specified by:

getFormName in interface IPaper

Returns:

The formName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFormID

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

The printer page form. Use Win32 DMPAPER_xxx constants.

Specified by:

getFormID in interface IPaper

Returns:

The formID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFormID

public void setFormID(short formID)
               throws java.io.IOException,
                      AutomationException

The printer page form. Use Win32 DMPAPER_xxx constants.

Specified by:

setFormID in interface IPaper

Parameters:

formID - The formID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTrays

public IEnumNamedID getTrays()
                      throws java.io.IOException,
                             AutomationException

Enumerate trays supported by the printer.

Specified by:

getTrays in interface IPaper

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTrayID

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

The printer tray. Use Win32 DMBIN_xxx constants.

Specified by:

getTrayID in interface IPaper

Returns:

The trayID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTrayID

public void setTrayID(short trayID)
               throws java.io.IOException,
                      AutomationException

The printer tray. Use Win32 DMBIN_xxx constants.

Specified by:

setTrayID in interface IPaper

Parameters:

trayID - The trayID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPrinterName

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

The Printer Name.

Specified by:

getPrinterName in interface IPaper

Returns:

The printerName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPrinterName

public void setPrinterName(java.lang.String printerName)
                    throws java.io.IOException,
                           AutomationException

The Printer Name.

Specified by:

setPrinterName in interface IPaper

Parameters:

printerName - The printerName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

attach

public void attach(int hDevMode,
                   int hDevNames)
            throws java.io.IOException,
                   AutomationException

Attach object to specified DEVMODE and DEVNAMES structures. This must be called before using other properties and methods.

Specified by:

attach in interface IPaper

Parameters:

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

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

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 the size of the printer paper. Units property specifies measurement units.

Specified by:

queryPaperSize in interface IPaper

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.

getPrinterInfo

public int getPrinterInfo(int[] hDevMode)
                   throws java.io.IOException,
                          AutomationException

Display the Print Setup Dialog.

Specified by:

getPrinterInfo in interface IPaper

Parameters:

hDevMode - The hDevMode (A COM typedef) (out: use single element array)

Returns:

The hDevNames (A COM typedef)

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

Specified by:

getResolution in interface IPaper2

Returns:

The resolution

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.

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.

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.

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