com.esri.arcgis.carto
Interface IMapAutoExtentOptions

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IMapAutoExtentOptionsProxy, Map

public interface IMapAutoExtentOptions
extends java.io.Serializable

COM Interface 'IMapAutoExtentOptions'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to the Map's auto extent options.' 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	IIDe5461b30_c74f_47f0_bdf3_65898ac2b622
static int	xxDummy Deprecated. Internal use only

Method Summary

IEnvelope	getAutoExtentBounds() The bounds of the map displayed by the frame.
IFeatureLayer	getAutoExtentLayer() Auto extent features.
IMap	getAutoExtentMap() Auto extent map.
double	getAutoExtentMargin() Auto extent margin.
int	getAutoExtentMarginUnits() Auto extent margin units.
double	getAutoExtentScale() The scale at which the map should be displayed.
int	getAutoExtentType() The way in which the map extent of the frame is specified.
void	getLockedPan(boolean[] flag) Check if the map can be panned.
void	getLockedZoom(boolean[] flag) Check if the map can be zoomed.
void	setAutoExtentBounds(IEnvelope bounds) The bounds of the map displayed by the frame.
void	setAutoExtentLayerByRef(IFeatureLayer layer) Auto extent features.
void	setAutoExtentMapByRef(IMap map) Auto extent map.
void	setAutoExtentMargin(double margin) Auto extent margin.
void	setAutoExtentMarginUnits(int units) Auto extent margin units.
void	setAutoExtentScale(double scale) The scale at which the map should be displayed.
void	setAutoExtentType(int type) The way in which the map extent of the frame is specified.

Field Detail

IIDe5461b30_c74f_47f0_bdf3_65898ac2b622

static final int IIDe5461b30_c74f_47f0_bdf3_65898ac2b622

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

getAutoExtentType

int getAutoExtentType()
                      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.

setAutoExtentType

void setAutoExtentType(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.

getAutoExtentScale

double getAutoExtentScale()
                          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.

setAutoExtentScale

void setAutoExtentScale(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.

getAutoExtentBounds

IEnvelope getAutoExtentBounds()
                              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.

setAutoExtentBounds

void setAutoExtentBounds(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.

getAutoExtentMap

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

Auto extent map. Derive extent from the extent of another map. See esriExtentTypeEnum.

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.

setAutoExtentMapByRef

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

Auto extent map. Derive extent from the extent of another map. See esriExtentTypeEnum.

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.

getAutoExtentMargin

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

Auto extent margin. Specified in AutoExtentMarginUnits. See esriExtentTypeEnum.

Returns:

The margin

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAutoExtentMargin

void setAutoExtentMargin(double margin)
                         throws java.io.IOException,
                                AutomationException

Auto extent margin. Specified in AutoExtentMarginUnits. See esriExtentTypeEnum.

Parameters:

margin - The margin (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAutoExtentMarginUnits

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

Auto extent margin units. See esriExtentTypeEnum.

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAutoExtentMarginUnits

void setAutoExtentMarginUnits(int units)
                              throws java.io.IOException,
                                     AutomationException

Auto extent margin units. See esriExtentTypeEnum.

Parameters:

units - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAutoExtentLayer

IFeatureLayer getAutoExtentLayer()
                                 throws java.io.IOException,
                                        AutomationException

Auto extent features. See esriExtentTypeEnum.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAutoExtentLayerByRef

void setAutoExtentLayerByRef(IFeatureLayer layer)
                             throws java.io.IOException,
                                    AutomationException

Auto extent features. See esriExtentTypeEnum.

Parameters:

layer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLockedZoom

void getLockedZoom(boolean[] flag)
                   throws java.io.IOException,
                          AutomationException

Check if the map can be zoomed.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLockedPan

void getLockedPan(boolean[] flag)
                  throws java.io.IOException,
                         AutomationException

Check if the map can be panned.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.