com.esri.arcgis.carto
Interface ILegendClass

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ILegendClassProxy, LegendClass, RepresentationLegendClass, TemporalLegendClass

public interface ILegendClass
extends java.io.Serializable

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

Description: 'Provides access to members that control the legend/TOC entry for a renderer class.' 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	IID167c5e9e_af20_11d1_8817_080009ec732a
static int	xxDummy Deprecated. Internal use only

Method Summary

java.lang.String	getDescription() Legend class description.
ILegendClassFormat	getFormat() Optional.
java.lang.String	getLabel() Legend class label.
ISymbol	getSymbol() Legend class symbol.
void	setDescription(java.lang.String label) Legend class description.
void	setFormat(ILegendClassFormat format) Optional.
void	setLabel(java.lang.String label) Legend class label.
void	setSymbolByRef(ISymbol symbol) Legend class symbol.

Field Detail

IID167c5e9e_af20_11d1_8817_080009ec732a

static final int IID167c5e9e_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

getSymbol

ISymbol getSymbol()
                  throws java.io.IOException,
                         AutomationException

Legend class symbol.

Returns:

A reference to a com.esri.arcgis.display.ISymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymbolByRef

void setSymbolByRef(ISymbol symbol)
                    throws java.io.IOException,
                           AutomationException

Legend class symbol.

Parameters:

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabel

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

Legend class label.

Returns:

The label

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabel

void setLabel(java.lang.String label)
              throws java.io.IOException,
                     AutomationException

Legend class label.

Parameters:

label - The label (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

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

Legend class description.

Returns:

The label

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(java.lang.String label)
                    throws java.io.IOException,
                           AutomationException

Legend class description.

Parameters:

label - The label (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFormat

ILegendClassFormat getFormat()
                             throws java.io.IOException,
                                    AutomationException

Optional. If non-null, then layer specifies class formatting information.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFormat

void setFormat(ILegendClassFormat format)
               throws java.io.IOException,
                      AutomationException

Optional. If non-null, then layer specifies class formatting information.

Parameters:

format - A reference to a com.esri.arcgis.carto.ILegendClassFormat (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.