com.esri.arcgis.carto
Interface ILayerMasking

All Superinterfaces:
Serializable
All Known Implementing Classes:
GroupLayer, Map, ProcessLayer

public interface ILayerMasking
extends Serializable

Provides access to means to mask layers with other layers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void clearMasking(ILayer layer)
          Clear masking layers on a layer.
 ISet getMaskedLayers()
          The set of layers that are being masked.
 ISet getMaskingLayers(ILayer layer)
          The masks for a layer.
 boolean isUseMasking()
          Indicates whether to use masking.
 void setMaskingLayers(ILayer layer, ISet maskingLayers)
          The masks for a layer.
 void setUseMasking(boolean flag)
          Indicates whether to use masking.
 

Method Detail

setUseMasking

void setUseMasking(boolean flag)
                   throws IOException,
                          AutomationException
Indicates whether to use masking.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseMasking

boolean isUseMasking()
                     throws IOException,
                            AutomationException
Indicates whether to use masking.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaskingLayers

void setMaskingLayers(ILayer layer,
                      ISet maskingLayers)
                      throws IOException,
                             AutomationException
The masks for a layer.

Product Availability

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

Parameters:
layer - A reference to a com.esri.arcgis.carto.ILayer (in)
maskingLayers - A reference to a com.esri.arcgis.system.ISet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaskingLayers

ISet getMaskingLayers(ILayer layer)
                      throws IOException,
                             AutomationException
The masks for a 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 reference to a com.esri.arcgis.system.ISet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearMasking

void clearMasking(ILayer layer)
                  throws IOException,
                         AutomationException
Clear masking layers on a layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
layer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaskedLayers

ISet getMaskedLayers()
                     throws IOException,
                            AutomationException
The set of layers that are being masked.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.system.ISet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.