PageLayout (ArcObjects Java API 10.4)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto
Class PageLayout

java.lang.Object
  com.esri.arcgis.carto.PageLayout

All Implemented Interfaces:: IActiveView, IGraphicsContainer, IGraphicsContainerSelect, IGraphicSnapEnvironment, IGraphicSnapEnvironment2, IMxdContents, IPageEvents, IPageLayout, IPageLayout2, IPageLayout3, IPageLayoutExtensions, ISelectionEvents, IServiceLayerCredits, IViewManager, IViewRefresh, IConnectionPointContainer, IDisplayAdmin, ITransformEvents, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable, java.util.EventListener

public class PageLayout
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IPageLayout, IPageLayout2, IPageLayout3, IActiveView, IViewManager, IViewRefresh, IGraphicsContainer, IGraphicsContainerSelect, IGraphicSnapEnvironment, IGraphicSnapEnvironment2, IConnectionPointContainer, IPersistStream, IPersist, IPageEvents, ISelectionEvents, ITransformEvents, IDisplayAdmin, IMxdContents, IPageLayoutExtensions, IServiceLayerCredits, java.io.Externalizable
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IPageLayout, IPageLayout2, IPageLayout3, IActiveView, IViewManager, IViewRefresh, IGraphicsContainer, IGraphicsContainerSelect, IGraphicSnapEnvironment, IGraphicSnapEnvironment2, IConnectionPointContainer, IPersistStream, IPersist, IPageEvents, ISelectionEvents, ITransformEvents, IDisplayAdmin, IMxdContents, IPageLayoutExtensions, IServiceLayerCredits, java.io.Externalizable

COM Class 'PageLayout'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'Page Layout class contains maps and map surrounds.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:: Serialized Form

Field Summary
`static long`	`serialVersionUID`

Fields inherited from interface com.esri.arcgis.carto.IPageLayout
`IID, IIDdd94d76a_836d_11d0_87ec_080009ec732a, xxDummy`

Fields inherited from interface com.esri.arcgis.carto.IPageLayout2
`IID, IIDdbb71b69_db4e_4780_ae6f_39ea7a4a075f, xxDummy`

Fields inherited from interface com.esri.arcgis.carto.IPageLayout3
`IID, IIDdbb71b6a_db4e_4780_ae6f_39ea7a4a075f, xxDummy`

Fields inherited from interface com.esri.arcgis.carto.IActiveView
`IID, IIDdd94d76b_836d_11d0_87ec_080009ec732a, xxDummy`

Fields inherited from interface com.esri.arcgis.carto.IViewManager
`IID, IIDdd94d76c_836d_11d0_87ec_080009ec732a, xxDummy`

Fields inherited from interface com.esri.arcgis.carto.IViewRefresh
`IID, IID5f78435a_7443_4195_beb2_caefa63433d8, xxDummy`

Fields inherited from interface com.esri.arcgis.carto.IGraphicsContainer
`IID, IIDd09411d1_4bb4_11d1_b6cc_080009b996cc, xxDummy`

Fields inherited from interface com.esri.arcgis.carto.IGraphicsContainerSelect
`IID, IIDd09411d2_4bb4_11d1_b6cc_080009b996cc, xxDummy`

Fields inherited from interface com.esri.arcgis.carto.IGraphicSnapEnvironment
`IID, IID56fd87f6_ddce_11d1_8778_0000f8751720, xxDummy`

Fields inherited from interface com.esri.arcgis.carto.IGraphicSnapEnvironment2
`IID, IID51ae6186_47a9_489a_a91d_a0e6caf320f1, xxDummy`

Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer
`IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy`

Fields inherited from interface com.esri.arcgis.system.IPersistStream
`IID, IID00000109_0000_0000_c000_000000000046, xxDummy`

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

Fields inherited from interface com.esri.arcgis.carto.IPageEvents
`IID, IID83bd34e5_ce3b_11d1_876e_0000f8751720, xxDummy`

Fields inherited from interface com.esri.arcgis.carto.ISelectionEvents
`IID, IID07e11311_d615_11d1_a21b_080009b6f22b, xxDummy`

Fields inherited from interface com.esri.arcgis.display.ITransformEvents
`IID, IIDe6bdb001_4d35_11d0_98be_00805f7ced21, xxDummy`

Fields inherited from interface com.esri.arcgis.display.IDisplayAdmin
`IID, IID12e361f0_1907_11d3_80c7_0080c79f0371, xxDummy`

Fields inherited from interface com.esri.arcgis.carto.IMxdContents
`IID, IIDbe202904_9c7f_4d51_80b2_dbc960224e7f, xxDummy`

Fields inherited from interface com.esri.arcgis.carto.IPageLayoutExtensions
`IID, IID50713bc8_4ab3_4903_9a4a_1c0ff1037019, xxDummy`

Fields inherited from interface com.esri.arcgis.carto.IServiceLayerCredits
`IID, IIDb52367cf_3b14_444d_b4fa_06a984d6ed15, xxDummy`

Constructor Summary
`PageLayout()` Constructs a PageLayout using ArcGIS Engine.
`PageLayout(java.lang.Object obj)` Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. `PageLayout thePageLayout = (PageLayout) obj;`

