com.esri.arcgis.controls
Class IPageLayoutControlProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.controls.IPageLayoutControlProxy

All Implemented Interfaces:

IPageLayoutControl, java.io.Externalizable, java.io.Serializable

Direct Known Subclasses:

IPageLayoutControl2Proxy

public class IPageLayoutControlProxy
extends com.esri.arcgis.interop.Dispatch
implements IPageLayoutControl, java.io.Serializable

Internal use class Proxy for COM Interface 'IPageLayoutControl'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.olb'

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

boolean	noncastable
static java.lang.Class	targetClass

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

DISPID__501_GET_NAME, DISPID__501_PUT_NAME, DISPID__504_GET_NAME, DISPID__504_PUT_NAME, DISPID__514_GET_NAME, DISPID__514_PUT_NAME, DISPID__515_GET_NAME, DISPID__520_GET_NAME, DISPID__520_PUT_NAME, DISPID__521_GET_NAME, DISPID__521_PUT_NAME, DISPID__522_GET_NAME, DISPID__522_PUTREF_NAME, DISPID__552_NAME, DISPID_10_NAME, DISPID_11_GET_NAME, DISPID_11_PUTREF_NAME, DISPID_12_GET_NAME, DISPID_12_PUTREF_NAME, DISPID_13_NAME, DISPID_14_NAME, DISPID_15_NAME, DISPID_16_NAME, DISPID_17_NAME, DISPID_18_NAME, DISPID_19_NAME, DISPID_2_GET_NAME, DISPID_2_PUTREF_NAME, DISPID_20_GET_NAME, DISPID_20_PUT_NAME, DISPID_21_NAME, DISPID_22_NAME, DISPID_23_GET_NAME, DISPID_24_NAME, DISPID_25_NAME, DISPID_26_NAME, DISPID_3_GET_NAME, DISPID_3_PUTREF_NAME, DISPID_4_GET_NAME, DISPID_6_GET_NAME, DISPID_6_PUT_NAME, DISPID_7_GET_NAME, DISPID_7_PUT_NAME, DISPID_8_GET_NAME, DISPID_9_GET_NAME, IID, IID93840439_2ba9_4dfe_a431_9a13b02bde9e

Constructor Summary

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

Method Summary

