com.esri.arcgis.carto
Interface IOverview

All Superinterfaces:
IMapSurround, Serializable
All Known Implementing Classes:
Overview

public interface IOverview
extends IMapSurround, Serializable

Provides access to members that control the overview.

Superseded By

IOverview2

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux


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
 

Method Detail

getAoiFillSymbol

IFillSymbol getAoiFillSymbol()
                             throws IOException,
                                    AutomationException
Fill symbol used to display the area of interest.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.display.IFillSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAoiFillSymbol

void setAoiFillSymbol(IFillSymbol symbol)
                      throws IOException,
                             AutomationException
Fill symbol used to display the area of interest.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
symbol - A reference to a com.esri.arcgis.display.IFillSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOverlayGridLayer

ILayer getOverlayGridLayer()
                           throws IOException,
                                  AutomationException
Overlay grid layer for the overview.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

setOverlayGridLayer

void setOverlayGridLayer(ILayer layer)
                         throws IOException,
                                AutomationException
Overlay grid layer for the overview.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

getOverlayGridLabelSymbol

ITextSymbol getOverlayGridLabelSymbol()
                                      throws IOException,
                                             AutomationException
Text symbol used to label overlay grid cells with the layer's display field.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.display.ITextSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOverlayGridLabelSymbol

void setOverlayGridLabelSymbol(ITextSymbol symbol)
                               throws IOException,
                                      AutomationException
Text symbol used to label overlay grid cells with the layer's display field.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
symbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOverlayGridCell

void setOverlayGridCell(int gridLayerFid)
                        throws IOException,
                               AutomationException
Sets the extent of the associated map to the specified overlay grid cell.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

updateDisplay

void updateDisplay(int windowWidth,
                   int windowHeight)
                   throws IOException,
                          AutomationException
Updates the display of the overview based upon the associated map's current settings.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
windowWidth - The windowWidth (in)
windowHeight - The windowHeight (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.