com.esri.arcgis.carto
Interface ILegend

All Superinterfaces:

IMapSurround, java.io.Serializable

All Known Implementing Classes:

ILegendProxy, Legend

public interface ILegend
extends IMapSurround, java.io.Serializable

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

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

Fields inherited from interface com.esri.arcgis.carto.IMapSurround

IIDfe3115e9_ed6c_11d0_8683_0000f8751720

Method Summary

void	addItem(ILegendItem item) Adds a new item to the legend (to the end of the list).
void	clearItems() Removes all items from the legend.
ILegendFormat	getFormat() The formatting options for the legend (can be stored in the style gallery).
ILegendItem	getItem(int index) The specified item from the legend.
int	getItemCount() Number of items in the legend.
java.lang.String	getTitle() Title.
void	insertItem(int index, ILegendItem item) Inserts a new item into the legend (at the location specified by index).
boolean	isAutoAdd() Indicates if a new item should be added when a new layer is added to the map.
boolean	isAutoReorder() Indicates if the legend items should be kept in the same order as the layers.
boolean	isAutoVisibility() Indicates if items should be shown only when associated layers are visible.
boolean	isFlowRight() Reserved for future use.
void	removeItem(int index) Removes the specified item from the legend.
void	setAutoAdd(boolean autoAdd) Indicates if a new item should be added when a new layer is added to the map.
void	setAutoReorder(boolean autoReorder) Indicates if the legend items should be kept in the same order as the layers.
void	setAutoVisibility(boolean autoVisibility) Indicates if items should be shown only when associated layers are visible.
void	setFlowRight(boolean flag) Reserved for future use.
void	setFormatByRef(ILegendFormat legendFormat) The formatting options for the legend (can be stored in the style gallery).
void	setTitle(java.lang.String title) Title.

Methods inherited from interface com.esri.arcgis.carto.IMapSurround

delayEvents, draw, fitToBounds, getIcon, getMap, getName, queryBounds, refresh, setMapByRef, setName

Field Detail

IID3141f307_38e2_11d1_8809_080009ec732a

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

getFormat

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

The formatting options for the legend (can be stored in the style gallery).

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFormatByRef

void setFormatByRef(ILegendFormat legendFormat)
                    throws java.io.IOException,
                           AutomationException

The formatting options for the legend (can be stored in the style gallery).

Parameters:

legendFormat - A reference to a com.esri.arcgis.carto.ILegendFormat (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTitle

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

Title.

Returns:

The title

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTitle

void setTitle(java.lang.String title)
              throws java.io.IOException,
                     AutomationException

Title.

Parameters:

title - The title (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAutoAdd

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

Indicates if a new item should be added when a new layer is added to the map.

Returns:

The autoAdd

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAutoAdd

void setAutoAdd(boolean autoAdd)
                throws java.io.IOException,
                       AutomationException

Indicates if a new item should be added when a new layer is added to the map.

Parameters:

autoAdd - The autoAdd (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAutoReorder

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

Indicates if the legend items should be kept in the same order as the layers.

Returns:

The autoReorder

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAutoReorder

void setAutoReorder(boolean autoReorder)
                    throws java.io.IOException,
                           AutomationException

Indicates if the legend items should be kept in the same order as the layers.

Parameters:

autoReorder - The autoReorder (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAutoVisibility

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

Indicates if items should be shown only when associated layers are visible.

Returns:

The autoVisibility

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAutoVisibility

void setAutoVisibility(boolean autoVisibility)
                       throws java.io.IOException,
                              AutomationException

Indicates if items should be shown only when associated layers are visible.

Parameters:

autoVisibility - The autoVisibility (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFlowRight

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

Reserved for future use.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFlowRight

void setFlowRight(boolean flag)
                  throws java.io.IOException,
                         AutomationException

Reserved for future use.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getItemCount

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

Number of items in the legend.

Returns:

The numItems

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getItem

ILegendItem getItem(int index)
                    throws java.io.IOException,
                           AutomationException

The specified item from the legend.

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addItem

void addItem(ILegendItem item)
             throws java.io.IOException,
                    AutomationException

Adds a new item to the legend (to the end of the list).

Parameters:

item - A reference to a com.esri.arcgis.carto.ILegendItem (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

insertItem

void insertItem(int index,
                ILegendItem item)
                throws java.io.IOException,
                       AutomationException

Inserts a new item into the legend (at the location specified by index).

Parameters:

index - The index (in)

item - A reference to a com.esri.arcgis.carto.ILegendItem (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeItem

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

Removes the specified item from the legend.

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearItems

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

Removes all items from the legend.

Throws:

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

AutomationException - If the ArcObject component throws an exception.