com.esri.arcgis.carto
Interface ILegendClassFormat

All Superinterfaces:

Serializable

All Known Implementing Classes:

LegendClassFormat

public interface ILegendClassFormat
extends Serializable

Provides access to members that control formatting information for a legend class.

Remarks

The LegendClassFormat defines the aspect of a LegendItem. Each LegendItem has its own LegendClassFormat which not surprisingly can be accessed through ILegendItem::LegendClassFormat.

A legend item may consist of a patch, a label and an optional description:

An area patch will be used for a layer displaying polygons and a line patch for a layer displaying lines.

A number of properties are provided to manage the patches used for this legend item. For more on patches, see the help under IPatch.

LabelSymbol and DescriptionSymbol allow you to set the TextSymbol used to display the Label and Description.

Product Availability

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

Method Summary

IAreaPatch	getAreaPatch() The area patch.
ITextSymbol	getDescriptionSymbol() Text symbol used to draw legend group descriptions.
ITextSymbol	getLabelSymbol() Text symbol used to draw the legend group labels.
ILinePatch	getLinePatch() The line patch.
double	getPatchHeight() Height of the patch in points.
double	getPatchWidth() Width of the patch in points.
void	setAreaPatch(IAreaPatch shape) The area patch.
void	setDescriptionSymbol(ITextSymbol symbol) Text symbol used to draw legend group descriptions.
void	setLabelSymbol(ITextSymbol symbol) Text symbol used to draw the legend group labels.
void	setLinePatch(ILinePatch shape) The line patch.
void	setPatchHeight(double height) Height of the patch in points.
void	setPatchWidth(double width) Width of the patch in points.

Method Detail

getLabelSymbol

ITextSymbol getLabelSymbol()
                           throws IOException,
                                  AutomationException

Text symbol used to draw the legend group labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelSymbol

void setLabelSymbol(ITextSymbol symbol)
                    throws IOException,
                           AutomationException

Text symbol used to draw the legend group labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescriptionSymbol

ITextSymbol getDescriptionSymbol()
                                 throws IOException,
                                        AutomationException

Text symbol used to draw legend group descriptions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescriptionSymbol

void setDescriptionSymbol(ITextSymbol symbol)
                          throws IOException,
                                 AutomationException

Text symbol used to draw legend group descriptions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPatchWidth

double getPatchWidth()
                     throws IOException,
                            AutomationException

Width of the patch in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The width

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPatchWidth

void setPatchWidth(double width)
                   throws IOException,
                          AutomationException

Width of the patch in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

width - The width (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPatchHeight

double getPatchHeight()
                      throws IOException,
                             AutomationException

Height of the patch in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The height

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPatchHeight

void setPatchHeight(double height)
                    throws IOException,
                           AutomationException

Height of the patch in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

height - The height (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLinePatch

ILinePatch getLinePatch()
                        throws IOException,
                               AutomationException

The line patch. (Optional. If non-null, this overrides default line patch specified by ILegend.LegendFormat).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLinePatch

void setLinePatch(ILinePatch shape)
                  throws IOException,
                         AutomationException

The line patch. (Optional. If non-null, this overrides default line patch specified by ILegend.LegendFormat).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

shape - A reference to a com.esri.arcgis.carto.ILinePatch (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAreaPatch

IAreaPatch getAreaPatch()
                        throws IOException,
                               AutomationException

The area patch. (Optional. If non-null, this overrides default area patch specified by ILegend.LegendFormat).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAreaPatch

void setAreaPatch(IAreaPatch shape)
                  throws IOException,
                         AutomationException

The area patch. (Optional. If non-null, this overrides default area patch specified by ILegend.LegendFormat).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

shape - A reference to a com.esri.arcgis.carto.IAreaPatch (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.