com.esri.arcgis.beans.pagelayout
Class PageLayoutBean

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              com.esri.arcgis.beans.pagelayout.PageLayoutBean

All Implemented Interfaces:

BuddyControl, IMxdContents, IPageLayoutControl, IPageLayoutControl2, IPageLayoutControlDefault, ITOCBuddy, IToolbarBuddy, IConnectionPointContainer, IPersistStreamInit, com.esri.arcgis.interop.RemoteObjRef, IPersist, ISupportErrorInfo, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class PageLayoutBean
extends javax.swing.JComponent
implements BuddyControl, com.esri.arcgis.interop.RemoteObjRef, IPageLayoutControlDefault, IPageLayoutControl, IPageLayoutControl2, ITOCBuddy, IToolbarBuddy, IMxdContents, IConnectionPointContainer, IPersistStreamInit, IPersist, ISupportErrorInfo

The PageLayoutBean is a wrapper class of PageLayoutControl to facilitate the use of PageLayoutControl at the design time. Users could access the actual control by getPageLayoutControl method.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected PageLayoutControl	m_pageLayoutControl
static java.lang.String	PROPERTY_SEPARATER

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.esri.arcgis.controls.IPageLayoutControlDefault

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_27_GET_NAME, DISPID_27_PUT_NAME, DISPID_28_NAME, DISPID_29_GET_NAME, DISPID_29_PUT_NAME, DISPID_3_GET_NAME, DISPID_3_PUTREF_NAME, DISPID_30_GET_NAME, DISPID_31_GET_NAME, DISPID_31_PUT_NAME, DISPID_32_GET_NAME, DISPID_32_PUT_NAME, DISPID_33_GET_NAME, DISPID_33_PUT_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, IIDa93d0198_9b13_44d0_a565_f42a2110a8bc, xxDummy

Fields inherited from interface com.esri.arcgis.controls.IPageLayoutControl2

DISPID_27_GET_NAME, DISPID_27_PUT_NAME, DISPID_28_NAME, DISPID_29_GET_NAME, DISPID_29_PUT_NAME, DISPID_30_GET_NAME, DISPID_31_GET_NAME, DISPID_31_PUT_NAME, IID, IIDaf899892_4db1_4f01_bd4e_b6ef6535d13f, xxDummy

Fields inherited from interface com.esri.arcgis.controls.IPageLayoutControl

IID93840439_2ba9_4dfe_a431_9a13b02bde9e

Fields inherited from interface com.esri.arcgis.controls.ITOCBuddy

IID, IID5eeb268c_9b77_406d_8fc5_489324d0758b, xxDummy

Fields inherited from interface com.esri.arcgis.controls.IToolbarBuddy

IID, IIDd00f1736_7a95_4f5e_b54f_e2863c425dc3, xxDummy

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

IID, IIDbe202904_9c7f_4d51_80b2_dbc960224e7f, xxDummy

Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IPersistStreamInit

IID, IID7fd52380_4e07_101b_ae2d_08002b2ec713, 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

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

