com.esri.arcgis.carto
Interface IGroupLayer

All Superinterfaces:

ILayer, Serializable

All Known Implementing Classes:

BasemapLayer, GroupLayer, IGroupLayerProxy

public interface IGroupLayer
extends ILayer, 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

Method Summary

void	add(ILayer layer) Adds a layer to the end of the group.
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	setExpanded(boolean expanded) Indicates if the group's entry is expanded in the TOC.

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

Method Detail

add

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

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

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

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExpanded

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

Returns:

The expanded

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpanded

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

Parameters:

expanded - The expanded (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.