com.esri.arcgis.carto
Interface ILayerDescriptor

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
ILayerDescriptorProxy, LayerDescriptor

public interface ILayerDescriptor
extends java.io.Serializable

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

Description: 'Provides access to the available properties of a layer descriptor object.' 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 DISPID_0_GET_NAME
           
static java.lang.String DISPID_0_PUT_NAME
           
static java.lang.String DISPID_1_GET_NAME
           
static java.lang.String DISPID_2_GET_NAME
           
static java.lang.String DISPID_2_PUT_NAME
           
static java.lang.String DISPID_3_GET_NAME
           
static java.lang.String DISPID_3_PUT_NAME
           
static java.lang.String DISPID_4_GET_NAME
           
static java.lang.String DISPID_4_PUT_NAME
           
static java.lang.String DISPID_5_PUT_NAME
           
static java.lang.String DISPID_6_GET_NAME
           
static java.lang.String DISPID_6_PUT_NAME
           
static java.lang.String DISPID_7_GET_NAME
           
static java.lang.String DISPID_7_PUT_NAME
           
static java.lang.String DISPID_8_GET_NAME
           
static java.lang.String DISPID_8_PUT_NAME
           
static java.lang.String IID
          Deprecated. Internal use only
static int IID3b2dee7b_641e_48ff_a9cd_d2458c0a5861
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 java.lang.String getDefinitionExpression()
          The definition expression for the layer.
 int getID()
          The layer ID.
 java.lang.String getName()
          The name of the layer.
 double getSelectionBufferDistance()
          The selection buffer distance.
 short getTransparency()
          The transparency of the layer.
 boolean isShowLabels()
          Indicates whether the layer should display its dynamic labels.
 boolean isShowSelectionBuffer()
          Indicates whether the selection buffer should be displayed.
 boolean isVisible()
          Indicates whether the layer is visible.
 void setDefinitionExpression(java.lang.String expression)
          The definition expression for the layer.
 void setID(int layerID)
          The layer ID.
 void setSelectionBufferDistance(double distance)
          The selection buffer distance.
 void setSelectionFilters(IArray rhs1)
          The selection filter for the layer.
 void setShowLabels(boolean show)
          Indicates whether the layer should display its dynamic labels.
 void setShowSelectionBuffer(boolean show)
          Indicates whether the selection buffer should be displayed.
 void setTransparency(short alphaValue)
          The transparency of the layer.
 void setVisible(boolean visible)
          Indicates whether the layer is visible.
 

Field Detail

IID3b2dee7b_641e_48ff_a9cd_d2458c0a5861

static final int IID3b2dee7b_641e_48ff_a9cd_d2458c0a5861
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

DISPID_0_GET_NAME

static final java.lang.String DISPID_0_GET_NAME
See Also:
Constant Field Values

DISPID_0_PUT_NAME

static final java.lang.String DISPID_0_PUT_NAME
See Also:
Constant Field Values

DISPID_1_GET_NAME

static final java.lang.String DISPID_1_GET_NAME
See Also:
Constant Field Values

DISPID_2_GET_NAME

static final java.lang.String DISPID_2_GET_NAME
See Also:
Constant Field Values

DISPID_2_PUT_NAME

static final java.lang.String DISPID_2_PUT_NAME
See Also:
Constant Field Values

DISPID_3_GET_NAME

static final java.lang.String DISPID_3_GET_NAME
See Also:
Constant Field Values

DISPID_3_PUT_NAME

static final java.lang.String DISPID_3_PUT_NAME
See Also:
Constant Field Values

DISPID_4_GET_NAME

static final java.lang.String DISPID_4_GET_NAME
See Also:
Constant Field Values

DISPID_4_PUT_NAME

static final java.lang.String DISPID_4_PUT_NAME
See Also:
Constant Field Values

DISPID_5_PUT_NAME

static final java.lang.String DISPID_5_PUT_NAME
See Also:
Constant Field Values

DISPID_6_GET_NAME

static final java.lang.String DISPID_6_GET_NAME
See Also:
Constant Field Values

DISPID_6_PUT_NAME

static final java.lang.String DISPID_6_PUT_NAME
See Also:
Constant Field Values

DISPID_7_GET_NAME

static final java.lang.String DISPID_7_GET_NAME
See Also:
Constant Field Values

DISPID_7_PUT_NAME

static final java.lang.String DISPID_7_PUT_NAME
See Also:
Constant Field Values

DISPID_8_GET_NAME

static final java.lang.String DISPID_8_GET_NAME
See Also:
Constant Field Values

DISPID_8_PUT_NAME

static final java.lang.String DISPID_8_PUT_NAME
See Also:
Constant Field Values
Method Detail

getID

int getID()
          throws java.io.IOException,
                 AutomationException
The layer ID. This is a unique ID for the map, and is used to identify the layer in a number of method calls.

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

setID

void setID(int layerID)
           throws java.io.IOException,
                  AutomationException
The layer ID. This is a unique ID for the map, and is used to identify the layer in a number of method calls.

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

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
The name of the layer.

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

isVisible

boolean isVisible()
                  throws java.io.IOException,
                         AutomationException
Indicates whether the layer is visible.

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

setVisible

void setVisible(boolean visible)
                throws java.io.IOException,
                       AutomationException
Indicates whether the layer is visible.

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

isShowLabels

boolean isShowLabels()
                     throws java.io.IOException,
                            AutomationException
Indicates whether the layer should display its dynamic labels.

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

setShowLabels

void setShowLabels(boolean show)
                   throws java.io.IOException,
                          AutomationException
Indicates whether the layer should display its dynamic labels.

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

getTransparency

short getTransparency()
                      throws java.io.IOException,
                             AutomationException
The transparency of the layer. The value represents the percentage of transparency, and should range from 0 (no transparency) to 100 (completely transparent).

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

setTransparency

void setTransparency(short alphaValue)
                     throws java.io.IOException,
                            AutomationException
The transparency of the layer. The value represents the percentage of transparency, and should range from 0 (no transparency) to 100 (completely transparent).

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

setSelectionFilters

void setSelectionFilters(IArray rhs1)
                         throws java.io.IOException,
                                AutomationException
The selection filter for the layer. When drawing, the filter will be applied and the resulting selection will be displayed on the map.

Parameters:
rhs1 - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectionBufferDistance

double getSelectionBufferDistance()
                                  throws java.io.IOException,
                                         AutomationException
The selection buffer distance. When drawing, and if a selection filter is specified, a buffer zone of the specified distance will be displayed around the selected features.

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

setSelectionBufferDistance

void setSelectionBufferDistance(double distance)
                                throws java.io.IOException,
                                       AutomationException
The selection buffer distance. When drawing, and if a selection filter is specified, a buffer zone of the specified distance will be displayed around the selected features.

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

isShowSelectionBuffer

boolean isShowSelectionBuffer()
                              throws java.io.IOException,
                                     AutomationException
Indicates whether the selection buffer should be displayed.

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

setShowSelectionBuffer

void setShowSelectionBuffer(boolean show)
                            throws java.io.IOException,
                                   AutomationException
Indicates whether the selection buffer should be displayed.

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

getDefinitionExpression

java.lang.String getDefinitionExpression()
                                         throws java.io.IOException,
                                                AutomationException
The definition expression for the layer.

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

setDefinitionExpression

void setDefinitionExpression(java.lang.String expression)
                             throws java.io.IOException,
                                    AutomationException
The definition expression for the layer.

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