com.esri.arcgis.controls
Interface IARLayer

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ARLayer, IARLayerProxy

public interface IARLayer
extends java.io.Serializable

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 =

Field Summary

static java.lang.String	DISPID_1_GET_NAME
static java.lang.String	DISPID_10_NAME
static java.lang.String	DISPID_11_GET_NAME
static java.lang.String	DISPID_12_GET_NAME
static java.lang.String	DISPID_13_GET_NAME
static java.lang.String	DISPID_14_NAME
static java.lang.String	DISPID_15_GET_NAME
static java.lang.String	DISPID_15_PUT_NAME
static java.lang.String	DISPID_16_GET_NAME
static java.lang.String	DISPID_17_NAME
static java.lang.String	DISPID_2_GET_NAME
static java.lang.String	DISPID_3_GET_NAME
static java.lang.String	DISPID_3_PUT_NAME
static java.lang.String	DISPID_4_GET_NAME
static java.lang.String	DISPID_5_GET_NAME
static java.lang.String	DISPID_6_GET_NAME
static java.lang.String	DISPID_7_GET_NAME
static java.lang.String	DISPID_8_GET_NAME
static java.lang.String	DISPID_9_GET_NAME
static java.lang.String	IID Deprecated. Internal use only
static int	IID33df9650_35b7_42f8_a7c9_9f8a1b53aa80
static int	xxDummy Deprecated. Internal use only

Method Summary

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

Field Detail

IID33df9650_35b7_42f8_a7c9_9f8a1b53aa80

static final int IID33df9650_35b7_42f8_a7c9_9f8a1b53aa80

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

DISPID_1_GET_NAME

static final java.lang.String DISPID_1_GET_NAME

See Also:

Constant Field Values

DISPID_2_GET_NAME

static final java.lang.String DISPID_2_GET_NAME

See Also:

Constant Field Values

DISPID_3_PUT_NAME

static final java.lang.String DISPID_3_PUT_NAME

See Also:

Constant Field Values

DISPID_3_GET_NAME

static final java.lang.String DISPID_3_GET_NAME

See Also:

Constant Field Values

DISPID_4_GET_NAME

static final java.lang.String DISPID_4_GET_NAME

See Also:

Constant Field Values

DISPID_5_GET_NAME

static final java.lang.String DISPID_5_GET_NAME

See Also:

Constant Field Values

DISPID_6_GET_NAME

static final java.lang.String DISPID_6_GET_NAME

See Also:

Constant Field Values

DISPID_7_GET_NAME

static final java.lang.String DISPID_7_GET_NAME

See Also:

Constant Field Values

DISPID_8_GET_NAME

static final java.lang.String DISPID_8_GET_NAME

See Also:

Constant Field Values

DISPID_9_GET_NAME

static final java.lang.String DISPID_9_GET_NAME

See Also:

Constant Field Values

DISPID_10_NAME

static final java.lang.String DISPID_10_NAME

See Also:

Constant Field Values

DISPID_11_GET_NAME

static final java.lang.String DISPID_11_GET_NAME

See Also:

Constant Field Values

DISPID_12_GET_NAME

static final java.lang.String DISPID_12_GET_NAME

See Also:

Constant Field Values

DISPID_13_GET_NAME

static final java.lang.String DISPID_13_GET_NAME

See Also:

Constant Field Values

DISPID_14_NAME

static final java.lang.String DISPID_14_NAME

See Also:

Constant Field Values

DISPID_15_GET_NAME

static final java.lang.String DISPID_15_GET_NAME

See Also:

Constant Field Values

DISPID_15_PUT_NAME

static final java.lang.String DISPID_15_PUT_NAME

See Also:

Constant Field Values

DISPID_16_GET_NAME

static final java.lang.String DISPID_16_GET_NAME

See Also:

Constant Field Values

DISPID_17_NAME

static final java.lang.String DISPID_17_NAME

See Also:

Constant Field Values

Method Detail

getName

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

The name of the layer.

Returns:

The sName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHyperlinks

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

Indicates if the layer contains hyperlinks.

Returns:

The bHasHyperlinks

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVisible

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

Indicates if the layer is currently visible.

Parameters:

visible - The visible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isVisible

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

Indicates if the layer is currently visible.

Returns:

The visible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumScale

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

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

Returns:

The maxScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinimumScale

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

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

Returns:

The minScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCached

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

Indicates if the layer has its own display cache.

Returns:

The cached

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isGroupLayer

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

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

Returns:

The groupLayer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getARLayerCount

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

The number of child layers in a group layer.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getChildARLayer

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

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

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

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

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

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

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

The description of the layer.

Returns:

The sDescription

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSearchable

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

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

Returns:

The bSearchable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInternalObject

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

The internal ArcObjects ILayer object.

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

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

The extent of the data within the layer.

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

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

A property to associate data with an object.

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCustomProperty

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

A property to associate data with an object.

Parameters:

pVal - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

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

The description of the type of layer.

Returns:

The sDescription

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryARFeatures

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

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

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.