com.esri.arcgis.carto
Interface IBasemapLayer

All Superinterfaces:

Serializable

All Known Implementing Classes:

BasemapLayer, IBasemapLayerProxy

public interface IBasemapLayer
extends Serializable

Provides access to members of a basemap layer.

Remarks

This interface provides access to the management and helper functions of a basemap layer caches and layers.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

boolean	canDraw() Returns True, if the layer draws something.
IBasemapSubLayer	findLayerWrapper(ILayer pLayer) Gets the wrapper for a layer.
int	getConversionStatus(ILayer layer) Indicates the conversion status of a given layer.
IBasemapSubLayer	getLayerWrapper(ILayer layer) Gets the wrapper for a layer.
IArrayOfIShader	getShaders() Get array of pixel shaders.
boolean	hasSufficientMemory(int numberOfAdditionalBasemapLayers) Returns if there is sufficient memory available for the Basemap Layer.
void	invalidateCache() Invalidates layer's cache.
void	notifyLayerChanged(ILayer layer, int eventHint, IVariantArray eventParam) Notify Base map Layer that one of its layers changed.
void	notifyMapPropertiesChanged(IMap pMap, boolean reconvertAll) Notify Base map Layer that the parent Map properties changed.
void	setShadersByRef(IArrayOfIShader shaders) Get array of pixel shaders.

Method Detail

notifyLayerChanged

void notifyLayerChanged(ILayer layer,
                        int eventHint,
                        IVariantArray eventParam)
                        throws IOException,
                               AutomationException

Notify Base map Layer that one of its layers changed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

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

eventHint - A com.esri.arcgis.carto.esriLayerEventHint constant (in)

eventParam - A reference to a com.esri.arcgis.system.IVariantArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConversionStatus

int getConversionStatus(ILayer layer)
                        throws IOException,
                               AutomationException

Indicates the conversion status of a given layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

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

Returns:

A com.esri.arcgis.carto.esriConversionStatus constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerWrapper

IBasemapSubLayer getLayerWrapper(ILayer layer)
                                 throws IOException,
                                        AutomationException

Gets the wrapper for a layer. Creates a new BasemapSubLayer if necessary.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findLayerWrapper

IBasemapSubLayer findLayerWrapper(ILayer pLayer)
                                  throws IOException,
                                         AutomationException

Gets the wrapper for a layer. Returns NULL if no BasemapSubLayer is found.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canDraw

boolean canDraw()
                throws IOException,
                       AutomationException

Returns True, if the layer draws something.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The bYesNo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

invalidateCache

void invalidateCache()
                     throws IOException,
                            AutomationException

Invalidates layer's cache.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShaders

IArrayOfIShader getShaders()
                           throws IOException,
                                  AutomationException

Get array of pixel shaders.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShadersByRef

void setShadersByRef(IArrayOfIShader shaders)
                     throws IOException,
                            AutomationException

Get array of pixel shaders.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

shaders - A reference to a com.esri.arcgis.carto.IArrayOfIShader (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

notifyMapPropertiesChanged

void notifyMapPropertiesChanged(IMap pMap,
                                boolean reconvertAll)
                                throws IOException,
                                       AutomationException

Notify Base map Layer that the parent Map properties changed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pMap - A reference to a com.esri.arcgis.carto.IMap (in)

reconvertAll - The reconvertAll (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasSufficientMemory

boolean hasSufficientMemory(int numberOfAdditionalBasemapLayers)
                            throws IOException,
                                   AutomationException

Returns if there is sufficient memory available for the Basemap Layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

numberOfAdditionalBasemapLayers - The numberOfAdditionalBasemapLayers (in)

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.