com.esri.arcgis.carto
Interface ILegend3

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ILegend3Proxy

public interface ILegend3
extends java.io.Serializable

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

Description: 'Provides access to additional 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	IID15abe7f7_49e8_4012_be72_d14e5a755ace
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addItem(ILegendItem item) Adds a new item to the legend (to the end of the list).
void	adjustColumns(int columns) Adjust the item settings so that the legend contains the specified number of columns.
void	clearItems() Removes all items from the legend.
void	delayEvents(boolean delay) Used to batch operations together to minimize notifications.
void	draw(IDisplay display, ITrackCancel trackCancel, IEnvelope bounds) Draws the map surround into the specified display bounds.
void	fitToBounds(IDisplay display, IEnvelope bounds, boolean[] changed) Adjusts the map surround to fit the bounds.
ILegendItem	getDefaultLegendItem(ILayer layer) The default legend item for the specified layer.
ILegendFormat	getFormat() The formatting options for the legend (can be stored in the style gallery).
int	getIcon() Icon used to represent the map surround.
ILegendItem	getItem(int index) The specified item from the legend.
int	getItemCount() Number of items in the legend.
IMap	getMap() The parent map.
double	getMinFontSize() Minimumn font size when AutoFit is true.
java.lang.String	getName() Name of the map surround.
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	isAutoColumns() Automatically flow legend items to fit fixed frame.
boolean	isAutoFit() Automatically resize legend items to fit fixed frame.
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	isFixedFrame() Indicates frame should not shrink or grow with legend.
boolean	isFlowRight() Reserved for future use.
boolean	isScaleSymbols() Indicates if symbols are scaled for the layer.
boolean	isSupportsAutoColumns() Can legend items be automatically flowed to fit fixed frame?
void	queryBounds(IDisplay display, IEnvelope oldBounds, IEnvelope newBounds) Returns the bounds of the map surround.
void	refresh() Makes sure the latest updates are refected the next time the Map Surround is drawn.
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	setAutoColumns(boolean flag) Automatically flow legend items to fit fixed frame.
void	setAutoFit(boolean flag) Automatically resize legend items to fit fixed frame.
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	setFixedFrame(boolean flag) Indicates frame should not shrink or grow with legend.
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	setMapByRef(IMap map) The parent map.
void	setMinFontSize(double fontSize) Minimumn font size when AutoFit is true.
void	setName(java.lang.String name) Name of the map surround.
void	setScaleSymbols(boolean scale) Indicates if symbols are scaled for the layer.
void	setTitle(java.lang.String title) Title.

Field Detail

IID15abe7f7_49e8_4012_be72_d14e5a755ace

static final int IID15abe7f7_49e8_4012_be72_d14e5a755ace

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

getMap

IMap getMap()
            throws java.io.IOException,
                   AutomationException

The parent map.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMapByRef

void setMapByRef(IMap map)
                 throws java.io.IOException,
                        AutomationException

The parent map.

Parameters:

map - A reference to a com.esri.arcgis.carto.IMap (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

Name of the map surround.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

Name of the map surround.

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getIcon

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

Icon used to represent the map surround.

Returns:

The hIcon (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryBounds

void queryBounds(IDisplay display,
                 IEnvelope oldBounds,
                 IEnvelope newBounds)
                 throws java.io.IOException,
                        AutomationException

Returns the bounds of the map surround.

Parameters:

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

oldBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

newBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

fitToBounds

void fitToBounds(IDisplay display,
                 IEnvelope bounds,
                 boolean[] changed)
                 throws java.io.IOException,
                        AutomationException

Adjusts the map surround to fit the bounds. The changed argument indicates whether the size of the map surround was changed.

Parameters:

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

bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

changed - The changed (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

delayEvents

void delayEvents(boolean delay)
                 throws java.io.IOException,
                        AutomationException

Used to batch operations together to minimize notifications.

Parameters:

delay - The delay (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refresh

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

Makes sure the latest updates are refected the next time the Map Surround is drawn.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

draw

void draw(IDisplay display,
          ITrackCancel trackCancel,
          IEnvelope bounds)
          throws java.io.IOException,
                 AutomationException

Draws the map surround into the specified display bounds.

Parameters:

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

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

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.

getDefaultLegendItem

ILegendItem getDefaultLegendItem(ILayer layer)
                                 throws java.io.IOException,
                                        AutomationException

The default legend item for the specified layer.

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (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.

isScaleSymbols

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

Indicates if symbols are scaled for the layer.

Returns:

The scale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setScaleSymbols

void setScaleSymbols(boolean scale)
                     throws java.io.IOException,
                            AutomationException

Indicates if symbols are scaled for the layer.

Parameters:

scale - The scale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

adjustColumns

void adjustColumns(int columns)
                   throws java.io.IOException,
                          AutomationException

Adjust the item settings so that the legend contains the specified number of columns.

Parameters:

columns - The columns (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFixedFrame

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

Indicates frame should not shrink or grow with legend. Enables AutoColumns and AutoFit.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFixedFrame

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

Indicates frame should not shrink or grow with legend. Enables AutoColumns and AutoFit.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAutoColumns

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

Automatically flow legend items to fit fixed frame.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAutoColumns

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

Automatically flow legend items to fit fixed frame.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAutoFit

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

Automatically resize legend items to fit fixed frame.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAutoFit

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

Automatically resize legend items to fit fixed frame.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinFontSize

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

Minimumn font size when AutoFit is true.

Returns:

The fontSize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinFontSize

void setMinFontSize(double fontSize)
                    throws java.io.IOException,
                           AutomationException

Minimumn font size when AutoFit is true.

Parameters:

fontSize - The fontSize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsAutoColumns

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

Can legend items be automatically flowed to fit fixed frame?

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.