PageLayoutBean()
Default constructor.

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	addIPageLayoutControlEventsListener(IPageLayoutControlEventsAdapter theListener)
void	addITOCBuddyEventsListener(ITOCBuddyEventsAdapter theListener)
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.
void	enumConnectionPoints(IEnumConnectionPoints[] iEnumConnectionPointsArray) enumConnectionPoints
boolean	esri_isEnabled() Indicates whether the PageLayoutControl can respond to user generated events.
void	esri_setEnabled(boolean rhs1) Indicates whether the PageLayoutControl can respond to user generated events.
void	findConnectionPoint(GUID gUID, IConnectionPoint[] iConnectionPointArray) findConnectionPoint
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.
java.lang.Object	getBuddyControl() returns a com.esri.arcgis.beans.ui.BuddyControl object.
void	getClassID(GUID[] gUIDArray) getClassID
ITool	getCurrentTool() Current active tool for the PageLayoutControl.
java.lang.Object	getCustomProperty() A property to associate data with a control.
java.lang.String	getDocumentFilename() The filename of the last map document loaded into the control.
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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch()
int	getKeyIntercept() A property that specifies interception of key strokes that are normally handled by the container.
IMap	getMap() The Map object.
Picture	getMouseIcon() Custom mouse icon used if MousePointer is 99.
int	getMousePointer() The mouse pointer displayed over the PageLayoutControl.
java.lang.Object	getObject() A property that returns the underlying control.
IPage	getPage() The Page associated with the PageLayout contained by the PageLayoutControl.
IPageLayout	getPageLayout() The PageLayout contained by the PageLayoutControl.
PageLayoutControl	getPageLayoutControl() Returns the actual PageLayoutControl
java.lang.String	getPagePropertyString() Gets the page property string
IPrinter	getPrinter() The printer object used by the PageLayoutControl for printing.
short	getPrinterPageCount(double overlap) The number of printer pages the PageLayout will cover.
double	getScale(IBasicMap pBasicMap) Returns the scale of the supplied BasicMap, this allows for objects that do not support IMap.
void	getSizeMax(_ULARGE_INTEGER[] pCbSize) getSizeMax
ITrackCancel	getTrackCancel() The object used by the PageLayoutControl to check if drawing has been aborted.
void	initNew() initNew
void	interfaceSupportsErrorInfo(GUID gUID) interfaceSupportsErrorInfo
boolean	isAutoKeyboardScrolling() Indicates whether keyboard scrolling is enabled.
boolean	isAutoMouseWheel() Indicates whether the mouse wheel is enabled.
void	isDirty() isDirty
boolean	isOleDropEnabled() Indicates if the PageLayoutControl will fire events when data is dragged over the control's window.
void	load(IStream pStm) load
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	paint(java.awt.Graphics g) Paints this component.
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	release()
void	removeIPageLayoutControlEventsListener(IPageLayoutControlEventsAdapter theListener)
void	removeITOCBuddyEventsListener(ITOCBuddyEventsAdapter theListener)
void	save(IStream pStm, int fClearDirty) save
void	setAppearance(int appearance) The appearance of the PageLayoutControl.
void	setAutoKeyboardScrolling(boolean rhs1) Indicates whether keyboard scrolling is enabled.
void	setAutoMouseWheel(boolean rhs1) Indicates whether the mouse wheel is enabled.
void	setBackColor(int rhs1) Background color of the PageLayoutControl.
void	setBorderStyle(int rhs1) The border style of the PageLayoutControl.
void	setCurrentToolByRef(ITool rhs1) Current active tool for the PageLayoutControl.
void	setCustomProperty(java.lang.Object rhs1) A property to associate data with a control.
void	setDocumentFilename(java.lang.String filename) The filename of the last map document loaded into the control.
void	setExtent(IEnvelope rhs1) Current extent of the PageLayout in page units.
void	setFullExtent(IEnvelope rhs1) Rectangular shape that encloses the PageLayout.
void	setKeyIntercept(int key) A property that specifies interception of key strokes that are normally handled by the container.
void	setLayout(java.awt.LayoutManager layout) Overrides the setLayout method of super class.
void	setMouseIconByRef(Picture picture) Custom mouse icon used if MousePointer is 99.
void	setMousePointer(int pointer) The mouse pointer displayed over the PageLayoutControl.
void	setOleDropEnabled(boolean rhs1) Indicates if the PageLayoutControl will fire events when data is dragged over the control's window.
void	setPageLayoutByRef(IPageLayout rhs1) The PageLayout contained by the PageLayoutControl.
void	setPagePropertyString(java.lang.String property) Sets the page property by a string which is generated at the design-time.
void	setPrinterByRef(IPrinter rhs1) The printer object used by the PageLayoutControl for printing.
void	setTrackCancelByRef(ITrackCancel rhs1) The object used by the PageLayoutControl to check if drawing has been aborted.
void	suppressResizeDrawing(boolean suppressResize, int resizeHWnd) Suppress full redraw of control during resize operations.
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 javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_pageLayoutControl

protected PageLayoutControl m_pageLayoutControl

PROPERTY_SEPARATER

public static final java.lang.String PROPERTY_SEPARATER

See Also:

Constant Field Values

Constructor Detail

PageLayoutBean

public PageLayoutBean()

Default constructor.

Method Detail

setLayout

public void setLayout(java.awt.LayoutManager layout)

Overrides the setLayout method of super class.

Overrides:

setLayout in class java.awt.Container

Parameters:

layout - LayoutManager - a LayoutManager object.

getPageLayoutControl

public PageLayoutControl getPageLayoutControl()

Returns the actual PageLayoutControl

Returns:

PageLayoutControl

setPagePropertyString

public void setPagePropertyString(java.lang.String property)

Sets the page property by a string which is generated at the design-time. The string has the format "formID;UnitID;width;height;orientationID"

Parameters:

property - String a String

getPagePropertyString

public java.lang.String getPagePropertyString()

Gets the page property string

Returns:

String a string object.

paint

public void paint(java.awt.Graphics g)

Paints this component.

Overrides:

