com.esri.arcgis.carto
Interface IBasemapLayer

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

BasemapLayer, IBasemapLayerProxy

public interface IBasemapLayer
extends java.io.Serializable

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

Description: 'Provides access to members of a basemap layer.' 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	IIDf9d6aa98_5586_486f_8242_670aedf7860e
static int	xxDummy Deprecated. Internal use only

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.

Field Detail

IIDf9d6aa98_5586_486f_8242_670aedf7860e

static final int IIDf9d6aa98_5586_486f_8242_670aedf7860e

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

notifyLayerChanged

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

Notify Base map Layer that one of its layers changed.

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:

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

AutomationException - If the ArcObject component throws an exception.

getConversionStatus

int getConversionStatus(ILayer layer)
                        throws java.io.IOException,
                               AutomationException

Indicates the conversion status of a given layer.

Parameters:

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

Returns:

A com.esri.arcgis.carto.esriConversionStatus constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayerWrapper

IBasemapSubLayer getLayerWrapper(ILayer layer)
                                 throws java.io.IOException,
                                        AutomationException

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

Parameters:

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findLayerWrapper

IBasemapSubLayer findLayerWrapper(ILayer pLayer)
                                  throws java.io.IOException,
                                         AutomationException

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

Parameters:

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canDraw

boolean canDraw()
                throws java.io.IOException,
                       AutomationException

Returns True, if the layer draws something.

Returns:

The bYesNo

Throws:

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

AutomationException - If the ArcObject component throws an exception.

invalidateCache

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

Invalidates layer's cache.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getShaders

IArrayOfIShader getShaders()
                           throws java.io.IOException,
                                  AutomationException

Get array of pixel shaders.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShadersByRef

void setShadersByRef(IArrayOfIShader shaders)
                     throws java.io.IOException,
                            AutomationException

Get array of pixel shaders.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

notifyMapPropertiesChanged

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

Notify Base map Layer that the parent Map properties changed.

Parameters:

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

reconvertAll - The reconvertAll (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hasSufficientMemory

boolean hasSufficientMemory(int numberOfAdditionalBasemapLayers)
                            throws java.io.IOException,
                                   AutomationException

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

Parameters:

numberOfAdditionalBasemapLayers - The numberOfAdditionalBasemapLayers (in)

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.