com.esri.arcgis.carto
Class LayerDescriptor

java.lang.Object
  com.esri.arcgis.carto.LayerDescriptor

All Implemented Interfaces:

ILayerDescriptor, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class LayerDescriptor
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ILayerDescriptor

COM Class 'LayerDescriptor'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'The Layer Descriptor coclass contains a description of a layer in a map.' 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.carto.ILayerDescriptor

DISPID_0_GET_NAME, DISPID_0_PUT_NAME, DISPID_1_GET_NAME, DISPID_2_GET_NAME, DISPID_2_PUT_NAME, DISPID_3_GET_NAME, DISPID_3_PUT_NAME, DISPID_4_GET_NAME, DISPID_4_PUT_NAME, DISPID_5_PUT_NAME, DISPID_6_GET_NAME, DISPID_6_PUT_NAME, DISPID_7_GET_NAME, DISPID_7_PUT_NAME, DISPID_8_GET_NAME, DISPID_8_PUT_NAME, IID, IID3b2dee7b_641e_48ff_a9cd_d2458c0a5861, xxDummy

Constructor Summary

LayerDescriptor()
Constructs a LayerDescriptor using ArcGIS Engine.

LayerDescriptor(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LayerDescriptor theLayerDescriptor = (LayerDescriptor) obj;

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
java.lang.String	getDefinitionExpression() The definition expression for the layer.
int	getID() The layer ID.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getName() The name of the layer.
double	getSelectionBufferDistance() The selection buffer distance.
short	getTransparency() The transparency of the layer.
int	hashCode() the hashcode for this object
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	release() Release a LayerDescriptor.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

LayerDescriptor

public LayerDescriptor()
                throws java.io.IOException,
                       java.net.UnknownHostException

Constructs a LayerDescriptor using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

LayerDescriptor

public LayerDescriptor(java.lang.Object obj)
                throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LayerDescriptor theLayerDescriptor = (LayerDescriptor) obj;

Construct a LayerDescriptor using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to LayerDescriptor.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a LayerDescriptor.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getID

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

Specified by:

getID in interface ILayerDescriptor

Returns:

The layerID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setID

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

Specified by:

setID in interface ILayerDescriptor

Parameters:

layerID - The layerID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the layer.

Specified by:

getName in interface ILayerDescriptor

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws java.io.IOException,
                         AutomationException

Indicates whether the layer is visible.

Specified by:

isVisible in interface ILayerDescriptor

Returns:

The visible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws java.io.IOException,
                       AutomationException

Indicates whether the layer is visible.

Specified by:

setVisible in interface ILayerDescriptor

Parameters:

visible - The visible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowLabels

public boolean isShowLabels()
                     throws java.io.IOException,
                            AutomationException

Indicates whether the layer should display its dynamic labels.

Specified by:

isShowLabels in interface ILayerDescriptor

Returns:

The show

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowLabels

public void setShowLabels(boolean show)
                   throws java.io.IOException,
                          AutomationException

Indicates whether the layer should display its dynamic labels.

Specified by:

setShowLabels in interface ILayerDescriptor

Parameters:

show - The show (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTransparency

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

Specified by:

getTransparency in interface ILayerDescriptor

Returns:

The alphaValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTransparency

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

Specified by:

setTransparency in interface ILayerDescriptor

Parameters:

alphaValue - The alphaValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSelectionFilters

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

Specified by:

setSelectionFilters in interface ILayerDescriptor

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

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

Specified by:

getSelectionBufferDistance in interface ILayerDescriptor

Returns:

The distance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSelectionBufferDistance

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

Specified by:

setSelectionBufferDistance in interface ILayerDescriptor

Parameters:

distance - The distance (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowSelectionBuffer

public boolean isShowSelectionBuffer()
                              throws java.io.IOException,
                                     AutomationException

Indicates whether the selection buffer should be displayed.

Specified by:

isShowSelectionBuffer in interface ILayerDescriptor

Returns:

The show

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowSelectionBuffer

public void setShowSelectionBuffer(boolean show)
                            throws java.io.IOException,
                                   AutomationException

Indicates whether the selection buffer should be displayed.

Specified by:

setShowSelectionBuffer in interface ILayerDescriptor

Parameters:

show - The show (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefinitionExpression

public java.lang.String getDefinitionExpression()
                                         throws java.io.IOException,
                                                AutomationException

The definition expression for the layer.

Specified by:

getDefinitionExpression in interface ILayerDescriptor

Returns:

The expression

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefinitionExpression

public void setDefinitionExpression(java.lang.String expression)
                             throws java.io.IOException,
                                    AutomationException

The definition expression for the layer.

Specified by:

setDefinitionExpression in interface ILayerDescriptor

Parameters:

expression - The expression (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.