Method Summary
`void`	`activate(int hWnd)` Gives this view control of the specified window.
`void`	`addElement(IElement element, int zorder)` Add a new graphic element to the layer.
`void`	`addElements(IElementCollection elements, int zorder)` Add new graphic elements to the layer.
`void`	`addExtension(java.lang.Object ext)` Adds a new extension.
`void`	`addIActiveViewEventsListener(IActiveViewEvents theListener)` addIActiveViewEventsListener.
`void`	`addSnapAgent(IGraphicSnap snapAgent)` Add a new snap agent to the environment.
`void`	`animationRefresh(int phase, java.lang.Object data, IEnvelope envelope)` Use to quickly redraw a phase that has it's own cache, i.e., a tracking layer.
`void`	`animationRefreshShape(int phase, java.lang.Object data, IGeometry geometry, double symbolSizePoints)` Use to quickly redraw a phase that has it's own cache, i.e., a tracking layer.
`void`	`boundsUpdated(ITransformEventsBoundsUpdatedEvent theEvent)` Notifies clients when the bounds is updated.
`void`	`bringForward(IEnumElement elements)` Move the specified elements one step closer to the top of the stack of elements.
`void`	`bringToFront(IEnumElement elements)` Make the specified elements draw in front of all other elements.
`void`	`clear()` Empties the view contents.
`void`	`clearContent()` Clears the elements without dismantling them.
`void`	`clearSnapAgents()` Remove all snap agents.
`void`	`contentsChanged()` Called by clients when view objects are modified.
`void`	`deactivate()` Another view takes over the associated window.
`void`	`deleteAllElements()` Delete all the elements.
`void`	`deleteElement(IElement element)` Delete the given element.
`void`	`deleteSnapAgent(IGraphicSnap snapAgent)` Remove specified snap agent from the environment.
`void`	`deviceFrameUpdated(ITransformEventsDeviceFrameUpdatedEvent theEvent)` Notifies clients when the device frame is updated.
`void`	`draw(int hDC, ITrackCancel trackCancel)` Draws the view to the specified device context.
`boolean`	`elementSelected(IElement element)` Indicates if the element is selected.
`void`	`enumConnectionPoints(IEnumConnectionPoints[] ppEnum)` enumConnectionPoints
`boolean`	`equals(java.lang.Object o)` Compare this object with another
`void`	`findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)` findConnectionPoint
`IFrameElement`	`findFrame(java.lang.Object frameObject)` Find the frame that contains the specified object.
`void`	`focusNextMapFrame()` Focus the next map.
`void`	`focusPreviousMapFrame()` Focus the previous map.
`IActiveView`	`getActiveView()` The Map object.
`void`	`getClassID(GUID[] pClassID)` getClassID
`static java.lang.String`	`getClsid()` getClsid.
`java.lang.Object`	`getContentProvider()` The object that is currently managing the content of the layout.
`void`	`getContextMenu(double x, double y, IUID[] clsidMenu)` Called when a context menu should be displayed at the given xy location.
`IElement`	`getDominantElement()` Dominant element.
`java.lang.Object`	`getElementOrder(IEnumElement elements)` Private order object.
`ISelection`	`getElementSelection()` Object to use for element selection.
`int`	`getElementSelectionCount()` The number of selected elements.
`tagRECT`	`getExportFrame()` The device rectangle to export.
`java.lang.Object`	`getExtension(int index)` The extension at the specified index.
`int`	`getExtensionCount()` Number of extensions.
`IEnvelope`	`getExtent()` The visible extent rectangle.
`IExtentStack`	`getExtentStack()` The extent stack.
`IMap`	`getFocusMap()` The map that tools and controls act on.
`IEnvelope`	`getFullExtent()` The full extent rectangle.
`IGraphicsContainer`	`getGraphicsContainer()` The active graphics container.
`ISnapGuides`	`getHorizontalSnapGuides()` The horizontal snapping guides.
`com.esri.arcgis.interop.Dispatch`	`getJintegraDispatch()` Deprecated. Internal use only.
`IMap`	`getMap()` The Map object.
`int`	`getOutputBandSize()` Size allocated for each band when banding output.
`IPage`	`getPage()` The page.
`IPageLayout`	`getPageLayout()` The PageLayout object.
`IPrinter`	`getPrinter()` The associated printer.
`IRulerSettings`	`getRulerSettings()` The ruler settings.
`short`	`getScreenCacheID(int phase, java.lang.Object data)` The screen cache ID that is used to draw the specified phase.
`IScreenDisplay`	`getScreenDisplay()` The screen display used by the view.
`IEnumElement`	`getSelectedElements()` The selected elements.
`ISelection`	`getSelection()` The selection.
`IEnvelope`	`getSelectionBounds(IDisplay display)` The bounds of the selection.
`java.lang.String`	`getServiceLayerCreditsText(java.lang.String separator)` Get the service layer credits text.
`void`	`getSizeMax(_ULARGE_INTEGER[] pcbSize)` getSizeMax
`IGraphicSnap`	`getSnapAgent(int index)` The snap agent at the specified index.
`int`	`getSnapAgentCount()` The number of snap agents.
`IArray`	`getSnapAgentOrder()` An array of IDs indicating how agents should be ordered.
`ISnapGrid`	`getSnapGrid()` The snapping grid.
`double`	`getSnapTolerance()` The snap tolerance in page units.
`java.lang.String`	`getTipText(double x, double y)` The tip text to display at the given location.
`int`	`getTopFilterIndex()` Phase index that supplements TopFilterPhase.
`int`	`getTopFilterPhase()` The highest phase in the drawing order that uses a display filter.
`ISnapGuides`	`getVerticalSnapGuides()` The vertical snapping guides.
`double`	`getZoomPercent()` The current zoom percent.
`int`	`hashCode()` the hashcode for this object
`IMap`	`hitTestMap(IPoint location)` Returns any maps present in the view at the given location.
`boolean`	`isActive()` Indicates if view is active or not.
`boolean`	`isAlignToMargins()` Indicates if graphics will be aligned to the margins or to each other.
`boolean`	`isConserveMemory()` Indicates whether to be conservative when allocating resources.
`boolean`	`isDelayBackgroundDraw()` Indicates if the background should draw immediately.
`boolean`	`isDelayEvents()` Indicates if the layout stops firing events until the flag is set to false.
`void`	`isDirty()` isDirty
`boolean`	`isDrawing()` Indicates whether the view is currently drawing or not.
`boolean`	`isExternalDrawing(int phase)` Indicates if external clients are drawing in response to the specified phase.
`boolean`	`isMapActivated()` Indicates if the focus map is activated.
`boolean`	`isProgressiveDrawing()` Indicates whether the view should progressively update the window during drawing.
`boolean`	`isShowRulers()` Indicates if rulers are visible.
`boolean`	`isShowScrollBars()` Indicates if scrollbars are visible.
`boolean`	`isShowSelection()` Indicates if selection is visible.
`boolean`	`isUsesFilter()` Indicates if the current object draws using a filter.
`boolean`	`isUsesPageCoordinates()` Indicates whether view uses page coordinates.
`boolean`	`isVerboseEvents()` Indicates whether to expand or limit the number of events that are fired.
`void`	`load(IStream pstm)` load
`IEnumElement`	`locateElements(IPoint point, double tolerance)` Returns the elements at the given coordinate.
`IEnumElement`	`locateElementsByEnvelope(IEnvelope envelope)` Returns the elements inside the given envelope.
`void`	`moveElementFromGroup(IGroupElement group, IElement element, int zorder)` Move the element from the group to the container.
`void`	`moveElementToGroup(IElement element, IGroupElement group)` Move the element from the container to the group.
`IElement`	`next()` Returns the next graphic in the container.
`void`	`onMessage(int msg, int wParam, int lParam)` Call from your application's message loop to enable automatic resizing and keyboard accelerators.
`void`	`output(int hDC, int dpi, tagRECT pixelBounds, IEnvelope visibleBounds, ITrackCancel trackCancel)` Renders the view to the specified DC.
`void`	`pageColorChanged(IPageEventsPageColorChangedEvent theEvent)` Fired when the page color changes.
`void`	`pageMarginsChanged(IPageEventsPageMarginsChangedEvent theEvent)` Fired when the page margins change.
`void`	`pageSizeChanged(IPageEventsPageSizeChangedEvent theEvent)` Fired when the page size changes.
`void`	`pageUnitsChanged(IPageEventsPageUnitsChangedEvent theEvent)` Fired when the units used by the page changes.
`void`	`partialRefresh(int phase, java.lang.Object data, IEnvelope envelope)` Draws the specified view phase.
`void`	`partialRefreshShape(int phase, java.lang.Object data, IGeometry geometry, double symbolSizePoints)` Refreshes the specified shape on the specified view phase.
`void`	`printerChanged(IPrinter printer)` Called by application when printer changes.
`void`	`putElementOrder(java.lang.Object order)` Private order object.
`void`	`readExternal(java.io.ObjectInput in)`
`void`	`refresh()` Causes the entire view to draw.
`void`	`refreshCaches()` Reallocate the display caches.
`void`	`refreshItem(java.lang.Object data)` Use to redraw a specific item and the content above it.
`void`	`release()` Release a PageLayout.
`void`	`removeExtension(int index)` Removes the specified extension.
`void`	`removeIActiveViewEventsListener(IActiveViewEvents theListener)` removeIActiveViewEventsListener.
`void`	`replaceMaps(IMaps maps)` Replace the maps in the data frames with the specified maps.
`void`	`reset()` Reset internal cursor so that Next returns the first element.
`void`	`resolutionUpdated(ITransformEventsResolutionUpdatedEvent theEvent)` Notifies clients when the resolution is updated.
`void`	`rotationUpdated(ITransformEventsRotationUpdatedEvent theEvent)` Notifies clients when the rotation angle is updated.
`void`	`save(IStream pstm, int fClearDirty)` save
`void`	`selectAllElements()` Selects all elements.
`IElement`	`selectedElement(int index)` Returns the nth selected element.
`void`	`selectElement(IElement element)` Selects the specified element.
`void`	`selectElements(IEnumElement elements)` Selects the specified elements.
`void`	`selectionChanged(ISelectionEventsSelectionChangedEvent theEvent)` Call this function to fire the selection changed event.
`ISelectionTracker`	`selectionTracker(int index)` Returns the tracker for the nth selected element.
`void`	`sendBackward(IEnumElement elements)` Move the specified elements one step closer to the bottom of the stack of elements.
`void`	`sendToBack(IEnumElement elements)` Make the specified elements draw behind all other elements.
`void`	`setAlignToMargins(boolean alignToMargins)` Indicates if graphics will be aligned to the margins or to each other.
`void`	`setConserveMemory(boolean flag)` Indicates whether to be conservative when allocating resources.
`void`	`setContentProviderByRef(java.lang.Object provider)` The object that is currently managing the content of the layout.
`void`	`setDelayBackgroundDraw(boolean flag)` Indicates if the background should draw immediately.
`void`	`setDelayEvents(boolean delayEvents)` Indicates if the layout stops firing events until the flag is set to false.
`void`	`setDominantElementByRef(IElement dominantItem)` Dominant element.
`void`	`setElementSelectionByRef(ISelection selectionObject)` Object to use for element selection.
`void`	`setExtent(IEnvelope extent)` The visible extent rectangle.
`void`	`setExternalDrawing(int phase, boolean externalDrawing)` Indicates if external clients are drawing in response to the specified phase.
`void`	`setFocusMapByRef(IMap activeMap)` The map that tools and controls act on.
`void`	`setFullExtent(IEnvelope extent)` The full extent rectangle.
`void`	`setIsMapActivated(boolean isMapActivated)` Indicates if the focus map is activated.
`void`	`setOutputBandSize(int kilobytes)` Size allocated for each band when banding output.
`void`	`setProgressiveDrawing(boolean flag)` Indicates whether the view should progressively update the window during drawing.
`void`	`setSelectionByRef(ISelection selection)` The selection.
`void`	`setShowRulers(boolean showRulers)` Indicates if rulers are visible.
`void`	`setShowScrollBars(boolean showScrollBars)` Indicates if scrollbars are visible.
`void`	`setShowSelection(boolean showRulers)` Indicates if selection is visible.
`void`	`setSnapAgentOrder(IArray guids)` An array of IDs indicating how agents should be ordered.
`void`	`setSnapTolerance(double tol)` The snap tolerance in page units.
`void`	`setTopFilterIndex(int phaseIndex)` Phase index that supplements TopFilterPhase.
`void`	`setTopFilterPhase(int phase)` The highest phase in the drawing order that uses a display filter.
`void`	`setVerboseEvents(boolean verboseEvents)` Indicates whether to expand or limit the number of events that are fired.
`void`	`snapShape(IGeometry shape)` Snap the shape using the agents in the environment.
`void`	`snapShapeEx(IElement pElement, IGeometry shape)` Snap the shape using the agents in the environment.
`void`	`unitsUpdated(ITransformEventsUnitsUpdatedEvent theEvent)` Notifies clients when the units are updated.
`void`	`unselectAllElements()` Unselects all elements.
`void`	`unselectElement(IElement element)` Unselects the specified element.
`void`	`unselectElements(IEnumElement elements)` Unselects the specified elements.
`void`	`updateElement(IElement element)` The graphic element's properties have changed.
`void`	`visibleBoundsUpdated(ITransformEventsVisibleBoundsUpdatedEvent theEvent)` Notifies clients when the visible bounds is updated.
`void`	`writeExternal(java.io.ObjectOutput out)`
`void`	`zoomToPercent(int percent)` Magnify the page by a certain percentage.
`void`	`zoomToWhole()` Fit the whole page in the window.
`void`	`zoomToWidth()` Fit the width of the page to the screen.

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:: Constant Field Values

