com.esri.arcgis.carto
Interface IMapLayers

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IMapLayers2

All Known Implementing Classes:

IMapLayers2Proxy, IMapLayersProxy, Map, Scene

public interface IMapLayers
extends java.io.Serializable

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

Description: 'Provides access to layers.' 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	IID76da57e7_6a92_4090_8ca9_f5d9eca78353
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addLayer(ILayer layer) Adds a layer to the map.
void	addLayers(IEnumLayer layers, boolean autoArrange) Adds multiple layers to the map, arranging them nicely if specified.
void	clearLayers() Removes all layers from the map.
void	deleteLayer(ILayer layer) Deletes a layer from the map.
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.
void	insertLayer(ILayer pLayer, boolean autoArrange, int position) Inserts a layer at the given position.
void	insertLayerInGroup(IGroupLayer pGroup, ILayer pLayer, boolean autoArrange, int position) Inserts a layer at a given index of the map's group layer.
void	insertLayers(IEnumLayer pLayers, boolean autoArrange, int position) Inserts layers at the given position.
void	insertLayersInGroup(IGroupLayer pGroup, IEnumLayer pLayer, boolean autoArrange, int position) Inserts layers at a given index of the map's group layer.
boolean	isLayerVisible(ILayer layer) Check if layer is visible.
void	moveLayer(ILayer layer, int toIndex) Moves a layer to another position.
void	moveLayerEx(IGroupLayer pFromGroup, IGroupLayer pToGroup, ILayer pLayer, int newPosition) Moves the layer with in the map.

Field Detail

IID76da57e7_6a92_4090_8ca9_f5d9eca78353

static final int IID76da57e7_6a92_4090_8ca9_f5d9eca78353

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

getLayerCount

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

Number of layers in the map.

Returns:

The count

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.

addLayer

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

Adds a layer to the map.

Parameters:

layer - 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 layers,
               boolean autoArrange)
               throws java.io.IOException,
                      AutomationException

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

Parameters:

layers - 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 layer)
                 throws java.io.IOException,
                        AutomationException

Deletes a layer from the map.

Parameters:

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

moveLayer

void moveLayer(ILayer layer,
               int toIndex)
               throws java.io.IOException,
                      AutomationException

Moves a layer to another position.

Parameters:

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

toIndex - The toIndex (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.

isLayerVisible

boolean isLayerVisible(ILayer layer)
                       throws java.io.IOException,
                              AutomationException

Check if layer is visible.

Parameters:

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

Returns:

The isLayerVisible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

insertLayer

void insertLayer(ILayer pLayer,
                 boolean autoArrange,
                 int position)
                 throws java.io.IOException,
                        AutomationException

Inserts a layer at the given position.

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

autoArrange - The autoArrange (in)

position - The position (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

insertLayers

void insertLayers(IEnumLayer pLayers,
                  boolean autoArrange,
                  int position)
                  throws java.io.IOException,
                         AutomationException

Inserts layers at the given position.

Parameters:

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

autoArrange - The autoArrange (in)

position - The position (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

insertLayerInGroup

void insertLayerInGroup(IGroupLayer pGroup,
                        ILayer pLayer,
                        boolean autoArrange,
                        int position)
                        throws java.io.IOException,
                               AutomationException

Inserts a layer at a given index of the map's group layer.

Parameters:

pGroup - A reference to a com.esri.arcgis.carto.IGroupLayer (in)

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

autoArrange - The autoArrange (in)

position - The position (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

insertLayersInGroup

void insertLayersInGroup(IGroupLayer pGroup,
                         IEnumLayer pLayer,
                         boolean autoArrange,
                         int position)
                         throws java.io.IOException,
                                AutomationException

Inserts layers at a given index of the map's group layer.

Parameters:

pGroup - A reference to a com.esri.arcgis.carto.IGroupLayer (in)

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

autoArrange - The autoArrange (in)

position - The position (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

moveLayerEx

void moveLayerEx(IGroupLayer pFromGroup,
                 IGroupLayer pToGroup,
                 ILayer pLayer,
                 int newPosition)
                 throws java.io.IOException,
                        AutomationException

Moves the layer with in the map.

Parameters:

pFromGroup - A reference to a com.esri.arcgis.carto.IGroupLayer (in)

pToGroup - A reference to a com.esri.arcgis.carto.IGroupLayer (in)

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

newPosition - The newPosition (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.