com.esri.arcgis.carto
Interface ILegendGroup

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ILegendGroupProxy, LegendGroup, TemporalLegendGroup

public interface ILegendGroup
extends java.io.Serializable

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

Description: 'Provides access to members that control the collection of legend classes provided by a renderer.' 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	IID167c5e9f_af20_11d1_8817_080009ec732a
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addClass(ILegendClass legendClass) Adds a new legend class to the group at the end of list.
void	clearClasses() Removes all classes from the group.
ILegendClass	esri_getClass(int index) Legend class at the specified index.
int	getClassCount() Number of legend classes in the group.
java.lang.String	getHeading() String heading.
void	insertClass(int index, ILegendClass legendClass) Inserts a new legend class into the group at the specified index.
boolean	isEditable() Indicates if the group can be edited.
boolean	isVisible() Indicates if the group is displayed.
void	removeClass(int index) Removes the legend class from the group at the specified index.
void	setEditable(boolean editable) Indicates if the group can be edited.
void	setHeading(java.lang.String heading) String heading.
void	setVisible(boolean visible) Indicates if the group is displayed.

Field Detail

IID167c5e9f_af20_11d1_8817_080009ec732a

static final int IID167c5e9f_af20_11d1_8817_080009ec732a

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

isVisible

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

Indicates if the group is displayed.

Returns:

The visible

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 group is displayed.

Parameters:

visible - The visible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEditable

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

Indicates if the group can be edited. Default is editable.

Returns:

The editable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEditable

void setEditable(boolean editable)
                 throws java.io.IOException,
                        AutomationException

Indicates if the group can be edited. Default is editable.

Parameters:

editable - The editable (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHeading

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

String heading.

Returns:

The heading

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHeading

void setHeading(java.lang.String heading)
                throws java.io.IOException,
                       AutomationException

String heading.

Parameters:

heading - The heading (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassCount

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

Number of legend classes in the group.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_getClass

ILegendClass esri_getClass(int index)
                           throws java.io.IOException,
                                  AutomationException

Legend class at the specified index.

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addClass

void addClass(ILegendClass legendClass)
              throws java.io.IOException,
                     AutomationException

Adds a new legend class to the group at the end of list.

Parameters:

legendClass - A reference to a com.esri.arcgis.carto.ILegendClass (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

insertClass

void insertClass(int index,
                 ILegendClass legendClass)
                 throws java.io.IOException,
                        AutomationException

Inserts a new legend class into the group at the specified index.

Parameters:

index - The index (in)

legendClass - A reference to a com.esri.arcgis.carto.ILegendClass (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeClass

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

Removes the legend class from the group at the specified index.

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearClasses

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

Removes all classes from the group.

Throws:

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

AutomationException - If the ArcObject component throws an exception.