com.esri.arcgis.carto
Interface IDynamicLegendItem

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IDynamicLegendItemProxy

public interface IDynamicLegendItem
extends java.io.Serializable

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

Description: 'Dynamic legend properties' 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	IID815e4b50_152a_4b7b_b3e8_4778c59dc699
static int	xxDummy Deprecated. Internal use only

Method Summary

INumberFormat	getCountNumberFormat() Class count number format.
java.lang.String	getCountPrefix() Class count string is created by combining prefix + count + suffix.
java.lang.String	getCountSuffix() Class count string is created by combining prefix + count + suffix.
boolean	isAutoVisibility() Indicates if classes should be shown only when associated data is visible.
boolean	isShowCounts() Show the number of times a class appears in the current map extent.
boolean	isUseSimpleExtent() Indicates geometry used to determine whether the data for a legend class is visible.
void	setAutoVisibility(boolean autoVisibility) Indicates if classes should be shown only when associated data is visible.
void	setCountNumberFormatByRef(INumberFormat format) Class count number format.
void	setCountPrefix(java.lang.String str) Class count string is created by combining prefix + count + suffix.
void	setCountSuffix(java.lang.String str) Class count string is created by combining prefix + count + suffix.
void	setShowCounts(boolean autoVisibility) Show the number of times a class appears in the current map extent.
void	setUseSimpleExtent(boolean flag) Indicates geometry used to determine whether the data for a legend class is visible.

Field Detail

IID815e4b50_152a_4b7b_b3e8_4778c59dc699

static final int IID815e4b50_152a_4b7b_b3e8_4778c59dc699

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

isAutoVisibility

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

Indicates if classes should be shown only when associated data is 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 classes should be shown only when associated data is visible.

Parameters:

autoVisibility - The autoVisibility (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseSimpleExtent

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

Indicates geometry used to determine whether the data for a legend class is visible. Normally, the map clip shape or data driven page index feature is used. Simple means use the data frame extent.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseSimpleExtent

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

Indicates geometry used to determine whether the data for a legend class is visible. Normally, the map clip shape or data driven page index feature is used. Simple means use the data frame extent.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowCounts

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

Show the number of times a class appears in the current map extent.

Returns:

The autoVisibility

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowCounts

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

Show the number of times a class appears in the current map extent.

Parameters:

autoVisibility - The autoVisibility (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCountPrefix

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

Class count string is created by combining prefix + count + suffix.

Returns:

The str

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCountSuffix

void setCountSuffix(java.lang.String str)
                    throws java.io.IOException,
                           AutomationException

Class count string is created by combining prefix + count + suffix.

Parameters:

str - The str (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCountSuffix

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

Class count string is created by combining prefix + count + suffix.

Returns:

The str

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCountPrefix

void setCountPrefix(java.lang.String str)
                    throws java.io.IOException,
                           AutomationException

Class count string is created by combining prefix + count + suffix.

Parameters:

str - The str (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCountNumberFormat

INumberFormat getCountNumberFormat()
                                   throws java.io.IOException,
                                          AutomationException

Class count number format.

Returns:

A reference to a com.esri.arcgis.system.INumberFormat

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCountNumberFormatByRef

void setCountNumberFormatByRef(INumberFormat format)
                               throws java.io.IOException,
                                      AutomationException

Class count number format.

Parameters:

format - A reference to a com.esri.arcgis.system.INumberFormat (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.