com.esri.arcgis.carto
Interface ILegendClassFormat

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ILegendClassFormatProxy, LegendClassFormat

public interface ILegendClassFormat
extends java.io.Serializable

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

Description: 'Provides access to members that control formatting information for a legend 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	IID52aa5bc2_cb21_11d0_87f9_080009ec732a
static int	xxDummy Deprecated. Internal use only

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.

Field Detail

IID52aa5bc2_cb21_11d0_87f9_080009ec732a

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

getLabelSymbol

ITextSymbol getLabelSymbol()
                           throws java.io.IOException,
                                  AutomationException

Text symbol used to draw the legend group labels.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelSymbol

void setLabelSymbol(ITextSymbol symbol)
                    throws java.io.IOException,
                           AutomationException

Text symbol used to draw the legend group labels.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescriptionSymbol

ITextSymbol getDescriptionSymbol()
                                 throws java.io.IOException,
                                        AutomationException

Text symbol used to draw legend group descriptions.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescriptionSymbol

void setDescriptionSymbol(ITextSymbol symbol)
                          throws java.io.IOException,
                                 AutomationException

Text symbol used to draw legend group descriptions.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPatchWidth

double getPatchWidth()
                     throws java.io.IOException,
                            AutomationException

Width of the patch in points.

Returns:

The width

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPatchWidth

void setPatchWidth(double width)
                   throws java.io.IOException,
                          AutomationException

Width of the patch in points.

Parameters:

width - The width (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPatchHeight

double getPatchHeight()
                      throws java.io.IOException,
                             AutomationException

Height of the patch in points.

Returns:

The height

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPatchHeight

void setPatchHeight(double height)
                    throws java.io.IOException,
                           AutomationException

Height of the patch in points.

Parameters:

height - The height (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLinePatch

ILinePatch getLinePatch()
                        throws java.io.IOException,
                               AutomationException

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLinePatch

void setLinePatch(ILinePatch shape)
                  throws java.io.IOException,
                         AutomationException

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

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAreaPatch

IAreaPatch getAreaPatch()
                        throws java.io.IOException,
                               AutomationException

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAreaPatch

void setAreaPatch(IAreaPatch shape)
                  throws java.io.IOException,
                         AutomationException

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

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.