com.esri.arcgis.carto
Class IBasemapLayerProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.carto.IBasemapLayerProxy

All Implemented Interfaces:

IBasemapLayer, Externalizable, Serializable

public class IBasemapLayerProxy
extends com.esri.arcgis.interop.Dispatch
implements IBasemapLayer, 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.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IBasemapLayerProxy()
	IBasemapLayerProxy(Object obj)
protected	IBasemapLayerProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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	removeListener(String iidStr, Object theListener)
void	setShadersByRef(IArrayOfIShader shaders) Get array of pixel shaders.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IBasemapLayerProxy

public IBasemapLayerProxy()

IBasemapLayerProxy

public IBasemapLayerProxy(Object obj)
                   throws IOException

Throws:

IOException

IBasemapLayerProxy

protected IBasemapLayerProxy(Object obj,
                             String iid)
                      throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

notifyLayerChanged

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

Specified by:

notifyLayerChanged in interface IBasemapLayer

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

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

Specified by:

getConversionStatus in interface IBasemapLayer

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

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

Specified by:

getLayerWrapper in interface IBasemapLayer

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

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

Specified by:

findLayerWrapper in interface IBasemapLayer

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

public boolean canDraw()
                throws IOException,
                       AutomationException

Returns True, if the layer draws something.

Product Availability

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

Specified by:

canDraw in interface IBasemapLayer

Returns:

The bYesNo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

invalidateCache

public void invalidateCache()
                     throws IOException,
                            AutomationException

Invalidates layer's cache.

Product Availability

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

Specified by:

invalidateCache in interface IBasemapLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShaders

public IArrayOfIShader getShaders()
                           throws IOException,
                                  AutomationException

Get array of pixel shaders.

Product Availability

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

Specified by:

getShaders in interface IBasemapLayer

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

public void setShadersByRef(IArrayOfIShader shaders)
                     throws IOException,
                            AutomationException

Get array of pixel shaders.

Product Availability

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

Specified by:

setShadersByRef in interface IBasemapLayer

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

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

Specified by:

notifyMapPropertiesChanged in interface IBasemapLayer

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

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

Specified by:

hasSufficientMemory in interface IBasemapLayer

Parameters:

numberOfAdditionalBasemapLayers - The numberOfAdditionalBasemapLayers (in)

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.