com.esri.arcgis.carto
Class IMapFrameProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.carto.IFrameElementProxy
          com.esri.arcgis.carto.IMapFrameProxy

All Implemented Interfaces:

IFrameElement, IMapFrame, java.io.Externalizable, java.io.Serializable

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

Description: 'Provides access to the members that control the map element object.' 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 IMapFrameProxy
extends IFrameElementProxy
implements IMapFrame, 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.IMapFrame

IID, IID9b00131b_9ed7_11d0_859e_0800091a2a72

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

IID9b00131a_9ed7_11d0_859e_0800091a2a72

Constructor Summary

	IMapFrameProxy() Deprecated. For internal use only
	IMapFrameProxy(java.lang.Object obj) Deprecated.
protected	IMapFrameProxy(java.lang.Object obj, java.lang.String iid) Deprecated.
	IMapFrameProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) Deprecated.
protected	IMapFrameProxy(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	addLocatorRectangle(ILocatorRectangle locator) Deprecated. Add a new locator rectangle to the data frame.
IMapSurroundFrame	createSurroundFrame(IUID cLSID, IMapSurround optionalStyle) Deprecated. Returns the map surround frame element of the type given in clsid.
IGraphicsContainer	getContainer() Deprecated. The frame's container.
int	getExtentType() Deprecated. The way in which the map extent of the frame is specified.
int	getLocatorRectangleCount() Deprecated. The number of locator rectangles.
IMap	getMap() Deprecated. The associated map.
IEnvelope	getMapBounds() Deprecated. The bounds of the map displayed by the frame.
double	getMapScale() Deprecated. The scale at which the map should be displayed.
ILocatorRectangle	locatorRectangle(int index) Deprecated. Returns the locator rectangle at the specified index.
void	removeAllLocatorRectangles() Deprecated. Remove all the locator rectangles from the data frame.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener) Deprecated.
void	removeLocatorRectangle(ILocatorRectangle locator) Deprecated. Remove a locator rectangle from the data frame.
void	setContainerByRef(IGraphicsContainer container) Deprecated. The frame's container.
void	setExtentType(int type) Deprecated. The way in which the map extent of the frame is specified.
void	setMapBounds(IEnvelope bounds) Deprecated. The bounds of the map displayed by the frame.
void	setMapByRef(IMap map) Deprecated. The associated map.
void	setMapScale(double scale) Deprecated. The scale at which the map should be displayed.

Methods inherited from class com.esri.arcgis.carto.IFrameElementProxy

getBackground, getBorder, getObject, getThumbnail, isDraftMode, setBackground, setBorder, setDraftMode

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

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

getBackground, getBorder, getObject, getThumbnail, isDraftMode, setBackground, setBorder, setDraftMode

Field Detail

targetClass

public static final java.lang.Class targetClass

Deprecated.

noncastable

public boolean noncastable

Deprecated.

Constructor Detail

IMapFrameProxy

public IMapFrameProxy(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

IMapFrameProxy

public IMapFrameProxy()

Deprecated.

For internal use only

IMapFrameProxy

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

Deprecated.

Throws:

java.io.IOException

IMapFrameProxy

protected IMapFrameProxy(java.lang.Object obj,
                         java.lang.String iid)
                  throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

IMapFrameProxy

protected IMapFrameProxy(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 IFrameElementProxy

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 IFrameElementProxy

Throws:

java.io.IOException

getMap

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

Deprecated.

The associated map.

Specified by:

getMap in interface IMapFrame

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

Specified by:

setMapByRef in interface IMapFrame

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.

getContainer

public IGraphicsContainer getContainer()
                                throws java.io.IOException,
                                       AutomationException

Deprecated.

The frame's container.

Specified by:

getContainer in interface IMapFrame

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.

setContainerByRef

public void setContainerByRef(IGraphicsContainer container)
                       throws java.io.IOException,
                              AutomationException

Deprecated.

The frame's container.

Specified by:

setContainerByRef in interface IMapFrame

Parameters:

container - A reference to a com.esri.arcgis.carto.IGraphicsContainer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtentType

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

Deprecated.

The way in which the map extent of the frame is specified.

Specified by:

getExtentType in interface IMapFrame

Returns:

A com.esri.arcgis.carto.esriExtentTypeEnum constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExtentType

public void setExtentType(int type)
                   throws java.io.IOException,
                          AutomationException

Deprecated.

The way in which the map extent of the frame is specified.

Specified by:

setExtentType in interface IMapFrame

Parameters:

type - A com.esri.arcgis.carto.esriExtentTypeEnum constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapScale

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

Deprecated.

The scale at which the map should be displayed.

Specified by:

getMapScale in interface IMapFrame

Returns:

The scale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMapScale

public void setMapScale(double scale)
                 throws java.io.IOException,
                        AutomationException

Deprecated.

The scale at which the map should be displayed.

Specified by:

setMapScale in interface IMapFrame

Parameters:

scale - The scale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapBounds

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

Deprecated.

The bounds of the map displayed by the frame.

Specified by:

getMapBounds in interface IMapFrame

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.

setMapBounds

public void setMapBounds(IEnvelope bounds)
                  throws java.io.IOException,
                         AutomationException

Deprecated.

The bounds of the map displayed by the frame.

Specified by:

setMapBounds in interface IMapFrame

Parameters:

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.

createSurroundFrame

public IMapSurroundFrame createSurroundFrame(IUID cLSID,
                                             IMapSurround optionalStyle)
                                      throws java.io.IOException,
                                             AutomationException

Deprecated.

Returns the map surround frame element of the type given in clsid. An optional style object may be specified.

Specified by:

createSurroundFrame in interface IMapFrame

Parameters:

cLSID - A reference to a com.esri.arcgis.system.IUID (in)

optionalStyle - A reference to a com.esri.arcgis.carto.IMapSurround (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addLocatorRectangle

public void addLocatorRectangle(ILocatorRectangle locator)
                         throws java.io.IOException,
                                AutomationException

Deprecated.

Add a new locator rectangle to the data frame.

Specified by:

addLocatorRectangle in interface IMapFrame

Parameters:

locator - A reference to a com.esri.arcgis.carto.ILocatorRectangle (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeLocatorRectangle

public void removeLocatorRectangle(ILocatorRectangle locator)
                            throws java.io.IOException,
                                   AutomationException

Deprecated.

Remove a locator rectangle from the data frame.

Specified by:

removeLocatorRectangle in interface IMapFrame

Parameters:

locator - A reference to a com.esri.arcgis.carto.ILocatorRectangle (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAllLocatorRectangles

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

Deprecated.

Remove all the locator rectangles from the data frame.

Specified by:

removeAllLocatorRectangles in interface IMapFrame

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLocatorRectangleCount

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

Deprecated.

The number of locator rectangles.

Specified by:

getLocatorRectangleCount in interface IMapFrame

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

locatorRectangle

public ILocatorRectangle locatorRectangle(int index)
                                   throws java.io.IOException,
                                          AutomationException

Deprecated.

Returns the locator rectangle at the specified index.

Specified by:

locatorRectangle in interface IMapFrame

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.