Constructor Detail

PageLayout

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

Constructs a PageLayout using ArcGIS Engine.

Throws:: java.io.IOException - if there are interop problems; java.net.UnknownHostException - if there are interop problems

PageLayout

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

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

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

Parameters:: obj - an object returned from ArcGIS Engine or Server
Throws:: java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:: equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:: hashCode in class java.lang.Object

getJintegraDispatch

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

Deprecated. Internal use only.

Specified by:: getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

addIActiveViewEventsListener

public void addIActiveViewEventsListener(IActiveViewEvents theListener)
                                  throws java.io.IOException

addIActiveViewEventsListener. Listen to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.carto.IActiveViewEvents interface.
Throws:: java.io.IOException - If there are communications problems.

removeIActiveViewEventsListener

public void removeIActiveViewEventsListener(IActiveViewEvents theListener)
                                     throws java.io.IOException

removeIActiveViewEventsListener. Stop listening to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.carto.IActiveViewEvents interface.
Throws:: java.io.IOException - If there are communications problems.

release

public void release()

Release a PageLayout.

Specified by:: release in interface com.esri.arcgis.interop.RemoteObjRef

getPage

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

The page.

Specified by:: getPage in interface IPageLayout
Specified by:: getPage in interface IPageLayout2
Specified by:: getPage in interface IPageLayout3

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.

getRulerSettings

public IRulerSettings getRulerSettings()
                                throws java.io.IOException,
                                       AutomationException

The ruler settings.

Specified by:: getRulerSettings in interface IPageLayout
Specified by:: getRulerSettings in interface IPageLayout2
Specified by:: getRulerSettings in interface IPageLayout3

Returns:: A reference to a com.esri.arcgis.carto.IRulerSettings
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSnapGrid

public ISnapGrid getSnapGrid()
                      throws java.io.IOException,
                             AutomationException

The snapping grid.

Specified by:: getSnapGrid in interface IPageLayout
Specified by:: getSnapGrid in interface IPageLayout2
Specified by:: getSnapGrid in interface IPageLayout3

Returns:: A reference to a com.esri.arcgis.carto.ISnapGrid
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHorizontalSnapGuides

public ISnapGuides getHorizontalSnapGuides()
                                    throws java.io.IOException,
                                           AutomationException

The horizontal snapping guides.

Specified by:: getHorizontalSnapGuides in interface IPageLayout
Specified by:: getHorizontalSnapGuides in interface IPageLayout2
Specified by:: getHorizontalSnapGuides in interface IPageLayout3

Returns:: A reference to a com.esri.arcgis.carto.ISnapGuides
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getVerticalSnapGuides

public ISnapGuides getVerticalSnapGuides()
                                  throws java.io.IOException,
                                         AutomationException

The vertical snapping guides.

Specified by:: getVerticalSnapGuides in interface IPageLayout
Specified by:: getVerticalSnapGuides in interface IPageLayout2
Specified by:: getVerticalSnapGuides in interface IPageLayout3

Returns:: A reference to a com.esri.arcgis.carto.ISnapGuides
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getZoomPercent

public double getZoomPercent()
                      throws java.io.IOException,
                             AutomationException

The current zoom percent. 100 means 1:1. 200 means twice normal size, etc.

Specified by:: getZoomPercent in interface IPageLayout
Specified by:: getZoomPercent in interface IPageLayout2
Specified by:: getZoomPercent in interface IPageLayout3

Returns:: The percent
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setAlignToMargins

public void setAlignToMargins(boolean alignToMargins)
                       throws java.io.IOException,
                              AutomationException

Indicates if graphics will be aligned to the margins or to each other.

Specified by:: setAlignToMargins in interface IPageLayout
Specified by:: setAlignToMargins in interface IPageLayout2
Specified by:: setAlignToMargins in interface IPageLayout3

