com.esri.arcgis.carto
Interface ILayerMasking

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

BasemapLayer, GroupLayer, ILayerMaskingProxy, Map, MosaicLayer, ProcessLayer

public interface ILayerMasking
extends java.io.Serializable

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

Description: 'Provides access to means to mask layers with other 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	IID536427da_5354_491d_ae92_abebaa8bb05b
static int	xxDummy Deprecated. Internal use only

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.

Field Detail

IID536427da_5354_491d_ae92_abebaa8bb05b

static final int IID536427da_5354_491d_ae92_abebaa8bb05b

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

setUseMasking

void setUseMasking(boolean flag)
                   throws java.io.IOException,
                          AutomationException

Indicates whether to use masking.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseMasking

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

Indicates whether to use masking.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaskingLayers

void setMaskingLayers(ILayer layer,
                      ISet maskingLayers)
                      throws java.io.IOException,
                             AutomationException

The masks for a layer.

Parameters:

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

maskingLayers - A reference to a com.esri.arcgis.system.ISet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaskingLayers

ISet getMaskingLayers(ILayer layer)
                      throws java.io.IOException,
                             AutomationException

The masks for a layer.

Parameters:

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

Returns:

A reference to a com.esri.arcgis.system.ISet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearMasking

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

Clear masking layers on a layer.

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.

getMaskedLayers

ISet getMaskedLayers()
                     throws java.io.IOException,
                            AutomationException

The set of layers that are being masked.

Returns:

A reference to a com.esri.arcgis.system.ISet

Throws:

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

AutomationException - If the ArcObject component throws an exception.