com.esri.arcgis.carto
Interface IMapFrame

All Superinterfaces:

IFrameElement, java.io.Serializable

All Known Implementing Classes:

IMapFrameProxy, MapFrame

public interface IMapFrame
extends IFrameElement, java.io.Serializable

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 =

Field Summary

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

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

IID9b00131a_9ed7_11d0_859e_0800091a2a72

Method Summary

void	addLocatorRectangle(ILocatorRectangle locator) Add a new locator rectangle to the data frame.
IMapSurroundFrame	createSurroundFrame(IUID cLSID, IMapSurround optionalStyle) Returns the map surround frame element of the type given in clsid.
IGraphicsContainer	getContainer() The frame's container.
int	getExtentType() The way in which the map extent of the frame is specified.
int	getLocatorRectangleCount() The number of locator rectangles.
IMap	getMap() The associated map.
IEnvelope	getMapBounds() The bounds of the map displayed by the frame.
double	getMapScale() The scale at which the map should be displayed.
ILocatorRectangle	locatorRectangle(int index) Returns the locator rectangle at the specified index.
void	removeAllLocatorRectangles() Remove all the locator rectangles from the data frame.
void	removeLocatorRectangle(ILocatorRectangle locator) Remove a locator rectangle from the data frame.
void	setContainerByRef(IGraphicsContainer container) The frame's container.
void	setExtentType(int type) The way in which the map extent of the frame is specified.
void	setMapBounds(IEnvelope bounds) The bounds of the map displayed by the frame.
void	setMapByRef(IMap map) The associated map.
void	setMapScale(double scale) The scale at which the map should be displayed.

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

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

Field Detail

IID9b00131b_9ed7_11d0_859e_0800091a2a72

static final int IID9b00131b_9ed7_11d0_859e_0800091a2a72

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

getMap

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

The associated map.

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

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

The associated map.

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

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

The frame's container.

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

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

The frame's container.

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

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

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

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

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

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

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

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

The scale at which the map should be displayed.

Returns:

The scale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMapScale

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

The scale at which the map should be displayed.

Parameters:

scale - The scale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapBounds

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

The bounds of the map displayed by the frame.

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

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

The bounds of the map displayed by the frame.

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

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

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

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

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

Add a new locator rectangle to the data frame.

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

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

Remove a locator rectangle from the data frame.

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

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

Remove all the locator rectangles from the data frame.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLocatorRectangleCount

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

The number of locator rectangles.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

locatorRectangle

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

Returns the locator rectangle at the specified index.

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.