com.esri.arcgis.controls
Class IARLayerProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.controls.IARLayerProxy

All Implemented Interfaces:

IARLayer, Externalizable, Serializable

public class IARLayerProxy
extends com.esri.arcgis.interop.Dispatch
implements IARLayer, Serializable

Provides access to members that control the ARLayer.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E

Constructor Summary

	IARLayerProxy()
	IARLayerProxy(Object obj)
protected	IARLayerProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
int	getARLayerCount() The number of child layers in a group layer.
IARLayer	getChildARLayer(int index) The child layer at the specifid index of a group layer.
Object	getCustomProperty() A property to associate data with an object.
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.
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.
String	getName() The name of the layer.
String	getType() The description of the type of layer.
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.
void	readExternal(ObjectInput in)
void	removeListener(String iidStr, Object theListener)
IARFeatureCursor	searchARFeatures(IARSearchDef pSearchDef) Searches the layer using a search definition and returns an ARFeatureCursor.
void	setCustomProperty(Object pVal) A property to associate data with an object.
void	setVisible(boolean visible) Indicates if the layer is currently visible.
void	writeExternal(ObjectOutput out)

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke

Methods inherited from class java.lang.Object

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

Constructor Detail

IARLayerProxy

public IARLayerProxy()

IARLayerProxy

public IARLayerProxy(Object obj)
              throws IOException

Throws:

IOException

IARLayerProxy

protected IARLayerProxy(Object obj,
                        String iid)
                 throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the layer.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getName in interface IARLayer

Returns:

The sName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHyperlinks

public boolean isHyperlinks()
                     throws IOException,
                            AutomationException

Indicates if the layer contains hyperlinks.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

isHyperlinks in interface IARLayer

Returns:

The bHasHyperlinks

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 if the layer is currently visible.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setVisible in interface IARLayer

Parameters:

visible - The visible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the layer is currently visible.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

isVisible in interface IARLayer

Returns:

The visible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumScale

public double getMaximumScale()
                       throws IOException,
                              AutomationException

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getMaximumScale in interface IARLayer

Returns:

The maxScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumScale

public double getMinimumScale()
                       throws IOException,
                              AutomationException

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getMinimumScale in interface IARLayer

Returns:

The minScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCached

public boolean isCached()
                 throws IOException,
                        AutomationException

Indicates if the layer has its own display cache.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

isCached in interface IARLayer

Returns:

The cached

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isGroupLayer

public boolean isGroupLayer()
                     throws IOException,
                            AutomationException

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

isGroupLayer in interface IARLayer

Returns:

The groupLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getARLayerCount

public int getARLayerCount()
                    throws IOException,
                           AutomationException

The number of child layers in a group layer.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getARLayerCount in interface IARLayer

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildARLayer

public IARLayer getChildARLayer(int index)
                         throws IOException,
                                AutomationException

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getChildARLayer in interface IARLayer

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

searchARFeatures

public IARFeatureCursor searchARFeatures(IARSearchDef pSearchDef)
                                  throws IOException,
                                         AutomationException

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

The description of the layer.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getDescription in interface IARLayer

Returns:

The sDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSearchable

public boolean isSearchable()
                     throws IOException,
                            AutomationException

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

isSearchable in interface IARLayer

Returns:

The bSearchable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInternalObject

public Object getInternalObject()
                         throws IOException,
                                AutomationException

The internal ArcObjects ILayer object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getInternalObject in interface IARLayer

Returns:

A reference to another Object (IUnknown)

Throws:

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 IOException,
                      AutomationException

The extent of the data within the layer.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomProperty

public Object getCustomProperty()
                         throws IOException,
                                AutomationException

A property to associate data with an object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getCustomProperty in interface IARLayer

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomProperty

public void setCustomProperty(Object pVal)
                       throws IOException,
                              AutomationException

A property to associate data with an object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setCustomProperty in interface IARLayer

Parameters:

pVal - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

public String getType()
               throws IOException,
                      AutomationException

The description of the type of layer.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getType in interface IARLayer

Returns:

The sDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryARFeatures

public IARFeatureSet queryARFeatures(IARSearchDef pSearchDef)
                              throws IOException,
                                     AutomationException

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

ClassNotFoundException