com.esri.arcgis.controls
Class ARLayer

java.lang.Object
  com.esri.arcgis.controls.ARLayer

All Implemented Interfaces:

IARLayer, java.io.Serializable

public class ARLayer

extends java.lang.Object

implements IARLayer

ARLayer object.

Product Availability

Available with ArcGIS Engine.

See Also:

Serialized Form

Constructor Summary

ARLayer(java.lang.Object obj)
Construct a ARLayer using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
int	getARLayerCount() The number of child layers in a group layer.
IARLayer	getAsIARLayer() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IARLayer	getChildARLayer(int index) The child layer at the specifid index of a group layer.
java.lang.Object	getCustomProperty() A property to associate data with an object.
java.lang.String	getDescription() The description of the layer.
void	getExtent(double[] xMin, double[] yMin, double[] xMax, double[] yMax) The extent of the data within the layer.
java.lang.Object	getInternalObject() The internal ArcObjects ILayer object.
double	getMaximumScale() Maximum scale (representative fraction) at which the layer will display.
double	getMinimumScale() Minimum scale (representative fraction) at which the layer will display.
java.lang.String	getName() The name of the layer.
java.lang.String	getType() The description of the type of layer.
int	hashCode() the hashcode for this object
boolean	isCached() Indicates if the layer has its own display cache.
boolean	isGroupLayer() Indicates if the layer is a group of layers behaving like a single layer.
boolean	isHyperlinks() Indicates if the layer contains hyperlinks.
boolean	isSearchable() Indicates if the layer is searchable (only feature layers are searchable).
boolean	isVisible() Indicates if the layer is currently visible.
IARFeatureSet	queryARFeatures(IARSearchDef pSearchDef) Searches the layer using a search definition and returns an ARFeatureSet.
IARFeatureCursor	searchARFeatures(IARSearchDef pSearchDef) Searches the layer using a search definition and returns an ARFeatureCursor.
void	setCustomProperty(java.lang.Object pVal) A property to associate data with an object.
void	setVisible(boolean visible) Indicates if the layer is currently visible.

Methods inherited from class java.lang.Object

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

Constructor Detail

ARLayer

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

Construct a ARLayer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ARLayer.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
ARLayer o = (ARLayer)obj; // will not work

ARLayer o = new ARLayer(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server ARLayer theARLayer = (ARLayer) obj;

Throws:

java.io.IOException - if there are interop problems

Method Detail

getAsIARLayer

public IARLayer getAsIARLayer()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getName

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

Description copied from interface: IARLayer

The name of the layer.

Specified by:

getName in interface IARLayer

Returns:

The sName

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isHyperlinks

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

Description copied from interface: IARLayer

Indicates if the layer contains hyperlinks.

Specified by:

isHyperlinks in interface IARLayer

Returns:

The bHasHyperlinks

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

Description copied from interface: IARLayer

Indicates if the layer is currently visible.

Specified by:

setVisible in interface IARLayer

Parameters:

visible - The visible (in)

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

Description copied from interface: IARLayer

Indicates if the layer is currently visible.

Specified by:

isVisible in interface IARLayer

Returns:

The visible

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getMaximumScale

public double getMaximumScale()
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IARLayer

Maximum scale (representative fraction) at which the layer will display.

Specified by:

getMaximumScale in interface IARLayer

Returns:

The maxScale

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getMinimumScale

public double getMinimumScale()
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IARLayer

Minimum scale (representative fraction) at which the layer will display.

Specified by:

getMinimumScale in interface IARLayer

Returns:

The minScale

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isCached

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

Description copied from interface: IARLayer

Indicates if the layer has its own display cache.

Specified by:

isCached in interface IARLayer

Returns:

The cached

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isGroupLayer

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

Description copied from interface: IARLayer

Indicates if the layer is a group of layers behaving like a single layer.

Specified by:

isGroupLayer in interface IARLayer

Returns:

The groupLayer

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getARLayerCount

public int getARLayerCount()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IARLayer

The number of child layers in a group layer.

Specified by:

getARLayerCount in interface IARLayer

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getChildARLayer

public IARLayer getChildARLayer(int index)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IARLayer

The child layer at the specifid index of a group layer.

Specified by:

getChildARLayer in interface IARLayer

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.controls.IARLayer

Throws:

AutomationException - If the ArcObject component throws an exception.

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

searchARFeatures

public IARFeatureCursor searchARFeatures(IARSearchDef pSearchDef)
                                  throws java.io.IOException,
                                         AutomationException

Description copied from interface: IARLayer

Searches the layer using a search definition and returns an ARFeatureCursor.

Specified by:

searchARFeatures in interface IARLayer

Parameters:

pSearchDef - A reference to a com.esri.arcgis.controls.IARSearchDef (in)

Returns:

A reference to a com.esri.arcgis.controls.IARFeatureCursor

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getDescription

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

Description copied from interface: IARLayer

The description of the layer.

Specified by:

getDescription in interface IARLayer

Returns:

The sDescription

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isSearchable

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

Description copied from interface: IARLayer

Indicates if the layer is searchable (only feature layers are searchable).

Specified by:

isSearchable in interface IARLayer

Returns:

The bSearchable

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getInternalObject

public java.lang.Object getInternalObject()
                                   throws java.io.IOException,
                                          AutomationException

Description copied from interface: IARLayer

The internal ArcObjects ILayer object.

Specified by:

getInternalObject in interface IARLayer

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtent

public void getExtent(double[] xMin,
                      double[] yMin,
                      double[] xMax,
                      double[] yMax)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IARLayer

The extent of the data within the layer.

Specified by:

getExtent in interface IARLayer

Parameters:

xMin - The xMin (in/out: use single element array)

yMin - The yMin (in/out: use single element array)

xMax - The xMax (in/out: use single element array)

yMax - The yMax (in/out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getCustomProperty

public java.lang.Object getCustomProperty()
                                   throws java.io.IOException,
                                          AutomationException

Description copied from interface: IARLayer

A property to associate data with an object.

Specified by:

getCustomProperty in interface IARLayer

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCustomProperty

public void setCustomProperty(java.lang.Object pVal)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IARLayer

A property to associate data with an object.

Specified by:

setCustomProperty in interface IARLayer

Parameters:

pVal - A Variant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getType

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

Description copied from interface: IARLayer

The description of the type of layer.

Specified by:

getType in interface IARLayer

Returns:

The sDescription

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryARFeatures

public IARFeatureSet queryARFeatures(IARSearchDef pSearchDef)
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: IARLayer

Searches the layer using a search definition and returns an ARFeatureSet.

Specified by:

queryARFeatures in interface IARLayer

Parameters:

pSearchDef - A reference to a com.esri.arcgis.controls.IARSearchDef (in)

Returns:

A reference to a com.esri.arcgis.controls.IARFeatureSet

Throws:

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

AutomationException - If the ArcObject component throws an exception.