com.esri.arcgis.controls
Class IARLayerProxy

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

All Implemented Interfaces:

IARLayer, java.io.Externalizable, java.io.Serializable

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

Internal use class Proxy for COM Interface 'IARLayer'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriPublisherControls.olb'

Description: 'Provides access to members that control the ARLayer.' 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

boolean	noncastable
static java.lang.Class	targetClass

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Fields inherited from interface com.esri.arcgis.controls.IARLayer

DISPID_1_GET_NAME, DISPID_10_NAME, DISPID_11_GET_NAME, DISPID_12_GET_NAME, DISPID_13_GET_NAME, DISPID_14_NAME, DISPID_15_GET_NAME, DISPID_15_PUT_NAME, DISPID_16_GET_NAME, DISPID_17_NAME, DISPID_2_GET_NAME, DISPID_3_GET_NAME, DISPID_3_PUT_NAME, DISPID_4_GET_NAME, DISPID_5_GET_NAME, DISPID_6_GET_NAME, DISPID_7_GET_NAME, DISPID_8_GET_NAME, DISPID_9_GET_NAME, IID, IID33df9650_35b7_42f8_a7c9_9f8a1b53aa80

Constructor Summary

	IARLayerProxy() For internal use only
	IARLayerProxy(java.lang.Object obj)
protected	IARLayerProxy(java.lang.Object obj, java.lang.String iid)
	IARLayerProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
protected	IARLayerProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.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.
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.
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	removeListener(java.lang.String iidStr, java.lang.Object theListener)
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 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, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable

Constructor Detail

IARLayerProxy

public IARLayerProxy(java.lang.String CLSID,
                     java.lang.String host,
                     com.esri.arcgis.interop.AuthInfo authInfo)
              throws java.net.UnknownHostException,
                     java.io.IOException

Throws:

java.net.UnknownHostException

java.io.IOException

IARLayerProxy

public IARLayerProxy()

For internal use only

IARLayerProxy

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

Throws:

java.io.IOException

IARLayerProxy

protected IARLayerProxy(java.lang.Object obj,
                        java.lang.String iid)
                 throws java.io.IOException

Throws:

java.io.IOException

IARLayerProxy

protected IARLayerProxy(java.lang.String CLSID,
                        java.lang.String iid,
                        java.lang.String host,
                        com.esri.arcgis.interop.AuthInfo authInfo)
                 throws java.io.IOException

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Overrides:

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

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Overrides:

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

Throws:

java.io.IOException

getName

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

The name of the layer.

Specified by:

getName in interface IARLayer

Returns:

The sName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHyperlinks

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

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

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

Indicates if the layer is currently visible.

Specified by:

isVisible in interface IARLayer

Returns:

The visible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumScale

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

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

Specified by:

getMaximumScale in interface IARLayer

Returns:

The maxScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinimumScale

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

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

Specified by:

getMinimumScale in interface IARLayer

Returns:

The minScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCached

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

Indicates if the layer has its own display cache.

Specified by:

isCached in interface IARLayer

Returns:

The cached

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isGroupLayer

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

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

Specified by:

isGroupLayer in interface IARLayer

Returns:

The groupLayer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getARLayerCount

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

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

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:

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

AutomationException - If the ArcObject component throws an exception.

searchARFeatures

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

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:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

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

The description of the layer.

Specified by:

getDescription in interface IARLayer

Returns:

The sDescription

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSearchable

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

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

Specified by:

isSearchable in interface IARLayer

Returns:

The bSearchable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInternalObject

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

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

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:

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

AutomationException - If the ArcObject component throws an exception.

getCustomProperty

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

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

A property to associate data with an object.

Specified by:

setCustomProperty in interface IARLayer

Parameters:

pVal - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

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

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

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.