com.esri.arcgis.carto
Class IPageProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.carto.IPageProxy

All Implemented Interfaces:

IPage, java.io.Externalizable, java.io.Serializable

Deprecated. Internal use only. Proxy for COM Interface 'IPage'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control the Page.' 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 =

public class IPageProxy
extends com.esri.arcgis.interop.Dispatch
implements IPage, java.io.Serializable

Internal use class

See Also:

Serialized Form

Field Summary

boolean	noncastable Deprecated.
static java.lang.Class	targetClass Deprecated.

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Fields inherited from interface com.esri.arcgis.carto.IPage

IID, IID2ab4981f_9406_11d0_87ef_080009ec732a

Constructor Summary

	IPageProxy() Deprecated. For internal use only
	IPageProxy(java.lang.Object obj) Deprecated.
protected	IPageProxy(java.lang.Object obj, java.lang.String iid) Deprecated.
	IPageProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) Deprecated.
protected	IPageProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) Deprecated.

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) Deprecated.
void	drawBackground(IDisplay display) Deprecated. Draw the page background.
void	drawBorder(IDisplay display) Deprecated. Draw the page border.
void	drawPaper(IDisplay display, IColor eraseColor) Deprecated. Draw the paper.
void	drawPrintableArea(IDisplay display) Deprecated. Draw the printable area.
IBackground	getBackground() Deprecated. The page background.
IColor	getBackgroundColor() Deprecated. The page color.
IBorder	getBorder() Deprecated. The page border.
void	getDeviceBounds(IPrinter printer, short currentPage, double overlap, short resolution, IEnvelope deviceBounds) Deprecated. Return the printer page size in device units.
int	getFormID() Deprecated. The Page form.
short	getOrientation() Deprecated. The Page orientation.
void	getPageBounds(IPrinter printer, short currentPage, double overlap, IEnvelope pageBounds) Deprecated. Return the page size in page units.
int	getPageToPrinterMapping() Deprecated. The page to printer mapping.
IEnvelope	getPrintableBounds() Deprecated. The printable bounds.
int	getUnits() Deprecated. The units used for the page and all associated coordinates.
boolean	isDelayEvents() Deprecated. Indicates if the page stops firing IPageEvents until the flag is set to false.
boolean	isPrintableAreaVisible() Deprecated. Indicates if the printable area is visible.
boolean	isStretchGraphicsWithPage() Deprecated. Indicates if graphics should stretch with the page when the page size changes.
void	printerChanged(IPrinter printer) Deprecated. Called by PageLayout when printer changes.
void	printerPageCount(IPrinter printer, double overlap, short[] pageCount) Deprecated. The number of printer pages spanned by the page.
void	putCustomSize(double width, double height) Deprecated. The size of the page in page units.
void	querySize(double[] width, double[] height) Deprecated. The size of the page in page units.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener) Deprecated.
void	setBackground(IBackground background) Deprecated. The page background.
void	setBackgroundColor(IColor color) Deprecated. The page color.
void	setBorder(IBorder border) Deprecated. The page border.
void	setDelayEvents(boolean delayEvents) Deprecated. Indicates if the page stops firing IPageEvents until the flag is set to false.
void	setFormID(int formID) Deprecated. The Page form.
void	setIsPrintableAreaVisible(boolean isPrintableAreaVisible) Deprecated. Indicates if the printable area is visible.
void	setOrientation(short orientation) Deprecated. The Page orientation.
void	setPageToPrinterMapping(int mode) Deprecated. The page to printer mapping.
void	setStretchGraphicsWithPage(boolean stretchGraphicsWithPage) Deprecated. Indicates if graphics should stretch with the page when the page size changes.
void	setUnits(int units) Deprecated. The units used for the page and all associated coordinates.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

targetClass

public static final java.lang.Class targetClass

Deprecated.

noncastable

public boolean noncastable

Deprecated.

Constructor Detail

IPageProxy

public IPageProxy(java.lang.String CLSID,
                  java.lang.String host,
                  com.esri.arcgis.interop.AuthInfo authInfo)
           throws java.net.UnknownHostException,
                  java.io.IOException

Deprecated.

Throws:

java.net.UnknownHostException

java.io.IOException

IPageProxy

public IPageProxy()

