com.esri.arcgis.carto
Interface INestedLegendItem

All Superinterfaces:

Serializable

All Known Implementing Classes:

NestedLegendItem

public interface INestedLegendItem
extends Serializable

Provides access to members that work with nested legend items.

Remarks

See the documentation for ILegendItem.

Product Availability

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

Method Summary

int	getHorizontalAlignment() Horizontal alignment of markers.
double	getLeaderOverhang() Distance that the leaders extend past the circles (points).
ILineSymbol	getLeaderSymbol() Symbol used to draw the leader lines.
IFillSymbol	getOutlineSymbol() Symbol used to draw outlines.
boolean	isAutoLayout() Indicates if text automatically sizes to fit the markers.
boolean	isLabelEnds() Indicates if only the first and last markers are labeled.
boolean	isShowOutlines() Indicates if only the marker outlines are drawn.
void	setAutoLayout(boolean autoLayout) Indicates if text automatically sizes to fit the markers.
void	setHorizontalAlignment(int horizAlignment) Horizontal alignment of markers.
void	setLabelEnds(boolean labelEnds) Indicates if only the first and last markers are labeled.
void	setLeaderOverhang(double leaderOverhang) Distance that the leaders extend past the circles (points).
void	setLeaderSymbol(ILineSymbol symbol) Symbol used to draw the leader lines.
void	setOutlineSymbol(IFillSymbol symbol) Symbol used to draw outlines.
void	setShowOutlines(boolean showOutlines) Indicates if only the marker outlines are drawn.

Method Detail

setOutlineSymbol

void setOutlineSymbol(IFillSymbol symbol)
                      throws IOException,
                             AutomationException

Symbol used to draw outlines.

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.IFillSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutlineSymbol

IFillSymbol getOutlineSymbol()
                             throws IOException,
                                    AutomationException

Symbol used to draw outlines.

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.IFillSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLeaderSymbol

void setLeaderSymbol(ILineSymbol symbol)
                     throws IOException,
                            AutomationException

Symbol used to draw the leader lines.

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.ILineSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLeaderSymbol

ILineSymbol getLeaderSymbol()
                            throws IOException,
                                   AutomationException

Symbol used to draw the leader lines.

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.ILineSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLeaderOverhang

void setLeaderOverhang(double leaderOverhang)
                       throws IOException,
                              AutomationException

Distance that the leaders extend past the circles (points).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

leaderOverhang - The leaderOverhang (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLeaderOverhang

double getLeaderOverhang()
                         throws IOException,
                                AutomationException

Distance that the leaders extend past the circles (points).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The leaderOverhang

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoLayout

void setAutoLayout(boolean autoLayout)
                   throws IOException,
                          AutomationException

Indicates if text automatically sizes to fit the markers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

autoLayout - The autoLayout (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAutoLayout

boolean isAutoLayout()
                     throws IOException,
                            AutomationException

Indicates if text automatically sizes to fit the markers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The autoLayout

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelEnds

void setLabelEnds(boolean labelEnds)
                  throws IOException,
                         AutomationException

Indicates if only the first and last markers are labeled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

labelEnds - The labelEnds (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLabelEnds

boolean isLabelEnds()
                    throws IOException,
                           AutomationException

Indicates if only the first and last markers are labeled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The labelEnds

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowOutlines

void setShowOutlines(boolean showOutlines)
                     throws IOException,
                            AutomationException

Indicates if only the marker outlines are drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

showOutlines - The showOutlines (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowOutlines

boolean isShowOutlines()
                       throws IOException,
                              AutomationException

Indicates if only the marker outlines are drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The showOutlines

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHorizontalAlignment

int getHorizontalAlignment()
                           throws IOException,
                                  AutomationException

Horizontal alignment of markers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.display.esriTextHorizontalAlignment constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHorizontalAlignment

void setHorizontalAlignment(int horizAlignment)
                            throws IOException,
                                   AutomationException

Horizontal alignment of markers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

horizAlignment - A com.esri.arcgis.display.esriTextHorizontalAlignment constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.