com.esri.arcgis.carto
Interface IOverview

All Superinterfaces:

IMapSurround, java.io.Serializable

All Known Implementing Classes:

IOverviewProxy, Overview

public interface IOverview
extends IMapSurround, java.io.Serializable

COM Interface 'IOverview'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

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

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID7a3f91f2_b9e3_11d1_8756_0000f8751720
static int	xxDummy Deprecated. Internal use only

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

IIDfe3115e9_ed6c_11d0_8683_0000f8751720

Method Summary

IFillSymbol	getAoiFillSymbol() Fill symbol used to display the area of interest.
ITextSymbol	getOverlayGridLabelSymbol() Text symbol used to label overlay grid cells with the layer's display field.
ILayer	getOverlayGridLayer() Overlay grid layer for the overview.
void	setAoiFillSymbol(IFillSymbol symbol) Fill symbol used to display the area of interest.
void	setOverlayGridCell(int gridLayerFid) Sets the extent of the associated map to the specified overlay grid cell.
void	setOverlayGridLabelSymbol(ITextSymbol symbol) Text symbol used to label overlay grid cells with the layer's display field.
void	setOverlayGridLayer(ILayer layer) Overlay grid layer for the overview.
void	updateDisplay(int windowWidth, int windowHeight) Updates the display of the overview based upon the associated map's current settings.

Methods inherited from interface com.esri.arcgis.carto.IMapSurround

delayEvents, draw, fitToBounds, getIcon, getMap, getName, queryBounds, refresh, setMapByRef, setName

Field Detail

IID7a3f91f2_b9e3_11d1_8756_0000f8751720

static final int IID7a3f91f2_b9e3_11d1_8756_0000f8751720

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getAoiFillSymbol

IFillSymbol getAoiFillSymbol()
                             throws java.io.IOException,
                                    AutomationException

Fill symbol used to display the area of interest.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAoiFillSymbol

void setAoiFillSymbol(IFillSymbol symbol)
                      throws java.io.IOException,
                             AutomationException

Fill symbol used to display the area of interest.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOverlayGridLayer

ILayer getOverlayGridLayer()
                           throws java.io.IOException,
                                  AutomationException

Overlay grid layer for the overview.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOverlayGridLayer

void setOverlayGridLayer(ILayer layer)
                         throws java.io.IOException,
                                AutomationException

Overlay grid layer for the overview.

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOverlayGridLabelSymbol

ITextSymbol getOverlayGridLabelSymbol()
                                      throws java.io.IOException,
                                             AutomationException

Text symbol used to label overlay grid cells with the layer's display field.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOverlayGridLabelSymbol

void setOverlayGridLabelSymbol(ITextSymbol symbol)
                               throws java.io.IOException,
                                      AutomationException

Text symbol used to label overlay grid cells with the layer's display field.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOverlayGridCell

void setOverlayGridCell(int gridLayerFid)
                        throws java.io.IOException,
                               AutomationException

Sets the extent of the associated map to the specified overlay grid cell.

Parameters:

gridLayerFid - The gridLayerFid (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateDisplay

void updateDisplay(int windowWidth,
                   int windowHeight)
                   throws java.io.IOException,
                          AutomationException

Updates the display of the overview based upon the associated map's current settings.

Parameters:

windowWidth - The windowWidth (in)

windowHeight - The windowHeight (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.