paint in class javax.swing.JComponent

Parameters:

g - the graphics context to use for painting

getBuddyControl

public java.lang.Object getBuddyControl()

returns a com.esri.arcgis.beans.ui.BuddyControl object.

Specified by:

getBuddyControl in interface BuddyControl

Returns:

Object

esri_isEnabled

public boolean esri_isEnabled()
                       throws java.io.IOException

Indicates whether the PageLayoutControl can respond to user generated events.

Specified by:

esri_isEnabled in interface IPageLayoutControl

Specified by:

esri_isEnabled in interface IPageLayoutControlDefault

Returns:

The returnValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_setEnabled

public void esri_setEnabled(boolean rhs1)
                     throws java.io.IOException

Indicates whether the PageLayoutControl can respond to user generated events.

Specified by:

esri_setEnabled in interface IPageLayoutControl

Specified by:

esri_setEnabled in interface IPageLayoutControlDefault

Parameters:

rhs1 - The rhs1 (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

The appearance of the PageLayoutControl.

Specified by:

getAppearance in interface IPageLayoutControl

Specified by:

getAppearance in interface IPageLayoutControlDefault

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.

setAppearance

public void setAppearance(int appearance)
                   throws java.io.IOException

The appearance of the PageLayoutControl.

Specified by:

setAppearance in interface IPageLayoutControl

Specified by:

setAppearance in interface IPageLayoutControlDefault

Parameters:

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

getBorderStyle

public int getBorderStyle()
                   throws java.io.IOException

The border style of the PageLayoutControl.

Specified by:

getBorderStyle in interface IPageLayoutControl

Specified by:

getBorderStyle in interface IPageLayoutControlDefault

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.

setBorderStyle

public void setBorderStyle(int rhs1)
                    throws java.io.IOException

The border style of the PageLayoutControl.

Specified by:

setBorderStyle in interface IPageLayoutControl

Specified by:

setBorderStyle in interface IPageLayoutControlDefault

Parameters:

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

getMousePointer

public int getMousePointer()
                    throws java.io.IOException

The mouse pointer displayed over the PageLayoutControl.

Specified by:

getMousePointer in interface IPageLayoutControl

Specified by:

getMousePointer in interface IPageLayoutControlDefault

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.

setMousePointer

public void setMousePointer(int pointer)
                     throws java.io.IOException

The mouse pointer displayed over the PageLayoutControl.

Specified by:

setMousePointer in interface IPageLayoutControl

Specified by:

setMousePointer in interface IPageLayoutControlDefault

Parameters:

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

isOleDropEnabled

public boolean isOleDropEnabled()
                         throws java.io.IOException

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

Specified by:

isOleDropEnabled in interface IPageLayoutControl

Specified by:

isOleDropEnabled in interface IPageLayoutControlDefault

Returns:

The returnValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOleDropEnabled

public void setOleDropEnabled(boolean rhs1)
                       throws java.io.IOException

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

Specified by:

setOleDropEnabled in interface IPageLayoutControl

Specified by:

setOleDropEnabled in interface IPageLayoutControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getKeyIntercept

public int getKeyIntercept()
                    throws java.io.IOException

A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

Specified by:

getKeyIntercept in interface IPageLayoutControl2

Specified by:

getKeyIntercept in interface IPageLayoutControlDefault

Returns:

The returnValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setKeyIntercept

public void setKeyIntercept(int key)
                     throws java.io.IOException

A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

Specified by:

setKeyIntercept in interface IPageLayoutControl2

Specified by:

setKeyIntercept in interface IPageLayoutControlDefault

Parameters:

rhs1 - The rhs1 (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

Background color of the PageLayoutControl.

Specified by:

getBackColor in interface IPageLayoutControl

Specified by:

getBackColor in interface IPageLayoutControlDefault

Returns:

The returnValue (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBackColor

public void setBackColor(int rhs1)
                  throws java.io.IOException

Background color of the PageLayoutControl.

Specified by:

setBackColor in interface IPageLayoutControl

Specified by:

setBackColor in interface IPageLayoutControlDefault

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDocumentFilename

public void setDocumentFilename(java.lang.String filename)
                         throws java.io.IOException

The filename of the last map document loaded into the control.

Specified by:

setDocumentFilename in interface IPageLayoutControl2

Specified by:

setDocumentFilename in interface IPageLayoutControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDocumentFilename

public java.lang.String getDocumentFilename()
                                     throws java.io.IOException

The filename of the last map document loaded into the control.

Specified by:

getDocumentFilename in interface IPageLayoutControl2

Specified by:

getDocumentFilename in interface IPageLayoutControlDefault

Returns:

The returnValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addIPageLayoutControlEventsListener

public void addIPageLayoutControlEventsListener(IPageLayoutControlEventsAdapter theListener)
                                         throws java.io.IOException

Throws:

java.io.IOException

removeIPageLayoutControlEventsListener

public void removeIPageLayoutControlEventsListener(IPageLayoutControlEventsAdapter theListener)
                                            throws java.io.IOException

Throws:

java.io.IOException

addITOCBuddyEventsListener

public void addITOCBuddyEventsListener(ITOCBuddyEventsAdapter theListener)
                                throws java.io.IOException

Throws:

java.io.IOException

removeITOCBuddyEventsListener

public void removeITOCBuddyEventsListener(ITOCBuddyEventsAdapter theListener)
                                   throws java.io.IOException

Throws:

java.io.IOException

getObject

public java.lang.Object getObject()
                           throws java.io.IOException,
                                  AutomationException

A property that returns the underlying control. This can be used when the control is inside a wrapper object that has been added by a development environment.

Specified by:

getObject in interface IPageLayoutControl2

Specified by:

getObject in interface IPageLayoutControlDefault

Returns:

A reference to another Automation Object (IDispatch)

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

Specified by:

getHWnd in interface IPageLayoutControlDefault

Returns:

The returnValue

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

Specified by:

getCurrentTool in interface IPageLayoutControlDefault

Specified by:

getCurrentTool in interface IToolbarBuddy

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 rhs1)
                         throws java.io.IOException,
                                AutomationException

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

Specified by:

setCurrentToolByRef in interface IPageLayoutControl

Specified by:

setCurrentToolByRef in interface IPageLayoutControlDefault

Specified by:

setCurrentToolByRef in interface IToolbarBuddy

Parameters:

rhs1 - 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 IMxdContents

Specified by:

getPageLayout in interface IPageLayoutControl

Specified by:

getPageLayout in interface IPageLayoutControlDefault

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 rhs1)
                        throws java.io.IOException,
                               AutomationException

The PageLayout contained by the PageLayoutControl.

Specified by:

setPageLayoutByRef in interface IPageLayoutControl

Specified by:

setPageLayoutByRef in interface IPageLayoutControlDefault

Parameters:

rhs1 - 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 IMxdContents

Specified by:

getActiveView in interface IPageLayoutControl

Specified by:

getActiveView in interface IPageLayoutControlDefault

Specified by:

getActiveView in interface ITOCBuddy

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

Specified by:

getExtent in interface IPageLayoutControlDefault

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 rhs1)
               throws java.io.IOException,
                      AutomationException

