com.esri.arcgis.carto
Class LayerDescriptor

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

All Implemented Interfaces:

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

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

The Layer Descriptor coclass contains a description of a layer in a map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

LayerDescriptor()
Constructs a LayerDescriptor using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
String	getDefinitionExpression() The definition expression for the layer.
int	getID() The layer ID.
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	setDefinitionExpression(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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

LayerDescriptor

public LayerDescriptor()
                throws IOException,
                       UnknownHostException

Constructs a LayerDescriptor using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

LayerDescriptor

public LayerDescriptor(Object obj)
                throws 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:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getID

public int getID()
          throws 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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getID in interface ILayerDescriptor

Returns:

The layerID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setID

public void setID(int layerID)
           throws 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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setID in interface ILayerDescriptor

Parameters:

layerID - The layerID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface ILayerDescriptor

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates whether the layer is visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isVisible in interface ILayerDescriptor

Returns:

The visible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws IOException,
                       AutomationException

Indicates whether the layer is visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setVisible in interface ILayerDescriptor

Parameters:

visible - The visible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowLabels

public boolean isShowLabels()
                     throws IOException,
                            AutomationException

Indicates whether the layer should display its dynamic labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isShowLabels in interface ILayerDescriptor

Returns:

The show

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowLabels

public void setShowLabels(boolean show)
                   throws IOException,
                          AutomationException

Indicates whether the layer should display its dynamic labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShowLabels in interface ILayerDescriptor

Parameters:

show - The show (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTransparency

public short getTransparency()
                      throws 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).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTransparency in interface ILayerDescriptor

Returns:

The alphaValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransparency

public void setTransparency(short alphaValue)
                     throws 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).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTransparency in interface ILayerDescriptor

Parameters:

alphaValue - The alphaValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectionFilters

public void setSelectionFilters(IArray rhs1)
                         throws 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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSelectionFilters in interface ILayerDescriptor

Parameters:

rhs1 - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectionBufferDistance

public double getSelectionBufferDistance()
                                  throws 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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSelectionBufferDistance in interface ILayerDescriptor

Returns:

The distance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectionBufferDistance

public void setSelectionBufferDistance(double distance)
                                throws 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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSelectionBufferDistance in interface ILayerDescriptor

Parameters:

distance - The distance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowSelectionBuffer

public boolean isShowSelectionBuffer()
                              throws IOException,
                                     AutomationException

Indicates whether the selection buffer should be displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isShowSelectionBuffer in interface ILayerDescriptor

Returns:

The show

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowSelectionBuffer

public void setShowSelectionBuffer(boolean show)
                            throws IOException,
                                   AutomationException

Indicates whether the selection buffer should be displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShowSelectionBuffer in interface ILayerDescriptor

Parameters:

show - The show (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefinitionExpression

public String getDefinitionExpression()
                               throws IOException,
                                      AutomationException

The definition expression for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefinitionExpression in interface ILayerDescriptor

Returns:

The expression

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefinitionExpression

public void setDefinitionExpression(String expression)
                             throws IOException,
                                    AutomationException

The definition expression for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefinitionExpression in interface ILayerDescriptor

Parameters:

expression - The expression (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.