Parameters:: alignToMargins - The alignToMargins (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isAlignToMargins

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

Indicates if graphics will be aligned to the margins or to each other.

Specified by:: isAlignToMargins in interface IPageLayout
Specified by:: isAlignToMargins in interface IPageLayout2
Specified by:: isAlignToMargins in interface IPageLayout3

Returns:: The alignToMargins
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

zoomToWidth

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

Fit the width of the page to the screen.

Specified by:: zoomToWidth in interface IPageLayout
Specified by:: zoomToWidth in interface IPageLayout2
Specified by:: zoomToWidth in interface IPageLayout3

Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

zoomToWhole

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

Fit the whole page in the window.

Specified by:: zoomToWhole in interface IPageLayout
Specified by:: zoomToWhole in interface IPageLayout2
Specified by:: zoomToWhole in interface IPageLayout3

Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

zoomToPercent

public void zoomToPercent(int percent)
                   throws java.io.IOException,
                          AutomationException

Magnify the page by a certain percentage. 100 means actual size. 200 means twice normal size, etc.

Specified by:: zoomToPercent in interface IPageLayout
Specified by:: zoomToPercent in interface IPageLayout2
Specified by:: zoomToPercent in interface IPageLayout3

Parameters:: percent - The percent (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

focusNextMapFrame

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

Focus the next map.

Specified by:: focusNextMapFrame in interface IPageLayout
Specified by:: focusNextMapFrame in interface IPageLayout2
Specified by:: focusNextMapFrame in interface IPageLayout3

Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

focusPreviousMapFrame

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

Focus the previous map.

Specified by:: focusPreviousMapFrame in interface IPageLayout
Specified by:: focusPreviousMapFrame in interface IPageLayout2
Specified by:: focusPreviousMapFrame in interface IPageLayout3

Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

replaceMaps

public void replaceMaps(IMaps maps)
                 throws java.io.IOException,
                        AutomationException

Replace the maps in the data frames with the specified maps. If there are more maps than frames, new frames are created. If there are fewer frames than maps, extra frames are cleared.

Specified by:: replaceMaps in interface IPageLayout
Specified by:: replaceMaps in interface IPageLayout2
Specified by:: replaceMaps in interface IPageLayout3

Parameters:: maps - A reference to a com.esri.arcgis.carto.IMaps (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setContentProviderByRef

public void setContentProviderByRef(java.lang.Object provider)
                             throws java.io.IOException,
                                    AutomationException

The object that is currently managing the content of the layout.

Specified by:: setContentProviderByRef in interface IPageLayout2
Specified by:: setContentProviderByRef in interface IPageLayout3

Parameters:: provider - A reference to another Object (IUnknown) (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getContentProvider

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

The object that is currently managing the content of the layout.

Specified by:: getContentProvider in interface IPageLayout2
Specified by:: getContentProvider in interface IPageLayout3

Returns:: A reference to another Object (IUnknown)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

clearContent

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

Clears the elements without dismantling them.

Specified by:: clearContent in interface IPageLayout2
Specified by:: clearContent in interface IPageLayout3

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 associated printer.

Specified by:: getPrinter in interface IPageLayout2
Specified by:: getPrinter in interface IPageLayout3

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.

isDelayEvents

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

Indicates if the layout stops firing events until the flag is set to false.

Specified by:: isDelayEvents in interface IPageLayout3

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

Indicates if the layout stops firing events until the flag is set to false.

Specified by:: setDelayEvents in interface IPageLayout3

Parameters:: delayEvents - The delayEvents (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

The full extent rectangle.

Specified by:: getFullExtent in interface IActiveView

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

The full extent rectangle.

Specified by:: setFullExtent in interface IActiveView

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.

getExtent

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

The visible extent rectangle.

Specified by:: getExtent in interface IActiveView

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

The visible extent rectangle.

Specified by:: setExtent in interface IActiveView

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.

getScreenDisplay

public IScreenDisplay getScreenDisplay()
                                throws java.io.IOException,
                                       AutomationException

The screen display used by the view.

Specified by:: getScreenDisplay in interface IActiveView

Returns:: A reference to a com.esri.arcgis.display.IScreenDisplay
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 active graphics container.

Specified by:: getGraphicsContainer in interface IActiveView

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.

getFocusMap

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

The map that tools and controls act on.

Specified by:: getFocusMap in interface IActiveView

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.

setFocusMapByRef

public void setFocusMapByRef(IMap activeMap)
                      throws java.io.IOException,
                             AutomationException

The map that tools and controls act on.

Specified by:: setFocusMapByRef in interface IActiveView

Parameters:: activeMap - A reference to a com.esri.arcgis.carto.IMap (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isMapActivated

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

Indicates if the focus map is activated.

Specified by:: isMapActivated in interface IActiveView

Returns:: The isMapActivated
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setIsMapActivated

public void setIsMapActivated(boolean isMapActivated)
                       throws java.io.IOException,
                              AutomationException

Indicates if the focus map is activated.

Specified by:: setIsMapActivated in interface IActiveView

Parameters:: isMapActivated - The isMapActivated (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSelection

public ISelection getSelection()
                        throws java.io.IOException,
                               AutomationException

The selection.

Specified by:: getSelection in interface IActiveView

Returns:: A reference to a com.esri.arcgis.carto.ISelection
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSelectionByRef

public void setSelectionByRef(ISelection selection)
                       throws java.io.IOException,
                              AutomationException

The selection.

Specified by:: setSelectionByRef in interface IActiveView

Parameters:: selection - A reference to a com.esri.arcgis.carto.ISelection (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTipText

public java.lang.String getTipText(double x,
                                   double y)
                            throws java.io.IOException,
                                   AutomationException

The tip text to display at the given location.

Specified by:: getTipText in interface IActiveView

Parameters:: x - The x (in); y - The y (in)
Returns:: The tipText
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExportFrame

public tagRECT getExportFrame()
                       throws java.io.IOException,
                              AutomationException

The device rectangle to export.

Specified by:: getExportFrame in interface IActiveView

Returns:: A Structure: com.esri.arcgis.system.tagRECT
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isShowScrollBars

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

Indicates if scrollbars are visible.

Specified by:: isShowScrollBars in interface IActiveView

Returns:: The showScrollBars
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setShowScrollBars

public void setShowScrollBars(boolean showScrollBars)
                       throws java.io.IOException,
                              AutomationException

Indicates if scrollbars are visible.

Specified by:: setShowScrollBars in interface IActiveView

Parameters:: showScrollBars - The showScrollBars (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isShowRulers

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

Indicates if rulers are visible.

Specified by:: isShowRulers in interface IActiveView

Returns:: The showRulers
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setShowRulers

public void setShowRulers(boolean showRulers)
                   throws java.io.IOException,
                          AutomationException

Indicates if rulers are visible.

Specified by:: setShowRulers in interface IActiveView

Parameters:: showRulers - The showRulers (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isShowSelection

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

Indicates if selection is visible.

Specified by:: isShowSelection in interface IActiveView

Returns:: The showRulers
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setShowSelection

public void setShowSelection(boolean showRulers)
                      throws java.io.IOException,
                             AutomationException

Indicates if selection is visible.

Specified by:: setShowSelection in interface IActiveView

Parameters:: showRulers - The showRulers (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExtentStack

public IExtentStack getExtentStack()
                            throws java.io.IOException,
                                   AutomationException

The extent stack.

Specified by:: getExtentStack in interface IActiveView

Returns:: A reference to a com.esri.arcgis.carto.IExtentStack
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getScreenCacheID

public short getScreenCacheID(int phase,
                              java.lang.Object data)
                       throws java.io.IOException,
                              AutomationException

The screen cache ID that is used to draw the specified phase.

Specified by:: getScreenCacheID in interface IActiveView

Parameters:: phase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in); data - A reference to another Object (IUnknown) (in)
Returns:: The cacheID
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

hitTestMap

public IMap hitTestMap(IPoint location)
                throws java.io.IOException,
                       AutomationException

Returns any maps present in the view at the given location. Return value may be zero if there are no maps or the coordinate is not over a map.

Specified by:: hitTestMap in interface IActiveView

Parameters:: location - A reference to a com.esri.arcgis.geometry.IPoint (in)
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.

isActive

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

Indicates if view is active or not.

Specified by:: isActive in interface IActiveView

Returns:: The isActive
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

activate

public void activate(int hWnd)
              throws java.io.IOException,
                     AutomationException

Gives this view control of the specified window.

Specified by:: activate in interface IActiveView

Parameters:: hWnd - The hWnd (A COM typedef) (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

deactivate

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

Another view takes over the associated window.

Specified by:: deactivate in interface IActiveView

Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

draw

public void draw(int hDC,
                 ITrackCancel trackCancel)
          throws java.io.IOException,
                 AutomationException

Draws the view to the specified device context.

Specified by:: draw in interface IActiveView

Parameters:: hDC - The hDC (A COM typedef) (in); trackCancel - 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.

output

public void output(int hDC,
                   int dpi,
                   tagRECT pixelBounds,
                   IEnvelope visibleBounds,
                   ITrackCancel trackCancel)
            throws java.io.IOException,
                   AutomationException

Renders the view to the specified DC.

Specified by:: output in interface IActiveView

Parameters:: hDC - The hDC (A COM typedef) (in); dpi - The dpi (in); pixelBounds - A Structure: com.esri.arcgis.system.tagRECT (in); visibleBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in); trackCancel - 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.

refresh

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

Causes the entire view to draw.

Specified by:: refresh in interface IActiveView
Specified by:: refresh in interface IViewRefresh

Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

partialRefresh

public void partialRefresh(int phase,
                           java.lang.Object data,
                           IEnvelope envelope)
                    throws java.io.IOException,
                           AutomationException

Draws the specified view phase. Use an envelope of zero to draw the entire phase.

Specified by:: partialRefresh in interface IActiveView
Specified by:: partialRefresh in interface IViewRefresh

Parameters:: phase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in); data - A reference to another Object (IUnknown) (in); envelope - 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.

clear

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

Empties the view contents.

Specified by:: clear in interface IActiveView

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

Called by application when printer changes.

Specified by:: printerChanged in interface IActiveView

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.

contentsChanged

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

Called by clients when view objects are modified.

Specified by:: contentsChanged in interface IActiveView

Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

onMessage

public void onMessage(int msg,
                      int wParam,
                      int lParam)
               throws java.io.IOException,
                      AutomationException

Call from your application's message loop to enable automatic resizing and keyboard accelerators.

Specified by:: onMessage in interface IActiveView

Parameters:: msg - The msg (in); wParam - The wParam (A COM typedef) (in); lParam - The lParam (A COM typedef) (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getContextMenu

public void getContextMenu(double x,
                           double y,
                           IUID[] clsidMenu)
                    throws java.io.IOException,
                           AutomationException

Called when a context menu should be displayed at the given xy location. Return menu that should be displayed.

Specified by:: getContextMenu in interface IActiveView

Parameters:: x - The x (in); y - The y (in); clsidMenu - A reference to a com.esri.arcgis.system.IUID (out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setElementSelectionByRef

public void setElementSelectionByRef(ISelection selectionObject)
                              throws java.io.IOException,
                                     AutomationException

Object to use for element selection.

Specified by:: setElementSelectionByRef in interface IViewManager

Parameters:: selectionObject - A reference to a com.esri.arcgis.carto.ISelection (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getElementSelection

public ISelection getElementSelection()
                               throws java.io.IOException,
                                      AutomationException

Object to use for element selection.

Specified by:: getElementSelection in interface IViewManager

Returns:: A reference to a com.esri.arcgis.carto.ISelection
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setConserveMemory

public void setConserveMemory(boolean flag)
                       throws java.io.IOException,
                              AutomationException

Indicates whether to be conservative when allocating resources.

Specified by:: setConserveMemory in interface IViewManager

Parameters:: flag - The flag (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isConserveMemory

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

Indicates whether to be conservative when allocating resources.

Specified by:: isConserveMemory in interface IViewManager

Returns:: The flag
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTopFilterPhase

public void setTopFilterPhase(int phase)
                       throws java.io.IOException,
                              AutomationException

The highest phase in the drawing order that uses a display filter. Clients should set this when they draw in response to AfterDraw and they use a display filter.

Specified by:: setTopFilterPhase in interface IViewManager

Parameters:: phase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTopFilterPhase

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

The highest phase in the drawing order that uses a display filter. Clients should set this when they draw in response to AfterDraw and they use a display filter.

Specified by:: getTopFilterPhase in interface IViewManager

Returns:: A com.esri.arcgis.carto.esriViewDrawPhase constant
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTopFilterIndex

public void setTopFilterIndex(int phaseIndex)
                       throws java.io.IOException,
                              AutomationException

Phase index that supplements TopFilterPhase. Clients should set the item index here if they draw in response to AfterDrawItem and they use a display filter. TopFilterPhase must also be specified.

Specified by:: setTopFilterIndex in interface IViewManager

Parameters:: phaseIndex - The phaseIndex (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTopFilterIndex

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

Phase index that supplements TopFilterPhase. Clients should set the item index here if they draw in response to AfterDrawItem and they use a display filter. TopFilterPhase must also be specified.

Specified by:: getTopFilterIndex in interface IViewManager

Returns:: The phaseIndex
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setOutputBandSize

public void setOutputBandSize(int kilobytes)
                       throws java.io.IOException,
                              AutomationException

Size allocated for each band when banding output.

Specified by:: setOutputBandSize in interface IViewManager

Parameters:: kilobytes - The kilobytes (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getOutputBandSize

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

Size allocated for each band when banding output.

Specified by:: getOutputBandSize in interface IViewManager

Returns:: The kilobytes
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isUsesPageCoordinates

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

Indicates whether view uses page coordinates.

Specified by:: isUsesPageCoordinates in interface IViewManager

Returns:: The usesPageCoordinates
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isVerboseEvents

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

Indicates whether to expand or limit the number of events that are fired. The following events are not fired if VerboseEvents is false: AfterItemDraw.

Specified by:: isVerboseEvents in interface IViewManager

Returns:: The verboseEvents
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setVerboseEvents

public void setVerboseEvents(boolean verboseEvents)
                      throws java.io.IOException,
                             AutomationException

Indicates whether to expand or limit the number of events that are fired. The following events are not fired if VerboseEvents is false: AfterItemDraw.

Specified by:: setVerboseEvents in interface IViewManager

Parameters:: verboseEvents - The verboseEvents (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDelayBackgroundDraw

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

Indicates if the background should draw immediately. Set to true to eliminate flashing during animation.

Specified by:: isDelayBackgroundDraw in interface IViewManager

Returns:: The flag
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDelayBackgroundDraw

public void setDelayBackgroundDraw(boolean flag)
                            throws java.io.IOException,
                                   AutomationException

Indicates if the background should draw immediately. Set to true to eliminate flashing during animation.

Specified by:: setDelayBackgroundDraw in interface IViewManager

Parameters:: flag - The flag (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isExternalDrawing

public boolean isExternalDrawing(int phase)
                          throws java.io.IOException,
                                 AutomationException

Indicates if external clients are drawing in response to the specified phase.

Specified by:: isExternalDrawing in interface IViewManager

Parameters:: phase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in)
Returns:: The externalDrawing
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setExternalDrawing

public void setExternalDrawing(int phase,
                               boolean externalDrawing)
                        throws java.io.IOException,
                               AutomationException

Indicates if external clients are drawing in response to the specified phase.

Specified by:: setExternalDrawing in interface IViewManager

Parameters:: phase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in); externalDrawing - The externalDrawing (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDrawing

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

Indicates whether the view is currently drawing or not.

Specified by:: isDrawing in interface IViewRefresh

Returns:: The drawing
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isProgressiveDrawing

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

Indicates whether the view should progressively update the window during drawing. False means just update the window once when all rendering is complete.

Specified by:: isProgressiveDrawing in interface IViewRefresh

Returns:: The flag
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setProgressiveDrawing

public void setProgressiveDrawing(boolean flag)
                           throws java.io.IOException,
                                  AutomationException

Indicates whether the view should progressively update the window during drawing. False means just update the window once when all rendering is complete.

Specified by:: setProgressiveDrawing in interface IViewRefresh

Parameters:: flag - The flag (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

partialRefreshShape

public void partialRefreshShape(int phase,
                                java.lang.Object data,
                                IGeometry geometry,
                                double symbolSizePoints)
                         throws java.io.IOException,
                                AutomationException

Refreshes the specified shape on the specified view phase. Use symbolSizePoints to indicate point and line sizes.

Specified by:: partialRefreshShape in interface IViewRefresh

Parameters:: phase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in); data - A reference to another Object (IUnknown) (in); geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in); symbolSizePoints - The symbolSizePoints (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

animationRefresh

public void animationRefresh(int phase,
                             java.lang.Object data,
                             IEnvelope envelope)
                      throws java.io.IOException,
                             AutomationException

Use to quickly redraw a phase that has it's own cache, i.e., a tracking layer. Tradeoffs are made to ensure fast redrawing at the expense of quality.

Specified by:: animationRefresh in interface IViewRefresh

Parameters:: phase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in); data - A reference to another Object (IUnknown) (in); envelope - 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.

animationRefreshShape

public void animationRefreshShape(int phase,
                                  java.lang.Object data,
                                  IGeometry geometry,
                                  double symbolSizePoints)
                           throws java.io.IOException,
                                  AutomationException

Use to quickly redraw a phase that has it's own cache, i.e., a tracking layer. Tradeoffs are made to ensure fast redrawing at the expense of quality. See PartialRefreshShape for more info.

Specified by:: animationRefreshShape in interface IViewRefresh

Parameters:: phase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in); data - A reference to another Object (IUnknown) (in); geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in); symbolSizePoints - The symbolSizePoints (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

refreshItem

public void refreshItem(java.lang.Object data)
                 throws java.io.IOException,
                        AutomationException

Use to redraw a specific item and the content above it. When adding items to the view (i.e., layers or graphics). Refresh can be optimized by only drawing the newly added items.

Specified by:: refreshItem in interface IViewRefresh

Parameters:: data - A reference to another Object (IUnknown) (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

refreshCaches

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

Reallocate the display caches. Causes a full redraw. Normally caches are automatically maintained. Use this sparingly when programatically changing attributes that affect caching such as ILayer::Cached flag.

Specified by:: refreshCaches in interface IViewRefresh

Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

public IElement next()
              throws java.io.IOException,
                     AutomationException

Returns the next graphic in the container.

Specified by:: next in interface IGraphicsContainer

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.

reset

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

Reset internal cursor so that Next returns the first element.

Specified by:: reset in interface IGraphicsContainer

Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addElement

public void addElement(IElement element,
                       int zorder)
                throws java.io.IOException,
                       AutomationException

Add a new graphic element to the layer.

Specified by:: addElement in interface IGraphicsContainer

Parameters:: element - A reference to a com.esri.arcgis.carto.IElement (in); zorder - The zorder (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addElements

public void addElements(IElementCollection elements,
                        int zorder)
                 throws java.io.IOException,
                        AutomationException

Add new graphic elements to the layer.

Specified by:: addElements in interface IGraphicsContainer

Parameters:: elements - A reference to a com.esri.arcgis.carto.IElementCollection (in); zorder - The zorder (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

deleteElement

public void deleteElement(IElement element)
                   throws java.io.IOException,
                          AutomationException

Delete the given element.

Specified by:: deleteElement in interface IGraphicsContainer

Parameters:: element - A reference to a com.esri.arcgis.carto.IElement (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

deleteAllElements

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

Delete all the elements.

Specified by:: deleteAllElements in interface IGraphicsContainer

Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

moveElementToGroup

public void moveElementToGroup(IElement element,
                               IGroupElement group)
                        throws java.io.IOException,
                               AutomationException

Move the element from the container to the group.

Specified by:: moveElementToGroup in interface IGraphicsContainer

Parameters:: element - A reference to a com.esri.arcgis.carto.IElement (in); group - A reference to a com.esri.arcgis.carto.IGroupElement (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

moveElementFromGroup

public void moveElementFromGroup(IGroupElement group,
                                 IElement element,
                                 int zorder)
                          throws java.io.IOException,
                                 AutomationException

Move the element from the group to the container.

Specified by:: moveElementFromGroup in interface IGraphicsContainer

Parameters:: group - A reference to a com.esri.arcgis.carto.IGroupElement (in); element - A reference to a com.esri.arcgis.carto.IElement (in); zorder - The zorder (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

locateElements

public IEnumElement locateElements(IPoint point,
                                   double tolerance)
                            throws java.io.IOException,
                                   AutomationException

Returns the elements at the given coordinate.

Specified by:: locateElements in interface IGraphicsContainer

Parameters:: point - A reference to a com.esri.arcgis.geometry.IPoint (in); tolerance - The tolerance (in)
Returns:: A reference to a com.esri.arcgis.carto.IEnumElement
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

locateElementsByEnvelope

public IEnumElement locateElementsByEnvelope(IEnvelope envelope)
                                      throws java.io.IOException,
                                             AutomationException

Returns the elements inside the given envelope.

Specified by:: locateElementsByEnvelope in interface IGraphicsContainer

Parameters:: envelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Returns:: A reference to a com.esri.arcgis.carto.IEnumElement
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

findFrame

public IFrameElement findFrame(java.lang.Object frameObject)
                        throws java.io.IOException,
                               AutomationException

Find the frame that contains the specified object.

Specified by:: findFrame in interface IGraphicsContainer

Parameters:: frameObject - A Variant (in)
Returns:: A reference to a com.esri.arcgis.carto.IFrameElement
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

updateElement

public void updateElement(IElement element)
                   throws java.io.IOException,
                          AutomationException

The graphic element's properties have changed.

Specified by:: updateElement in interface IGraphicsContainer

Parameters:: element - A reference to a com.esri.arcgis.carto.IElement (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getElementOrder

public java.lang.Object getElementOrder(IEnumElement elements)
                                 throws java.io.IOException,
                                        AutomationException

Private order object. Used to undo ordering operations.

Specified by:: getElementOrder in interface IGraphicsContainer

Parameters:: elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
Returns:: A Variant
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

putElementOrder

public void putElementOrder(java.lang.Object order)
                     throws java.io.IOException,
                            AutomationException

Private order object. Used to undo ordering operations.

Specified by:: putElementOrder in interface IGraphicsContainer

Parameters:: order - A Variant (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

bringToFront

public void bringToFront(IEnumElement elements)
                  throws java.io.IOException,
                         AutomationException

Make the specified elements draw in front of all other elements.

Specified by:: bringToFront in interface IGraphicsContainer

Parameters:: elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

sendToBack

public void sendToBack(IEnumElement elements)
                throws java.io.IOException,
                       AutomationException

Make the specified elements draw behind all other elements.

Specified by:: sendToBack in interface IGraphicsContainer

Parameters:: elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

sendBackward

public void sendBackward(IEnumElement elements)
                  throws java.io.IOException,
                         AutomationException

Move the specified elements one step closer to the bottom of the stack of elements.

Specified by:: sendBackward in interface IGraphicsContainer

Parameters:: elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

bringForward

public void bringForward(IEnumElement elements)
                  throws java.io.IOException,
                         AutomationException

Move the specified elements one step closer to the top of the stack of elements.

Specified by:: bringForward in interface IGraphicsContainer

Parameters:: elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

selectElement

public void selectElement(IElement element)
                   throws java.io.IOException,
                          AutomationException

Selects the specified element.

Specified by:: selectElement in interface IGraphicsContainerSelect

Parameters:: element - A reference to a com.esri.arcgis.carto.IElement (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

selectElements

public void selectElements(IEnumElement elements)
                    throws java.io.IOException,
                           AutomationException

Selects the specified elements.

Specified by:: selectElements in interface IGraphicsContainerSelect

Parameters:: elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

selectAllElements

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

Selects all elements.

Specified by:: selectAllElements in interface IGraphicsContainerSelect

Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

unselectElement

public void unselectElement(IElement element)
                     throws java.io.IOException,
                            AutomationException

Unselects the specified element.

Specified by:: unselectElement in interface IGraphicsContainerSelect

Parameters:: element - A reference to a com.esri.arcgis.carto.IElement (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

unselectElements

public void unselectElements(IEnumElement elements)
                      throws java.io.IOException,
                             AutomationException

Unselects the specified elements.

Specified by:: unselectElements in interface IGraphicsContainerSelect

Parameters:: elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

unselectAllElements

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

Unselects all elements.

Specified by:: unselectAllElements in interface IGraphicsContainerSelect

Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSelectedElements

public IEnumElement getSelectedElements()
                                 throws java.io.IOException,
                                        AutomationException

The selected elements.

Specified by:: getSelectedElements in interface IGraphicsContainerSelect

Returns:: A reference to a com.esri.arcgis.carto.IEnumElement
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getElementSelectionCount

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

The number of selected elements.

Specified by:: getElementSelectionCount in interface IGraphicsContainerSelect

Returns:: The count
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

selectedElement

public IElement selectedElement(int index)
                         throws java.io.IOException,
                                AutomationException

Returns the nth selected element. Use Selection count to get the number of selected elements.

Specified by:: selectedElement in interface IGraphicsContainerSelect

Parameters:: index - The index (in)
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.

selectionTracker

public ISelectionTracker selectionTracker(int index)
                                   throws java.io.IOException,
                                          AutomationException

Returns the tracker for the nth selected element. Use Selection count to get the number of selected elements.

Specified by:: selectionTracker in interface IGraphicsContainerSelect

Parameters:: index - The index (in)
Returns:: A reference to a com.esri.arcgis.display.ISelectionTracker
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

elementSelected

public boolean elementSelected(IElement element)
                        throws java.io.IOException,
                               AutomationException

Indicates if the element is selected.

Specified by:: elementSelected in interface IGraphicsContainerSelect

Parameters:: element - A reference to a com.esri.arcgis.carto.IElement (in)
Returns:: The elementSelected
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDominantElement

public IElement getDominantElement()
                            throws java.io.IOException,
                                   AutomationException

Dominant element.

Specified by:: getDominantElement in interface IGraphicsContainerSelect

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.

setDominantElementByRef

public void setDominantElementByRef(IElement dominantItem)
                             throws java.io.IOException,
                                    AutomationException

Dominant element.

Specified by:: setDominantElementByRef in interface IGraphicsContainerSelect

Parameters:: dominantItem - A reference to a com.esri.arcgis.carto.IElement (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSelectionBounds

public IEnvelope getSelectionBounds(IDisplay display)
                             throws java.io.IOException,
                                    AutomationException

The bounds of the selection.

Specified by:: getSelectionBounds in interface IGraphicsContainerSelect

Parameters:: display - A reference to a com.esri.arcgis.display.IDisplay (in)
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.

snapShape

public void snapShape(IGeometry shape)
               throws java.io.IOException,
                      AutomationException

Snap the shape using the agents in the environment.

Specified by:: snapShape in interface IGraphicSnapEnvironment
Specified by:: snapShape in interface IGraphicSnapEnvironment2

Parameters:: shape - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSnapTolerance

public double getSnapTolerance()
                        throws java.io.IOException,
                               AutomationException

The snap tolerance in page units.

Specified by:: getSnapTolerance in interface IGraphicSnapEnvironment
Specified by:: getSnapTolerance in interface IGraphicSnapEnvironment2

Returns:: The tol
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSnapTolerance

public void setSnapTolerance(double tol)
                      throws java.io.IOException,
                             AutomationException

The snap tolerance in page units.

Specified by:: setSnapTolerance in interface IGraphicSnapEnvironment
Specified by:: setSnapTolerance in interface IGraphicSnapEnvironment2

Parameters:: tol - The tol (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSnapAgentOrder

public void setSnapAgentOrder(IArray guids)
                       throws java.io.IOException,
                              AutomationException

An array of IDs indicating how agents should be ordered.

Specified by:: setSnapAgentOrder in interface IGraphicSnapEnvironment
Specified by:: setSnapAgentOrder in interface IGraphicSnapEnvironment2

Parameters:: guids - A reference to a com.esri.arcgis.system.IArray (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSnapAgentOrder

public IArray getSnapAgentOrder()
                         throws java.io.IOException,
                                AutomationException

An array of IDs indicating how agents should be ordered.

Specified by:: getSnapAgentOrder in interface IGraphicSnapEnvironment
Specified by:: getSnapAgentOrder in interface IGraphicSnapEnvironment2

Returns:: A reference to a com.esri.arcgis.system.IArray
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSnapAgentCount

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

The number of snap agents.

Specified by:: getSnapAgentCount in interface IGraphicSnapEnvironment
Specified by:: getSnapAgentCount in interface IGraphicSnapEnvironment2

Returns:: The count
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSnapAgent

public IGraphicSnap getSnapAgent(int index)
                          throws java.io.IOException,
                                 AutomationException

The snap agent at the specified index. The index argument is zero based.

Specified by:: getSnapAgent in interface IGraphicSnapEnvironment
Specified by:: getSnapAgent in interface IGraphicSnapEnvironment2

Parameters:: index - The index (in)
Returns:: A reference to a com.esri.arcgis.carto.IGraphicSnap
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

clearSnapAgents

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

Remove all snap agents.

Specified by:: clearSnapAgents in interface IGraphicSnapEnvironment
Specified by:: clearSnapAgents in interface IGraphicSnapEnvironment2

Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addSnapAgent

public void addSnapAgent(IGraphicSnap snapAgent)
                  throws java.io.IOException,
                         AutomationException

Add a new snap agent to the environment.

Specified by:: addSnapAgent in interface IGraphicSnapEnvironment
Specified by:: addSnapAgent in interface IGraphicSnapEnvironment2

Parameters:: snapAgent - A reference to a com.esri.arcgis.carto.IGraphicSnap (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

deleteSnapAgent

public void deleteSnapAgent(IGraphicSnap snapAgent)
                     throws java.io.IOException,
                            AutomationException

Remove specified snap agent from the environment.

Specified by:: deleteSnapAgent in interface IGraphicSnapEnvironment
Specified by:: deleteSnapAgent in interface IGraphicSnapEnvironment2

Parameters:: snapAgent - A reference to a com.esri.arcgis.carto.IGraphicSnap (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

snapShapeEx

public void snapShapeEx(IElement pElement,
                        IGeometry shape)
                 throws java.io.IOException,
                        AutomationException

Snap the shape using the agents in the environment.

Specified by:: snapShapeEx in interface IGraphicSnapEnvironment2

Parameters:: pElement - A reference to a com.esri.arcgis.carto.IElement (in); shape - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          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 riid,
                                IConnectionPoint[] ppCP)
                         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.

isDirty

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

isDirty

Specified by:: isDirty in interface IPersistStream

Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

load

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

load

Specified by:: load in interface IPersistStream

Parameters:: pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

save

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

save

Specified by:: save in interface IPersistStream

Parameters:: pstm - A reference to a com.esri.arcgis.system.IStream (in); fClearDirty - The fClearDirty (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Specified by:: getSizeMax in interface IPersistStream

Parameters:: pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:: getClassID in interface IPersist

Parameters:: pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

pageUnitsChanged

public void pageUnitsChanged(IPageEventsPageUnitsChangedEvent theEvent)
                      throws java.io.IOException,
                             AutomationException

Fired when the units used by the page changes.

Specified by:: pageUnitsChanged in interface IPageEvents

Parameters:: theEvent - The event
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

pageSizeChanged

public void pageSizeChanged(IPageEventsPageSizeChangedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Fired when the page size changes.

Specified by:: pageSizeChanged in interface IPageEvents

Parameters:: theEvent - The event
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

pageMarginsChanged

public void pageMarginsChanged(IPageEventsPageMarginsChangedEvent theEvent)
                        throws java.io.IOException,
                               AutomationException

Fired when the page margins change.

Specified by:: pageMarginsChanged in interface IPageEvents

Parameters:: theEvent - The event
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

pageColorChanged

public void pageColorChanged(IPageEventsPageColorChangedEvent theEvent)
                      throws java.io.IOException,
                             AutomationException

Fired when the page color changes.

Specified by:: pageColorChanged in interface IPageEvents

Parameters:: theEvent - The event
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

selectionChanged

public void selectionChanged(ISelectionEventsSelectionChangedEvent theEvent)
                      throws java.io.IOException,
                             AutomationException

Call this function to fire the selection changed event.

Specified by:: selectionChanged in interface ISelectionEvents

Parameters:: theEvent - The event
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

boundsUpdated

public void boundsUpdated(ITransformEventsBoundsUpdatedEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Notifies clients when the bounds is updated.

Specified by:: boundsUpdated in interface ITransformEvents

Parameters:: theEvent - The event
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

visibleBoundsUpdated

public void visibleBoundsUpdated(ITransformEventsVisibleBoundsUpdatedEvent theEvent)
                          throws java.io.IOException,
                                 AutomationException

Notifies clients when the visible bounds is updated.

Specified by:: visibleBoundsUpdated in interface ITransformEvents

Parameters:: theEvent - The event
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

deviceFrameUpdated

public void deviceFrameUpdated(ITransformEventsDeviceFrameUpdatedEvent theEvent)
                        throws java.io.IOException,
                               AutomationException

Notifies clients when the device frame is updated.

Specified by:: deviceFrameUpdated in interface ITransformEvents

Parameters:: theEvent - The event
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

resolutionUpdated

public void resolutionUpdated(ITransformEventsResolutionUpdatedEvent theEvent)
                       throws java.io.IOException,
                              AutomationException

Notifies clients when the resolution is updated.

Specified by:: resolutionUpdated in interface ITransformEvents

Parameters:: theEvent - The event
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

rotationUpdated

public void rotationUpdated(ITransformEventsRotationUpdatedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Notifies clients when the rotation angle is updated.

Specified by:: rotationUpdated in interface ITransformEvents

Parameters:: theEvent - The event
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

unitsUpdated

public void unitsUpdated(ITransformEventsUnitsUpdatedEvent theEvent)
                  throws java.io.IOException,
                         AutomationException

Notifies clients when the units are updated.

Specified by:: unitsUpdated in interface ITransformEvents

Parameters:: theEvent - The event
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isUsesFilter

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

Indicates if the current object draws using a filter.

Specified by:: isUsesFilter in interface IDisplayAdmin

Returns:: The usesFilter
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 object.

Specified by:: getPageLayout in interface IMxdContents

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.

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.

getActiveView

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

The Map object.

Specified by:: getActiveView in interface IMxdContents

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.

getExtensionCount

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

Number of extensions.

Specified by:: getExtensionCount in interface IPageLayoutExtensions

Returns:: The count
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExtension

public java.lang.Object getExtension(int index)
                              throws java.io.IOException,
                                     AutomationException

The extension at the specified index.

Specified by:: getExtension in interface IPageLayoutExtensions

Parameters:: index - The index (in)
Returns:: A reference to another Object (IUnknown)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addExtension

public void addExtension(java.lang.Object ext)
                  throws java.io.IOException,
                         AutomationException

Adds a new extension.

Specified by:: addExtension in interface IPageLayoutExtensions

Parameters:: ext - A reference to another Object (IUnknown) (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

removeExtension

public void removeExtension(int index)
                     throws java.io.IOException,
                            AutomationException

Removes the specified extension.

Specified by:: removeExtension in interface IPageLayoutExtensions

Parameters:: index - The index (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getServiceLayerCreditsText

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

Get the service layer credits text.

Specified by:: getServiceLayerCreditsText in interface IServiceLayerCredits

Parameters:: separator - The separator (in)
Returns:: The credits
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

writeExternal

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

Specified by:: writeExternal in interface java.io.Externalizable

Throws:: java.io.IOException

readExternal

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

Specified by:: readExternal in interface java.io.Externalizable

Throws:: java.io.IOException; java.lang.ClassNotFoundException

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto Class PageLayout

serialVersionUID

PageLayout

PageLayout

getClsid

equals

hashCode

getJintegraDispatch

addIActiveViewEventsListener

removeIActiveViewEventsListener

release

getPage

getRulerSettings

getSnapGrid

getHorizontalSnapGuides

getVerticalSnapGuides

getZoomPercent

setAlignToMargins

isAlignToMargins

zoomToWidth

zoomToWhole

zoomToPercent

focusNextMapFrame

focusPreviousMapFrame

replaceMaps

setContentProviderByRef

getContentProvider

clearContent

getPrinter

isDelayEvents

setDelayEvents

getFullExtent

setFullExtent

getExtent

setExtent

getScreenDisplay

getGraphicsContainer

getFocusMap

setFocusMapByRef

isMapActivated

setIsMapActivated

getSelection

setSelectionByRef

getTipText

getExportFrame

isShowScrollBars

setShowScrollBars

isShowRulers

setShowRulers

isShowSelection

setShowSelection

getExtentStack

getScreenCacheID

hitTestMap

isActive

activate

deactivate

draw

output

refresh

partialRefresh

clear

printerChanged

contentsChanged

onMessage

getContextMenu

setElementSelectionByRef

getElementSelection

setConserveMemory

isConserveMemory

setTopFilterPhase

getTopFilterPhase

setTopFilterIndex

getTopFilterIndex

setOutputBandSize

getOutputBandSize

isUsesPageCoordinates

isVerboseEvents

setVerboseEvents

isDelayBackgroundDraw

com.esri.arcgis.carto
Class PageLayout