Current extent of the PageLayout in page units.

Specified by:

setExtent in interface IPageLayoutControl

Specified by:

setExtent in interface IPageLayoutControlDefault

Parameters:

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

Specified by:

getFullExtent in interface IPageLayoutControlDefault

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 rhs1)
                   throws java.io.IOException,
                          AutomationException

Rectangular shape that encloses the PageLayout.

Specified by:

setFullExtent in interface IPageLayoutControl

Specified by:

setFullExtent in interface IPageLayoutControlDefault

Parameters:

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

Specified by:

getPage in interface IPageLayoutControlDefault

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

Specified by:

getGraphicsContainer in interface IPageLayoutControlDefault

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

Specified by:

printPageLayout in interface IPageLayoutControlDefault

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

Specified by:

getPrinter in interface IPageLayoutControlDefault

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 rhs1)
                     throws java.io.IOException,
                            AutomationException

The printer object used by the PageLayoutControl for printing.

Specified by:

setPrinterByRef in interface IPageLayoutControl

Specified by:

setPrinterByRef in interface IPageLayoutControlDefault

Parameters:

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

Specified by:

getTrackCancel in interface IPageLayoutControlDefault

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 rhs1)
                         throws java.io.IOException,
                                AutomationException

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

Specified by:

setTrackCancelByRef in interface IPageLayoutControl

Specified by:

setTrackCancelByRef in interface IPageLayoutControlDefault

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.

pan

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

Tracks the mouse while panning the PageLayoutControl.

Specified by:

pan in interface IPageLayoutControl

Specified by:

pan in interface IPageLayoutControlDefault

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

Specified by:

centerAt in interface IPageLayoutControlDefault

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

Specified by:

trackRectangle in interface IPageLayoutControlDefault

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

Specified by:

addElement in interface IPageLayoutControlDefault

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

Specified by:

