com.esri.arcgis.carto
Interface ILegendGroups

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ILegendGroupsProxy, LegendGroups

public interface ILegendGroups
extends java.io.Serializable

COM Interface 'ILegendGroups'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to the Legend Groups Interface.' 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	IID Deprecated. Internal use only
static int	IID5115c4f3_e87b_45f3_9e11_0cde2aef2bef
static int	xxDummy Deprecated. Internal use only

Method Summary

void	add(ILegendGroup legendGroup) Add a legend group.
int	getCount() The legend group count.
ILegendGroup	getElement(int index) Legend group at the specified position.
void	insert(int index, ILegendGroup legendGroup) Add a legend group at the specified posiiton.
void	remove(int index) Legend group at the specified position.
void	removeAll() Remove all legend groups.

Field Detail

IID5115c4f3_e87b_45f3_9e11_0cde2aef2bef

static final int IID5115c4f3_e87b_45f3_9e11_0cde2aef2bef

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

Method Detail

getCount

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

The legend group count.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getElement

ILegendGroup getElement(int index)
                        throws java.io.IOException,
                               AutomationException

Legend group at the specified position.

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.carto.ILegendGroup

Throws:

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

AutomationException - If the ArcObject component throws an exception.

remove

void remove(int index)
            throws java.io.IOException,
                   AutomationException

Legend group at the specified position.

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAll

void removeAll()
               throws java.io.IOException,
                      AutomationException

Remove all legend groups.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

add

void add(ILegendGroup legendGroup)
         throws java.io.IOException,
                AutomationException

Add a legend group.

Parameters:

legendGroup - A reference to a com.esri.arcgis.carto.ILegendGroup (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

insert

void insert(int index,
            ILegendGroup legendGroup)
            throws java.io.IOException,
                   AutomationException

Add a legend group at the specified posiiton.

Parameters:

index - The index (in)

legendGroup - A reference to a com.esri.arcgis.carto.ILegendGroup (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.