com.esri.arcgis.carto
Class IMapSurroundProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.carto.IMapSurroundProxy
All Implemented Interfaces:
IMapSurround, java.io.Externalizable, java.io.Serializable
Direct Known Subclasses:
ILegendProxy, IMapInsetProxy, INorthArrow2Proxy, INorthArrowProxy, IOverview2Proxy, IOverviewProxy, IScaleBarProxy, IScaleText2Proxy, IScaleTextProxy

Deprecated. Internal use only. Proxy for COM Interface 'IMapSurround'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriCarto.olb'

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

public class IMapSurroundProxy
extends com.esri.arcgis.interop.Dispatch
implements IMapSurround, java.io.Serializable

Internal use class

See Also:
Serialized Form

Field Summary
 boolean noncastable
          Deprecated.  
static java.lang.Class targetClass
          Deprecated.  
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Fields inherited from interface com.esri.arcgis.carto.IMapSurround
IID, IIDfe3115e9_ed6c_11d0_8683_0000f8751720
 
Constructor Summary
  IMapSurroundProxy()
          Deprecated. For internal use only
  IMapSurroundProxy(java.lang.Object obj)
          Deprecated.  
protected IMapSurroundProxy(java.lang.Object obj, java.lang.String iid)
          Deprecated.  
  IMapSurroundProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
          Deprecated.  
protected IMapSurroundProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
          Deprecated.  
 
Method Summary
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
          Deprecated.  
 void delayEvents(boolean delay)
          Deprecated. Used to batch operations together to minimize notifications.
 void draw(IDisplay display, ITrackCancel trackCancel, IEnvelope bounds)
          Deprecated. Draws the map surround into the specified display bounds.
 void fitToBounds(IDisplay display, IEnvelope bounds, boolean[] changed)
          Deprecated. Adjusts the map surround to fit the bounds.
 int getIcon()
          Deprecated. Icon used to represent the map surround.
 IMap getMap()
          Deprecated. The parent map.
 java.lang.String getName()
          Deprecated. Name of the map surround.
 void queryBounds(IDisplay display, IEnvelope oldBounds, IEnvelope newBounds)
          Deprecated. Returns the bounds of the map surround.
 void refresh()
          Deprecated. Makes sure the latest updates are refected the next time the Map Surround is drawn.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
          Deprecated.  
 void setMapByRef(IMap map)
          Deprecated. The parent map.
 void setName(java.lang.String name)
          Deprecated. Name of the map surround.
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

targetClass

public static final java.lang.Class targetClass
Deprecated. 

noncastable

public boolean noncastable
Deprecated. 
Constructor Detail

IMapSurroundProxy

public IMapSurroundProxy(java.lang.String CLSID,
                         java.lang.String host,
                         com.esri.arcgis.interop.AuthInfo authInfo)
                  throws java.net.UnknownHostException,
                         java.io.IOException
Deprecated. 
Throws:
java.net.UnknownHostException
java.io.IOException

IMapSurroundProxy

public IMapSurroundProxy()
Deprecated. 
For internal use only


IMapSurroundProxy

public IMapSurroundProxy(java.lang.Object obj)
                  throws java.io.IOException
Deprecated. 
Throws:
java.io.IOException

IMapSurroundProxy

protected IMapSurroundProxy(java.lang.Object obj,
                            java.lang.String iid)
                     throws java.io.IOException
Deprecated. 
Throws:
java.io.IOException

IMapSurroundProxy

protected IMapSurroundProxy(java.lang.String CLSID,
                            java.lang.String iid,
                            java.lang.String host,
                            com.esri.arcgis.interop.AuthInfo authInfo)
                     throws java.io.IOException
Deprecated. 
Throws:
java.io.IOException
Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException
Deprecated. 
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException
Deprecated. 
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

getMap

public IMap getMap()
            throws java.io.IOException,
                   AutomationException
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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.