locateFrontElement in interface IPageLayoutControlDefault

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

Specified by:

findElementByName in interface IPageLayoutControlDefault

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

Specified by:

loadMxFile in interface IPageLayoutControlDefault

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.

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

Specified by:

checkMxFile in interface IPageLayoutControlDefault

Parameters:

fileName - The fileName (in)

Returns:

The returnValue

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

Specified by:

zoomToWholePage in interface IPageLayoutControlDefault

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

Specified by:

getPrinterPageCount in interface IPageLayoutControlDefault

Parameters:

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

Returns:

The returnValue

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

Specified by:

refresh in interface IPageLayoutControlDefault

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

Specified by:

fromPagePoint in interface IPageLayoutControlDefault

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

Specified by:

toPagePoint in interface IPageLayoutControlDefault

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.

getCustomProperty

public java.lang.Object getCustomProperty()
                                   throws java.io.IOException,
                                          AutomationException

A property to associate data with a control.

Specified by:

getCustomProperty in interface IPageLayoutControl2

Specified by:

getCustomProperty in interface IPageLayoutControlDefault

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCustomProperty

public void setCustomProperty(java.lang.Object rhs1)
                       throws java.io.IOException,
                              AutomationException

A property to associate data with a control.

Specified by:

setCustomProperty in interface IPageLayoutControl2

Specified by:

setCustomProperty in interface IPageLayoutControlDefault

Parameters:

rhs1 - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

suppressResizeDrawing

public void suppressResizeDrawing(boolean suppressResize,
                                  int resizeHWnd)
                           throws java.io.IOException,
                                  AutomationException

Suppress full redraw of control during resize operations.

Specified by:

suppressResizeDrawing in interface IPageLayoutControl2

Specified by:

suppressResizeDrawing in interface IPageLayoutControlDefault

Parameters:

suppressResize - The suppressResize (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getScale

public double getScale(IBasicMap pBasicMap)
                throws java.io.IOException,
                       AutomationException

Returns the scale of the supplied BasicMap, this allows for objects that do not support IMap.

Specified by:

getScale in interface ITOCBuddy

Parameters:

pBasicMap - A reference to a com.esri.arcgis.carto.IBasicMap (in)

Returns:

The dScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMap

public IMap getMap()
            throws java.io.IOException,
                   AutomationException

The Map object.

Specified by:

getMap in interface IMxdContents

Returns:

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

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 IPersistStreamInit

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 IPersistStreamInit

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 IPersistStreamInit

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.

getJintegraDispatch

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

Specified by:

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

release

public void release()

Specified by:

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

setMouseIconByRef

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

Custom mouse icon used if MousePointer is 99.

Specified by:

setMouseIconByRef in interface IPageLayoutControl

Specified by:

setMouseIconByRef in interface IPageLayoutControlDefault

Parameters:

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

Specified by:

getMouseIcon in interface IPageLayoutControlDefault

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.

aboutBox

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

Displays a dialog of information about the PageLayoutControl.

Specified by:

aboutBox in interface IPageLayoutControl

Specified by:

aboutBox in interface IPageLayoutControlDefault

Throws:

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

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] iEnumConnectionPointsArray)
                          throws java.io.IOException,
                                 AutomationException

enumConnectionPoints

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID gUID,
                                IConnectionPoint[] iConnectionPointArray)
                         throws java.io.IOException,
                                AutomationException

findConnectionPoint

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

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

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (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[] gUIDArray)
                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.

isDirty

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

isDirty

Specified by:

isDirty in interface IPersistStreamInit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

initNew

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

initNew

Specified by:

initNew in interface IPersistStreamInit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID gUID)
                                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.

isAutoMouseWheel

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

Indicates whether the mouse wheel is enabled.

Specified by:

isAutoMouseWheel in interface IPageLayoutControlDefault

Returns:

The returnValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAutoMouseWheel

public void setAutoMouseWheel(boolean rhs1)
                       throws java.io.IOException,
                              AutomationException

Indicates whether the mouse wheel is enabled.

Specified by:

setAutoMouseWheel in interface IPageLayoutControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAutoKeyboardScrolling

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

Indicates whether keyboard scrolling is enabled.

Specified by:

isAutoKeyboardScrolling in interface IPageLayoutControlDefault

Returns:

The returnValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAutoKeyboardScrolling

public void setAutoKeyboardScrolling(boolean rhs1)
                              throws java.io.IOException,
                                     AutomationException

Indicates whether keyboard scrolling is enabled.

Specified by:

setAutoKeyboardScrolling in interface IPageLayoutControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.