Deprecated.

For internal use only

IPageProxy

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

Deprecated.

Throws:

java.io.IOException

IPageProxy

protected IPageProxy(java.lang.Object obj,
                     java.lang.String iid)
              throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

IPageProxy

protected IPageProxy(java.lang.String CLSID,
                     java.lang.String iid,
                     java.lang.String host,
                     com.esri.arcgis.interop.AuthInfo authInfo)
              throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Deprecated.

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Deprecated.

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

getFormID

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

Deprecated.

The Page form.

Specified by:

getFormID in interface IPage

Returns:

A com.esri.arcgis.carto.esriPageFormID constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFormID

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

Deprecated.

The Page form.

Specified by:

setFormID in interface IPage

Parameters:

formID - A com.esri.arcgis.carto.esriPageFormID constant (in)

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

Deprecated.

The Page orientation. 1 = portrait. 2 = landscape.

Specified by:

getOrientation in interface IPage

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

Deprecated.

The Page orientation. 1 = portrait. 2 = landscape.

Specified by:

setOrientation in interface IPage

Parameters:

orientation - The orientation (in)

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

Deprecated.

The units used for the page and all associated coordinates.

Specified by:

getUnits in interface IPage

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.

setUnits

public void setUnits(int units)
              throws java.io.IOException,
                     AutomationException

Deprecated.

The units used for the page and all associated coordinates.

Specified by:

setUnits in interface IPage

Parameters:

units - A com.esri.arcgis.system.esriUnits constant (in)

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

Deprecated.

The printable bounds.

Specified by:

getPrintableBounds in interface IPage

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.

isPrintableAreaVisible

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

Deprecated.

Indicates if the printable area is visible.

Specified by:

isPrintableAreaVisible in interface IPage

Returns:

The isPrintableAreaVisible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsPrintableAreaVisible

public void setIsPrintableAreaVisible(boolean isPrintableAreaVisible)
                               throws java.io.IOException,
                                      AutomationException

Deprecated.

Indicates if the printable area is visible.

Specified by:

setIsPrintableAreaVisible in interface IPage

Parameters:

isPrintableAreaVisible - The isPrintableAreaVisible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isStretchGraphicsWithPage

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

Deprecated.

Indicates if graphics should stretch with the page when the page size changes.

Specified by:

isStretchGraphicsWithPage in interface IPage

Returns:

The stretchGraphicsWithPage

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStretchGraphicsWithPage

public void setStretchGraphicsWithPage(boolean stretchGraphicsWithPage)
                                throws java.io.IOException,
                                       AutomationException

Deprecated.

Indicates if graphics should stretch with the page when the page size changes.

Specified by:

setStretchGraphicsWithPage in interface IPage

Parameters:

stretchGraphicsWithPage - The stretchGraphicsWithPage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

public IColor getBackgroundColor()
                          throws java.io.IOException,
                                 AutomationException

Deprecated.

The page color.

Specified by:

getBackgroundColor in interface IPage

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBackgroundColor

public void setBackgroundColor(IColor color)
                        throws java.io.IOException,
                               AutomationException

Deprecated.

The page color.

Specified by:

setBackgroundColor in interface IPage

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBorder

public IBorder getBorder()
                  throws java.io.IOException,
                         AutomationException

Deprecated.

The page border.

Specified by:

getBorder in interface IPage

Returns:

A reference to a com.esri.arcgis.carto.IBorder

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBorder

public void setBorder(IBorder border)
               throws java.io.IOException,
                      AutomationException

Deprecated.

The page border.

Specified by:

setBorder in interface IPage

Parameters:

