com.esri.arcgis.carto
Interface IDynamicLegendRenderer

All Superinterfaces:

Serializable

All Known Implementing Classes:

CoTrackSymbologyRenderer

public interface IDynamicLegendRenderer
extends Serializable

Provides access to members that instrument layer drawing to detect which legend classes are visible.

Product Availability

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

Method Summary

void	finishInstrumentedDraw() Call after renderer.Draw.
int	getInstrumentedDrawPhases() Draw phases that affect dynamic legends.
boolean	isSupportsCounts() Indicates that the renderer supports counts on its legend.
void	startInstrumentedDraw(int type, IDisplay mapDisplay, IGeometry visibleArea) Call before renderer.Draw so that legend info can be sampled.

Method Detail

isSupportsCounts

boolean isSupportsCounts()
                         throws IOException,
                                AutomationException

Indicates that the renderer supports counts on its legend.

Product Availability

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInstrumentedDrawPhases

int getInstrumentedDrawPhases()
                              throws IOException,
                                     AutomationException

Draw phases that affect dynamic legends.

Product Availability

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

Returns:

The drawPhases

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startInstrumentedDraw

void startInstrumentedDraw(int type,
                           IDisplay mapDisplay,
                           IGeometry visibleArea)
                           throws IOException,
                                  AutomationException

Call before renderer.Draw so that legend info can be sampled.

Product Availability

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

Parameters:

type - A com.esri.arcgis.carto.esriDynamicLegendType constant (in)

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

visibleArea - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

finishInstrumentedDraw

void finishInstrumentedDraw()
                            throws IOException,
                                   AutomationException

Call after renderer.Draw.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.