com.esri.arcgis.carto
Class IGroupLayerProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.carto.ILayerProxy
          com.esri.arcgis.carto.IGroupLayerProxy

All Implemented Interfaces:

IGroupLayer, ILayer, Externalizable, Serializable

public class IGroupLayerProxy
extends ILayerProxy
implements IGroupLayer, Serializable

Provides access to members that control a collection of layers that behaves like a single layer.

Description

The IGroupLayer interface provides methods for managing the contents of GroupLayers. Use the ILayer interface to set properties for the GroupLayer, or use the appropriate interface to adjust properties of the constituent layers.

Remarks

A group layer is a special case of a composite layer. Custom layer implementations of IGroupLayer are rarely needed, but when done it is importat to implement ICompositeLayer as well.

Product Availability

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

See Also:

IGroupLayer, ICompositeLayer, GroupLayer, Serialized Form

Field Summary

boolean

noncastable

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

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

Method Summary

void	add(ILayer layer) Adds a layer to the end of the group.
void	addListener(String iidStr, Object theListener, Object theSource)
void	clear() Removes all layers from the group.
void	delete(ILayer layer) Removes the specified layer from the group.
boolean	isExpanded() Indicates if the group's entry is expanded in the TOC.
void	removeListener(String iidStr, Object theListener)
void	setExpanded(boolean expanded) Indicates if the group's entry is expanded in the TOC.

Methods inherited from class com.esri.arcgis.carto.ILayerProxy

draw, getAreaOfInterest, getMaximumScale, getMinimumScale, getName, getSupportedDrawPhases, getTipText, isCached, isShowTips, isValid, isVisible, setCached, setMaximumScale, setMinimumScale, setName, setShowTips, setSpatialReferenceByRef, setVisible

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

Methods inherited from interface com.esri.arcgis.carto.ILayer

draw, getAreaOfInterest, getMaximumScale, getMinimumScale, getName, getSupportedDrawPhases, getTipText, isCached, isShowTips, isValid, isVisible, setCached, setMaximumScale, setMinimumScale, setName, setShowTips, setSpatialReferenceByRef, setVisible

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IGroupLayerProxy

public IGroupLayerProxy()

IGroupLayerProxy

public IGroupLayerProxy(Object obj)
                 throws IOException

Throws:

IOException

IGroupLayerProxy

protected IGroupLayerProxy(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 ILayerProxy

Throws:

IOException

removeListener

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

Overrides:

removeListener in class ILayerProxy

Throws:

IOException

add

public void add(ILayer layer)
         throws IOException,
                AutomationException

Adds a layer to the end of the group.

Description

Adds the specified layer to the GroupLayer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

add in interface IGroupLayer

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delete

public void delete(ILayer layer)
            throws IOException,
                   AutomationException

Removes the specified layer from the group.

Description

Removes the specified Layer from the GroupLayer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

delete in interface IGroupLayer

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws IOException,
                  AutomationException

Removes all layers from the group.

Description

Removes all constituent layers from the GroupLayer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

clear in interface IGroupLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExpanded

public boolean isExpanded()
                   throws IOException,
                          AutomationException

Indicates if the group's entry is expanded in the TOC.

Description

Sets whether the GroupLayer is to be shown in expanded or collapsed view in the TOC.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isExpanded in interface IGroupLayer

Returns:

The expanded

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpanded

public void setExpanded(boolean expanded)
                 throws IOException,
                        AutomationException

Indicates if the group's entry is expanded in the TOC.

Description

Sets whether the GroupLayer is to be shown in expanded or collapsed view in the TOC.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExpanded in interface IGroupLayer

Parameters:

expanded - The expanded (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.