com.esri.arcgis.carto
Class Overview

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

All Implemented Interfaces:

IBoundsProperties, IMapSurround, IOverview, IOverview2, IQuerySize, IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class Overview
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IOverview, IOverview2, IMapSurround, IQuerySize, IBoundsProperties, IConnectionPointContainer, IPersistStream, IPersist, IClone, java.io.Externalizable

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

Description 'A map surround for displaying an 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 =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

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

IID, IID7a3f91f2_b9e3_11d1_8756_0000f8751720, xxDummy

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

IID, IID1bd83797_6dbc_43d1_a642_19a22185acac, xxDummy

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

IIDfe3115e9_ed6c_11d0_8683_0000f8751720

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

IID, IID4d582692_c52a_4287_9fcf_d6286c4775af, xxDummy

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

IID, IID7ad72c5d_eb8a_11d3_9314_00600802e603, 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.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Constructor Summary

Overview()
Constructs a Overview using ArcGIS Engine.

Overview(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Overview theOverview = (Overview) obj;

Method Summary

void	addIMapSurroundEventsListener(IMapSurroundEvents theListener) addIMapSurroundEventsListener.
void	assign(IClone src) Assigns the properties of src to the receiver.
void	delayEvents(boolean delay) Used to batch operations together to minimize notifications.
void	draw(IDisplay display, ITrackCancel trackCancel, IEnvelope bounds) Draws the map surround into the specified display bounds.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
void	fitToBounds(IDisplay display, IEnvelope bounds, boolean[] changed) Adjusts the map surround to fit the bounds.
IFillSymbol	getAoiFillSymbol() Fill symbol used to display the area of interest.
IColor	getBackgroundColor() Background color of the overview.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
int	getIcon() Icon used to represent the map surround.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IMap	getMap() The parent map.
java.lang.String	getName() Name of the map surround.
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	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isFixedAspectRatio() Indicates if the bounds has a fixed aspect ratio.
boolean	isFixedSize() Indicates if size is determined by some other property like the symbol.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	load(IStream pstm) load
void	queryBounds(IDisplay display, IEnvelope oldBounds, IEnvelope newBounds) Returns the bounds of the map surround.
void	querySize(double[] widthPoints, double[] heightPoints) Get the size in points.
void	readExternal(java.io.ObjectInput in)
void	refresh() Makes sure the latest updates are refected the next time the Map Surround is drawn.
void	release() Release a Overview.
void	removeIMapSurroundEventsListener(IMapSurroundEvents theListener) removeIMapSurroundEventsListener.
void	save(IStream pstm, int fClearDirty) save
void	setAoiFillSymbol(IFillSymbol symbol) Fill symbol used to display the area of interest.
void	setBackgroundColor(IColor color) Background color of the overview.
void	setFixedAspectRatio(boolean flag) Indicates if the bounds has a fixed aspect ratio.
void	setMapByRef(IMap map) The parent map.
void	setName(java.lang.String name) Name of the map surround.
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.
void	writeExternal(java.io.ObjectOutput out)

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

Overview

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

Constructs a Overview using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

Overview

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

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

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

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

addIMapSurroundEventsListener

public void addIMapSurroundEventsListener(IMapSurroundEvents theListener)
                                   throws java.io.IOException

addIMapSurroundEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.IMapSurroundEvents interface.

Throws:

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

removeIMapSurroundEventsListener

public void removeIMapSurroundEventsListener(IMapSurroundEvents theListener)
                                      throws java.io.IOException

removeIMapSurroundEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.IMapSurroundEvents interface.

Throws:

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

release

public void release()

Release a Overview.

Specified by:

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

getAoiFillSymbol

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

Fill symbol used to display the area of interest.

Specified by:

getAoiFillSymbol in interface IOverview

Specified by:

getAoiFillSymbol in interface IOverview2

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

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

Fill symbol used to display the area of interest.

Specified by:

setAoiFillSymbol in interface IOverview

Specified by:

setAoiFillSymbol in interface IOverview2

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

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

Overlay grid layer for the overview.

Specified by:

getOverlayGridLayer in interface IOverview

Specified by:

getOverlayGridLayer in interface IOverview2

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

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

Overlay grid layer for the overview.

Specified by:

setOverlayGridLayer in interface IOverview

Specified by:

setOverlayGridLayer in interface IOverview2

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

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

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

Specified by:

getOverlayGridLabelSymbol in interface IOverview

Specified by:

getOverlayGridLabelSymbol in interface IOverview2

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

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

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

Specified by:

setOverlayGridLabelSymbol in interface IOverview

Specified by:

setOverlayGridLabelSymbol in interface IOverview2

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

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

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

Specified by:

setOverlayGridCell in interface IOverview

Specified by:

setOverlayGridCell in interface IOverview2

Parameters:

gridLayerFid - The gridLayerFid (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateDisplay

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

Specified by:

updateDisplay in interface IOverview

Specified by:

updateDisplay in interface IOverview2

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.

getMap

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

The parent map.

Specified by:

getMap in interface IMapSurround

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.

setMapByRef

public void setMapByRef(IMap map)
                 throws java.io.IOException,
                        AutomationException

The parent map.

Specified by:

setMapByRef in interface IMapSurround

Parameters:

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

getName

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

Name of the map surround.

Specified by:

getName in interface IMapSurround

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

Name of the map surround.

Specified by:

setName in interface IMapSurround

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getIcon

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

Icon used to represent the map surround.

Specified by:

getIcon in interface IMapSurround

Returns:

The hIcon (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryBounds

public void queryBounds(IDisplay display,
                        IEnvelope oldBounds,
                        IEnvelope newBounds)
                 throws java.io.IOException,
                        AutomationException

Returns the bounds of the map surround.

Specified by:

queryBounds in interface IMapSurround

Parameters:

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

oldBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

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

fitToBounds

public void fitToBounds(IDisplay display,
                        IEnvelope bounds,
                        boolean[] changed)
                 throws java.io.IOException,
                        AutomationException

Adjusts the map surround to fit the bounds. The changed argument indicates whether the size of the map surround was changed.

Specified by:

fitToBounds in interface IMapSurround

Parameters:

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

bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

changed - The changed (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

delayEvents

public void delayEvents(boolean delay)
                 throws java.io.IOException,
                        AutomationException

Used to batch operations together to minimize notifications.

Specified by:

delayEvents in interface IMapSurround

Parameters:

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

Makes sure the latest updates are refected the next time the Map Surround is drawn.

Specified by:

refresh in interface IMapSurround

Throws:

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

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IDisplay display,
                 ITrackCancel trackCancel,
                 IEnvelope bounds)
          throws java.io.IOException,
                 AutomationException

Draws the map surround into the specified display bounds.

Specified by:

draw in interface IMapSurround

Parameters:

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

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

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

getBackgroundColor

public IColor getBackgroundColor()
                          throws java.io.IOException,
                                 AutomationException

Background color of the overview.

Specified by:

getBackgroundColor in interface IOverview2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBackgroundColor

public void setBackgroundColor(IColor color)
                        throws java.io.IOException,
                               AutomationException

Background color of the overview.

Specified by:

setBackgroundColor in interface IOverview2

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

querySize

public void querySize(double[] widthPoints,
                      double[] heightPoints)
               throws java.io.IOException,
                      AutomationException

Get the size in points.

Specified by:

querySize in interface IQuerySize

Parameters:

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFixedAspectRatio

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

Indicates if the bounds has a fixed aspect ratio.

Specified by:

isFixedAspectRatio in interface IBoundsProperties

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFixedAspectRatio

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

Indicates if the bounds has a fixed aspect ratio.

Specified by:

setFixedAspectRatio in interface IBoundsProperties

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFixedSize

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

Indicates if size is determined by some other property like the symbol.

Specified by:

isFixedSize in interface IBoundsProperties

Returns:

The flag

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.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

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