com.esri.arcgis.carto
Interface ILayerDescription

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
ILayerDescription2, ILayerDescription3
All Known Implementing Classes:
ILayerDescription2Proxy, ILayerDescription3Proxy, ILayerDescriptionProxy, LayerDescription

public interface ILayerDescription
extends java.io.Serializable

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

Description: 'Provides access to the available properties of a layer description 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 IID
          Deprecated. Internal use only
static int IIDf763bdbe_8ef9_4da8_9628_dbe8ee4eb6de
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 java.lang.String getDefinitionExpression()
          The definition expression for the layer.
 int getID()
          The layer ID.
 double getSelectionBufferDistance()
          The selection buffer distance.
 IColor getSelectionColor()
          The selection color (used when SetSelectionSymbol = FALSE).
 IFIDSet getSelectionFeatures()
          Array of selected features.
 ISymbol getSelectionSymbol()
          The selection symbol.
 boolean isScaleSymbols()
          Indicates whether the layer should scale its symbols according to the reference scale.
 boolean isSetSelectionSymbol()
          Indicates if the selected set of features is drawn using the SelectionSymbol.
 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 as defined in the TOC (i.e.
 void setDefinitionExpression(java.lang.String expression)
          The definition expression for the layer.
 void setID(int layerID)
          The layer ID.
 void setScaleSymbols(boolean scale)
          Indicates whether the layer should scale its symbols according to the reference scale.
 void setSelectionBufferDistance(double distance)
          The selection buffer distance.
 void setSelectionColorByRef(IColor color)
          The selection color (used when SetSelectionSymbol = FALSE).
 void setSelectionFeatures(IFIDSet featureIDs)
          Array of selected features.
 void setSelectionSymbolByRef(ISymbol symbol)
          The selection symbol.
 void setSetSelectionSymbol(boolean setSymbol)
          Indicates if the selected set of features is drawn using the SelectionSymbol.
 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 setVisible(boolean visible)
          Indicates whether the layer is visible as defined in the TOC (i.e.
 

Field Detail

IIDf763bdbe_8ef9_4da8_9628_dbe8ee4eb6de

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

getID

int getID()
          throws java.io.IOException,
                 AutomationException
The layer ID. This is a unique ID for the layer, 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 layer, 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.

isVisible

boolean isVisible()
                  throws java.io.IOException,
                         AutomationException
Indicates whether the layer is visible as defined in the TOC (i.e. marked on).

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 as defined in the TOC (i.e. marked on).

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

isScaleSymbols

boolean isScaleSymbols()
                       throws java.io.IOException,
                              AutomationException
Indicates whether the layer should scale its symbols according to the reference scale.

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

setScaleSymbols

void setScaleSymbols(boolean scale)
                     throws java.io.IOException,
                            AutomationException
Indicates whether the layer should scale its symbols according to the reference scale.

Parameters:
scale - The scale (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.

getSelectionFeatures

IFIDSet getSelectionFeatures()
                             throws java.io.IOException,
                                    AutomationException
Array of selected features.

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

setSelectionFeatures

void setSelectionFeatures(IFIDSet featureIDs)
                          throws java.io.IOException,
                                 AutomationException
Array of selected features.

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

getSelectionColor

IColor getSelectionColor()
                         throws java.io.IOException,
                                AutomationException
The selection color (used when SetSelectionSymbol = FALSE).

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

setSelectionColorByRef

void setSelectionColorByRef(IColor color)
                            throws java.io.IOException,
                                   AutomationException
The selection color (used when SetSelectionSymbol = FALSE).

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

getSelectionSymbol

ISymbol getSelectionSymbol()
                           throws java.io.IOException,
                                  AutomationException
The selection symbol.

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

setSelectionSymbolByRef

void setSelectionSymbolByRef(ISymbol symbol)
                             throws java.io.IOException,
                                    AutomationException
The selection symbol.

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

isSetSelectionSymbol

boolean isSetSelectionSymbol()
                             throws java.io.IOException,
                                    AutomationException
Indicates if the selected set of features is drawn using the SelectionSymbol.

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

setSetSelectionSymbol

void setSetSelectionSymbol(boolean setSymbol)
                           throws java.io.IOException,
                                  AutomationException
Indicates if the selected set of features is drawn using the SelectionSymbol.

Parameters:
setSymbol - The setSymbol (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.