void	aboutBox() Displays a dialog of information about the PageLayoutControl.
void	addElement(IElement pElement, java.lang.Object geometry, java.lang.Object symbology, java.lang.Object name, int zOrder) Adds the supplied element to the PageLayout, with optional geometry, symbolization, name and Z order.
void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
void	centerAt(IPoint centerPoint) Moves the center of the PageLayoutControl to the specified location.
boolean	checkMxFile(java.lang.String fileName) Checks the specified filename to see if it is a map document that can be loaded into the PageLayoutControl.
boolean	esri_isEnabled() Indicates whether the PageLayoutControl can respond to user generated events.
void	esri_setEnabled(boolean pbool) Indicates whether the PageLayoutControl can respond to user generated events.
IElement	findElementByName(java.lang.String name, int occurence) Find the first element with the supplied name, supply an occurrence parameter to find the second, third and so on.
void	fromPagePoint(IPoint pt, int[] x, int[] y) Converts a point on the page (in page units) to device co-ordinates (typically pixels).
IActiveView	getActiveView() The active view of the PageLayout contained by the PageLayoutControl.
int	getAppearance() The appearance of the PageLayoutControl.
int	getBackColor() Background color of the PageLayoutControl.
int	getBorderStyle() The border style of the PageLayoutControl.
ITool	getCurrentTool() Current active tool for the PageLayoutControl.
IEnvelope	getExtent() Current extent of the PageLayout in page units.
IEnvelope	getFullExtent() Rectangular shape that encloses the PageLayout.
IGraphicsContainer	getGraphicsContainer() The graphics container of the PageLayout object contained by the PageLayoutControl.
int	getHWnd() Handle to the window associated with the PageLayoutControl.
Picture	getMouseIcon() Custom mouse icon used if MousePointer is 99.
int	getMousePointer() The mouse pointer displayed over the PageLayoutControl.
IPage	getPage() The Page associated with the PageLayout contained by the PageLayoutControl.
IPageLayout	getPageLayout() The PageLayout contained by the PageLayoutControl.
IPrinter	getPrinter() The printer object used by the PageLayoutControl for printing.
short	getPrinterPageCount(double overlap) The number of printer pages the PageLayout will cover.
ITrackCancel	getTrackCancel() The object used by the PageLayoutControl to check if drawing has been aborted.
boolean	isOleDropEnabled() Indicates if the PageLayoutControl will fire events when data is dragged over the control's window.
void	loadMxFile(java.lang.String fileName, java.lang.Object password) Loads the specified map document into the PageLayout contained by the PageLayoutControl.
IElement	locateFrontElement(double pageX, double pageY, double tolerance) Locates an element at the given page co-ordinates.
void	pan() Tracks the mouse while panning the PageLayoutControl.
void	printPageLayout(short startPage, short endPage, double overlap) Sends the specified range of pages on the printer.
void	refresh(int phase, java.lang.Object layerOrElement, java.lang.Object envelope) Redraws the PageLayout, optionally just redraw specified phases or envelope.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener)
void	setAppearance(int pappearance) The appearance of the PageLayoutControl.
void	setBackColor(int pclr) Background color of the PageLayoutControl.
void	setBorderStyle(int pstyle) The border style of the PageLayoutControl.
void	setCurrentToolByRef(ITool pTool) Current active tool for the PageLayoutControl.
void	setExtent(IEnvelope extent) Current extent of the PageLayout in page units.
void	setFullExtent(IEnvelope fullExtent) Rectangular shape that encloses the PageLayout.
void	setMouseIconByRef(Picture ppMouseIcon) Custom mouse icon used if MousePointer is 99.
void	setMousePointer(int ppointer) The mouse pointer displayed over the PageLayoutControl.
void	setOleDropEnabled(boolean value) Indicates if the PageLayoutControl will fire events when data is dragged over the control's window.
void	setPageLayoutByRef(IPageLayout pPageLayout) The PageLayout contained by the PageLayoutControl.
void	setPrinterByRef(IPrinter ppPrinter) The printer object used by the PageLayoutControl for printing.
void	setTrackCancelByRef(ITrackCancel ppTrackCancel) The object used by the PageLayoutControl to check if drawing has been aborted.
IPoint	toPagePoint(int x, int y) Converts device co-ordinates (typically pixels) to a point on the page (in page units).
IEnvelope	trackRectangle() Rubber-bands a rectangle on the PageLayoutControl.
void	zoomToWholePage() Changes the extent of the PageLayout to show a whole page.

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

noncastable

public boolean noncastable

Constructor Detail

IPageLayoutControlProxy

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

Throws:

java.net.UnknownHostException

java.io.IOException

IPageLayoutControlProxy

public IPageLayoutControlProxy()

For internal use only

IPageLayoutControlProxy

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

Throws:

java.io.IOException

IPageLayoutControlProxy

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

Throws:

java.io.IOException

IPageLayoutControlProxy

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

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

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

Overrides:

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

Throws:

java.io.IOException

setBackColor

public void setBackColor(int pclr)
                  throws java.io.IOException,
                         AutomationException

Background color of the PageLayoutControl.

Specified by:

setBackColor in interface IPageLayoutControl

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBackColor

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

Background color of the PageLayoutControl.

Specified by:

getBackColor in interface IPageLayoutControl

Returns:

