com.esri.arcgis.carto
Interface IBasicMap2

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IBasicMap2Proxy, Map

public interface IBasicMap2
extends java.io.Serializable

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

Description: 'Provides access to members that control the basic map.' 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	IID47fa77fa_2f59_42b9_9048_7b139da3fe26
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addLayer(ILayer pLayer) Adds a layer to the map.
void	addLayers(IEnumLayer pLayers, boolean autoArrange) Adds multiple layers to the map, arranging them nicely if specified.
void	clearLayers() Removes all layers from the map.
void	clearSelection() Clears the map selection.
void	deleteLayer(ILayer pLayer) Deletes a layer from the map.
ILayer	getActiveGraphicsLayer() The active graphics layer.
IGraphicsLayer	getBasicGraphicsLayer() The basic graphics layer.
java.lang.String	getCopyrightText() Copyright information associated with the map.
java.lang.String	getDescription() Description of the map.
ISelection	getFeatureSelection() The map's feature selection.
ILayer	getLayer(int index) The layer at the given index.
int	getLayerCount() Number of layers in the map.
IEnumLayer	getLayers(IUID uid, boolean recursive) The layers in the map of the type specified in the uid.
java.lang.String	getName() Name of the map.
int	getSelectionCount() Number of selected features in the map.
ISpatialReference	getSpatialReference() The spatial reference of the map.
void	selectByShape(IGeometry shape, ISelectionEnvironment env, boolean justOne) Selects features in the map given a shape and a selection environment (optional).
void	setActiveGraphicsLayerByRef(ILayer ppGraphicsLayer) The active graphics layer.
void	setAreaOfInterest(IEnvelope rhs1) Area of interest for the map.
void	setCopyrightText(java.lang.String copyright) Copyright information associated with the map.
void	setDescription(java.lang.String pDescr) Description of the map.
void	setFeatureSelectionByRef(ISelection ppSelection) The map's feature selection.
void	setName(java.lang.String pName) Name of the map.
void	setSpatialReferenceByRef(ISpatialReference ppSpatialRef) The spatial reference of the map.

Field Detail

IID47fa77fa_2f59_42b9_9048_7b139da3fe26

static final int IID47fa77fa_2f59_42b9_9048_7b139da3fe26

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

getCopyrightText

java.lang.String getCopyrightText()
                                  throws java.io.IOException,
                                         AutomationException

Copyright information associated with the map.

Returns:

The copyright

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCopyrightText

void setCopyrightText(java.lang.String copyright)
                      throws java.io.IOException,
                             AutomationException

Copyright information associated with the map.

Parameters:

copyright - The copyright (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

Name of the map.

Returns:

The pName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

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

Name of the map.

Parameters:

pName - The pName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException

Description of the map.

Returns:

The pDescr

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(java.lang.String pDescr)
                    throws java.io.IOException,
                           AutomationException

Description of the map.

Parameters:

pDescr - The pDescr (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAreaOfInterest

void setAreaOfInterest(IEnvelope rhs1)
                       throws java.io.IOException,
                              AutomationException

Area of interest for the map.

Parameters:

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

getLayerCount

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

Number of layers in the map.

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayer

ILayer getLayer(int index)
                throws java.io.IOException,
                       AutomationException

The layer at the given index.

Parameters:

index - The index (in)

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.

getLayers

IEnumLayer getLayers(IUID uid,
                     boolean recursive)
                     throws java.io.IOException,
                            AutomationException

The layers in the map of the type specified in the uid. If recursive is true it will return layers in group layers.

Parameters:

uid - A reference to a com.esri.arcgis.system.IUID (in, optional, pass 0 if not required)

recursive - The recursive (in, optional, pass true if not required)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

The spatial reference of the map.

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

void setSpatialReferenceByRef(ISpatialReference ppSpatialRef)
                              throws java.io.IOException,
                                     AutomationException

The spatial reference of the map.

Parameters:

ppSpatialRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addLayer

void addLayer(ILayer pLayer)
              throws java.io.IOException,
                     AutomationException

Adds a layer to the map.

Parameters:

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

addLayers

void addLayers(IEnumLayer pLayers,
               boolean autoArrange)
               throws java.io.IOException,
                      AutomationException

Adds multiple layers to the map, arranging them nicely if specified.

Parameters:

pLayers - A reference to a com.esri.arcgis.carto.IEnumLayer (in)

autoArrange - The autoArrange (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteLayer

void deleteLayer(ILayer pLayer)
                 throws java.io.IOException,
                        AutomationException

Deletes a layer from the map.

Parameters:

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

clearLayers

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

Removes all layers from the map.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBasicGraphicsLayer

IGraphicsLayer getBasicGraphicsLayer()
                                     throws java.io.IOException,
                                            AutomationException

The basic graphics layer.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getActiveGraphicsLayer

ILayer getActiveGraphicsLayer()
                              throws java.io.IOException,
                                     AutomationException

The active graphics layer. If no graphic layers exist a basic memory graphics layer will be created.

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.

setActiveGraphicsLayerByRef

void setActiveGraphicsLayerByRef(ILayer ppGraphicsLayer)
                                 throws java.io.IOException,
                                        AutomationException

The active graphics layer. If no graphic layers exist a basic memory graphics layer will be created.

Parameters:

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

getSelectionCount

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

Number of selected features in the map.

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearSelection

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

Clears the map selection.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureSelection

ISelection getFeatureSelection()
                               throws java.io.IOException,
                                      AutomationException

The map's feature selection.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFeatureSelectionByRef

void setFeatureSelectionByRef(ISelection ppSelection)
                              throws java.io.IOException,
                                     AutomationException

The map's feature selection.

Parameters:

ppSelection - A reference to a com.esri.arcgis.carto.ISelection (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

selectByShape

void selectByShape(IGeometry shape,
                   ISelectionEnvironment env,
                   boolean justOne)
                   throws java.io.IOException,
                          AutomationException

Selects features in the map given a shape and a selection environment (optional).

Parameters:

shape - A reference to a com.esri.arcgis.geometry.IGeometry (in)

env - A reference to a com.esri.arcgis.carto.ISelectionEnvironment (in)

justOne - The justOne (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.