com.esri.arcgis.carto
Interface ILegendClasses

All Superinterfaces:
Serializable
All Known Implementing Classes:
LegendClasses

public interface ILegendClasses
extends Serializable

Provides access to the Legend Classes Interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void add(ILegendClass legendClass)
          Add a legend class.
 int getCount()
          The legend class count.
 ILegendClass getElement(int index)
          The legend class at the specified position.
 void insert(int index, ILegendClass legendClass)
          Add a legend class at the specified posiiton.
 void remove(int index)
          Remove legend class at the specified position.
 void removeAll()
          Remove all legend classes.
 

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException
The legend class count.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElement

ILegendClass getElement(int index)
                        throws IOException,
                               AutomationException
The legend class at the specified position.

Product Availability

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

Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.carto.ILegendClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

remove

void remove(int index)
            throws IOException,
                   AutomationException
Remove legend class at the specified position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
index - The index (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAll

void removeAll()
               throws IOException,
                      AutomationException
Remove all legend classes.

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.

add

void add(ILegendClass legendClass)
         throws IOException,
                AutomationException
Add a legend class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
legendClass - A reference to a com.esri.arcgis.carto.ILegendClass (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insert

void insert(int index,
            ILegendClass legendClass)
            throws IOException,
                   AutomationException
Add a legend class at the specified posiiton.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
index - The index (in)
legendClass - A reference to a com.esri.arcgis.carto.ILegendClass (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.