The pclr (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBorderStyle

public void setBorderStyle(int pstyle)
                    throws java.io.IOException,
                           AutomationException

The border style of the PageLayoutControl.

Specified by:

setBorderStyle in interface IPageLayoutControl

Parameters:

pstyle - A com.esri.arcgis.controls.esriControlsBorderStyle constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBorderStyle

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

The border style of the PageLayoutControl.

Specified by:

getBorderStyle in interface IPageLayoutControl

Returns:

A com.esri.arcgis.controls.esriControlsBorderStyle constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_setEnabled

public void esri_setEnabled(boolean pbool)
                     throws java.io.IOException,
                            AutomationException

Indicates whether the PageLayoutControl can respond to user generated events.

Specified by:

esri_setEnabled in interface IPageLayoutControl

Parameters:

pbool - The pbool (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_isEnabled

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

Indicates whether the PageLayoutControl can respond to user generated events.

Specified by:

esri_isEnabled in interface IPageLayoutControl

Returns:

The pbool

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAppearance

public void setAppearance(int pappearance)
                   throws java.io.IOException,
                          AutomationException

The appearance of the PageLayoutControl.

Specified by:

setAppearance in interface IPageLayoutControl

Parameters:

pappearance - A com.esri.arcgis.controls.esriControlsAppearance constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAppearance

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

The appearance of the PageLayoutControl.

Specified by:

getAppearance in interface IPageLayoutControl

Returns:

A com.esri.arcgis.controls.esriControlsAppearance constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMousePointer

public void setMousePointer(int ppointer)
                     throws java.io.IOException,
                            AutomationException

The mouse pointer displayed over the PageLayoutControl.

Specified by:

setMousePointer in interface IPageLayoutControl

Parameters:

ppointer - A com.esri.arcgis.controls.esriControlsMousePointer constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMousePointer

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

The mouse pointer displayed over the PageLayoutControl.

Specified by:

getMousePointer in interface IPageLayoutControl

Returns:

A com.esri.arcgis.controls.esriControlsMousePointer constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMouseIconByRef

public void setMouseIconByRef(Picture ppMouseIcon)
                       throws java.io.IOException,
                              AutomationException

Custom mouse icon used if MousePointer is 99.

Specified by:

setMouseIconByRef in interface IPageLayoutControl

Parameters:

ppMouseIcon - A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMouseIcon

public Picture getMouseIcon()
                     throws java.io.IOException,
                            AutomationException

Custom mouse icon used if MousePointer is 99.

Specified by:

getMouseIcon in interface IPageLayoutControl

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHWnd

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

Handle to the window associated with the PageLayoutControl.

Specified by:

getHWnd in interface IPageLayoutControl

Returns:

The hWnd

Throws:

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

AutomationException - If the ArcObject component throws an exception.

aboutBox

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

Displays a dialog of information about the PageLayoutControl.

Specified by:

aboutBox in interface IPageLayoutControl

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentTool

public ITool getCurrentTool()
                     throws java.io.IOException,
                            AutomationException

Current active tool for the PageLayoutControl. Set to nothing to clear the tool.

Specified by:

getCurrentTool in interface IPageLayoutControl

Returns:

A reference to a com.esri.arcgis.systemUI.ITool

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCurrentToolByRef

public void setCurrentToolByRef(ITool pTool)
                         throws java.io.IOException,
                                AutomationException

Current active tool for the PageLayoutControl. Set to nothing to clear the tool.

Specified by:

setCurrentToolByRef in interface IPageLayoutControl

Parameters:

pTool - A reference to a com.esri.arcgis.systemUI.ITool (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPageLayout

public IPageLayout getPageLayout()
                          throws java.io.IOException,
                                 AutomationException

The PageLayout contained by the PageLayoutControl.

Specified by:

getPageLayout in interface IPageLayoutControl

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPageLayoutByRef

public void setPageLayoutByRef(IPageLayout pPageLayout)
                        throws java.io.IOException,
                               AutomationException

The PageLayout contained by the PageLayoutControl.

Specified by:

setPageLayoutByRef in interface IPageLayoutControl

Parameters:

pPageLayout - A reference to a com.esri.arcgis.carto.IPageLayout (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getActiveView

public IActiveView getActiveView()
                          throws java.io.IOException,
                                 AutomationException

The active view of the PageLayout contained by the PageLayoutControl.

Specified by:

getActiveView in interface IPageLayoutControl

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtent

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

Current extent of the PageLayout in page units.

Specified by:

getExtent in interface IPageLayoutControl

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.

setExtent

public void setExtent(IEnvelope extent)
               throws java.io.IOException,
                      AutomationException

Current extent of the PageLayout in page units.

Specified by:

setExtent in interface IPageLayoutControl

Parameters:

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

getFullExtent

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

Rectangular shape that encloses the PageLayout.

Specified by:

getFullExtent in interface IPageLayoutControl

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.

setFullExtent

public void setFullExtent(IEnvelope fullExtent)
                   throws java.io.IOException,
                          AutomationException

Rectangular shape that encloses the PageLayout.

Specified by:

setFullExtent in interface IPageLayoutControl

Parameters:

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

getPage

public IPage getPage()
              throws java.io.IOException,
                     AutomationException

The Page associated with the PageLayout contained by the PageLayoutControl.

Specified by:

getPage in interface IPageLayoutControl

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGraphicsContainer

public IGraphicsContainer getGraphicsContainer()
                                        throws java.io.IOException,
                                               AutomationException

The graphics container of the PageLayout object contained by the PageLayoutControl.

Specified by:

getGraphicsContainer in interface IPageLayoutControl

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

printPageLayout

public void printPageLayout(short startPage,
                            short endPage,
                            double overlap)
                     throws java.io.IOException,
                            AutomationException

Sends the specified range of pages on the printer.

Specified by:

printPageLayout in interface IPageLayoutControl

Parameters:

startPage - The startPage (in, optional, pass 1 if not required)

endPage - The endPage (in, optional, pass 0 if not required)

overlap - The overlap (in, optional, pass 0 if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPrinter

public IPrinter getPrinter()
                    throws java.io.IOException,
                           AutomationException

The printer object used by the PageLayoutControl for printing.

Specified by:

getPrinter in interface IPageLayoutControl

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPrinterByRef

public void setPrinterByRef(IPrinter ppPrinter)
                     throws java.io.IOException,
                            AutomationException

The printer object used by the PageLayoutControl for printing.

Specified by:

setPrinterByRef in interface IPageLayoutControl

Parameters:

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

getTrackCancel

public ITrackCancel getTrackCancel()
                            throws java.io.IOException,
                                   AutomationException

The object used by the PageLayoutControl to check if drawing has been aborted.

Specified by:

getTrackCancel in interface IPageLayoutControl

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTrackCancelByRef

public void setTrackCancelByRef(ITrackCancel ppTrackCancel)
                         throws java.io.IOException,
                                AutomationException

The object used by the PageLayoutControl to check if drawing has been aborted.

Specified by:

setTrackCancelByRef in interface IPageLayoutControl

Parameters:

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

pan

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

Tracks the mouse while panning the PageLayoutControl.

Specified by:

pan in interface IPageLayoutControl

Throws:

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

AutomationException - If the ArcObject component throws an exception.

centerAt

public void centerAt(IPoint centerPoint)
              throws java.io.IOException,
                     AutomationException

Moves the center of the PageLayoutControl to the specified location.

Specified by:

centerAt in interface IPageLayoutControl

Parameters:

centerPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

trackRectangle

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

Rubber-bands a rectangle on the PageLayoutControl.

Specified by:

trackRectangle in interface IPageLayoutControl

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.

addElement

public void addElement(IElement pElement,
                       java.lang.Object geometry,
                       java.lang.Object symbology,
                       java.lang.Object name,
                       int zOrder)
                throws java.io.IOException,
                       AutomationException

Adds the supplied element to the PageLayout, with optional geometry, symbolization, name and Z order.

Specified by:

addElement in interface IPageLayoutControl

Parameters:

pElement - A reference to a com.esri.arcgis.carto.IElement (in)

geometry - A Variant (in, optional, pass null if not required)

symbology - A Variant (in, optional, pass null if not required)

name - A Variant (in, optional, pass null if not required)

zOrder - The zOrder (in, optional, pass 0 if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

locateFrontElement

public IElement locateFrontElement(double pageX,
                                   double pageY,
                                   double tolerance)
                            throws java.io.IOException,
                                   AutomationException

Locates an element at the given page co-ordinates. If more than one element is at the location the element nearest the front is returned.

Specified by:

locateFrontElement in interface IPageLayoutControl

Parameters:

pageX - The pageX (in)

pageY - The pageY (in)

tolerance - The tolerance (in, optional, pass 0 if not required)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findElementByName

public IElement findElementByName(java.lang.String name,
                                  int occurence)
                           throws java.io.IOException,
                                  AutomationException

Find the first element with the supplied name, supply an occurrence parameter to find the second, third and so on.

Specified by:

findElementByName in interface IPageLayoutControl

Parameters:

name - The name (in)

occurence - The occurence (in, optional, pass 1 if not required)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

loadMxFile

public void loadMxFile(java.lang.String fileName,
                       java.lang.Object password)
                throws java.io.IOException,
                       AutomationException

Loads the specified map document into the PageLayout contained by the PageLayoutControl.

Specified by:

loadMxFile in interface IPageLayoutControl

Parameters:

fileName - The fileName (in)

password - A Variant (in, optional, pass null if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isOleDropEnabled

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

Indicates if the PageLayoutControl will fire events when data is dragged over the control's window.

Specified by:

isOleDropEnabled in interface IPageLayoutControl

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOleDropEnabled

public void setOleDropEnabled(boolean value)
                       throws java.io.IOException,
                              AutomationException

Indicates if the PageLayoutControl will fire events when data is dragged over the control's window.

Specified by:

setOleDropEnabled in interface IPageLayoutControl

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

checkMxFile

public boolean checkMxFile(java.lang.String fileName)
                    throws java.io.IOException,
                           AutomationException

Checks the specified filename to see if it is a map document that can be loaded into the PageLayoutControl.

Specified by:

checkMxFile in interface IPageLayoutControl

Parameters:

fileName - The fileName (in)

Returns:

The result

Throws:

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

AutomationException - If the ArcObject component throws an exception.

zoomToWholePage

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

Changes the extent of the PageLayout to show a whole page.

Specified by:

zoomToWholePage in interface IPageLayoutControl

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPrinterPageCount

public short getPrinterPageCount(double overlap)
                          throws java.io.IOException,
                                 AutomationException

The number of printer pages the PageLayout will cover.

Specified by:

getPrinterPageCount in interface IPageLayoutControl

Parameters:

overlap - The overlap (in, optional, pass 0 if not required)

Returns:

The pageCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh(int phase,
                    java.lang.Object layerOrElement,
                    java.lang.Object envelope)
             throws java.io.IOException,
                    AutomationException

Redraws the PageLayout, optionally just redraw specified phases or envelope.

Specified by:

refresh in interface IPageLayoutControl

Parameters:

phase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in, optional, pass 65535 if not required)

layerOrElement - A Variant (in, optional, pass null if not required)

envelope - A Variant (in, optional, pass null if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

fromPagePoint

public void fromPagePoint(IPoint pt,
                          int[] x,
                          int[] y)
                   throws java.io.IOException,
                          AutomationException

Converts a point on the page (in page units) to device co-ordinates (typically pixels).

Specified by:

fromPagePoint in interface IPageLayoutControl

Parameters:

pt - A reference to a com.esri.arcgis.geometry.IPoint (in)

x - The x (in/out: use single element array)

y - The y (in/out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

toPagePoint

public IPoint toPagePoint(int x,
                          int y)
                   throws java.io.IOException,
                          AutomationException

Converts device co-ordinates (typically pixels) to a point on the page (in page units).

Specified by:

toPagePoint in interface IPageLayoutControl

Parameters:

x - The x (in)

y - The y (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.