border - A reference to a com.esri.arcgis.carto.IBorder (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBackground

public IBackground getBackground()
                          throws java.io.IOException,
                                 AutomationException

Deprecated.

The page background.

Specified by:

getBackground in interface IPage

Returns:

A reference to a com.esri.arcgis.carto.IBackground

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBackground

public void setBackground(IBackground background)
                   throws java.io.IOException,
                          AutomationException

Deprecated.

The page background.

Specified by:

setBackground in interface IPage

Parameters:

background - A reference to a com.esri.arcgis.carto.IBackground (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDelayEvents

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

Deprecated.

Indicates if the page stops firing IPageEvents until the flag is set to false.

Specified by:

isDelayEvents in interface IPage

Returns:

The delayEvents

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDelayEvents

public void setDelayEvents(boolean delayEvents)
                    throws java.io.IOException,
                           AutomationException

Deprecated.

Indicates if the page stops firing IPageEvents until the flag is set to false.

Specified by:

setDelayEvents in interface IPage

Parameters:

delayEvents - The delayEvents (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPageToPrinterMapping

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

Deprecated.

The page to printer mapping.

Specified by:

getPageToPrinterMapping in interface IPage

Returns:

A com.esri.arcgis.carto.esriPageToPrinterMapping constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPageToPrinterMapping

public void setPageToPrinterMapping(int mode)
                             throws java.io.IOException,
                                    AutomationException

Deprecated.

The page to printer mapping.

Specified by:

setPageToPrinterMapping in interface IPage

Parameters:

mode - A com.esri.arcgis.carto.esriPageToPrinterMapping constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

querySize

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

Deprecated.

The size of the page in page units.

Specified by:

querySize in interface IPage

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.

putCustomSize

public void putCustomSize(double width,
                          double height)
                   throws java.io.IOException,
                          AutomationException

Deprecated.

The size of the page in page units.

Specified by:

putCustomSize in interface IPage

Parameters:

width - The width (in)

height - The height (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

printerPageCount

public void printerPageCount(IPrinter printer,
                             double overlap,
                             short[] pageCount)
                      throws java.io.IOException,
                             AutomationException

Deprecated.

The number of printer pages spanned by the page.

Specified by:

printerPageCount in interface IPage

Parameters:

printer - A reference to a com.esri.arcgis.output.IPrinter (in)

overlap - The overlap (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPageBounds

public void getPageBounds(IPrinter printer,
                          short currentPage,
                          double overlap,
                          IEnvelope pageBounds)
                   throws java.io.IOException,
                          AutomationException

Deprecated.

Return the page size in page units.

Specified by:

getPageBounds in interface IPage

Parameters:

printer - A reference to a com.esri.arcgis.output.IPrinter (in)

currentPage - The currentPage (in)

overlap - The overlap (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDeviceBounds

public void getDeviceBounds(IPrinter printer,
                            short currentPage,
                            double overlap,
                            short resolution,
                            IEnvelope deviceBounds)
                     throws java.io.IOException,
                            AutomationException

Deprecated.

Return the printer page size in device units.

Specified by:

getDeviceBounds in interface IPage

Parameters:

printer - A reference to a com.esri.arcgis.output.IPrinter (in)

currentPage - The currentPage (in)

overlap - The overlap (in)

resolution - The resolution (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

drawPaper

public void drawPaper(IDisplay display,
                      IColor eraseColor)
               throws java.io.IOException,
                      AutomationException

Deprecated.

Draw the paper. EraseColor is the color of the area surrounding the page. Only the area around the page is drawn in order to eliminate flashing. Use EraseColor = 0 to simply draw page.

Specified by:

drawPaper in interface IPage

Parameters:

display - A reference to a com.esri.arcgis.display.IDisplay (in)

eraseColor - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

drawBackground

public void drawBackground(IDisplay display)
                    throws java.io.IOException,
                           AutomationException

Deprecated.

Draw the page background.

Specified by:

drawBackground in interface IPage

Parameters:

display - A reference to a com.esri.arcgis.display.IDisplay (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

drawPrintableArea

public void drawPrintableArea(IDisplay display)
                       throws java.io.IOException,
                              AutomationException

Deprecated.

Draw the printable area.

Specified by:

drawPrintableArea in interface IPage

Parameters:

display - A reference to a com.esri.arcgis.display.IDisplay (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

drawBorder

public void drawBorder(IDisplay display)
                throws java.io.IOException,
                       AutomationException

Deprecated.

Draw the page border.

Specified by:

drawBorder in interface IPage

Parameters:

display - A reference to a com.esri.arcgis.display.IDisplay (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

printerChanged

public void printerChanged(IPrinter printer)
                    throws java.io.IOException,
                           AutomationException

Deprecated.

Called by PageLayout when printer changes.

Specified by:

printerChanged in interface IPage

Parameters:

printer - A reference to a com.esri.arcgis.output.IPrinter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.