com.esri.arcgis.carto
Interface ILookupSymbol

All Superinterfaces:
Serializable
All Known Implementing Classes:
ClassBreaksRenderer, CoTrackSymbologyRenderer, RepresentationRenderer, SimpleRenderer, UniqueValueRenderer

public interface ILookupSymbol
extends Serializable

Provides access to functionality for looking up a renderer's symbol via a feature.

Remarks

I LookupSymbol is used as a faster alternative to IFeatureRenderer::SymbolByFeature when querying for a features symbol during labeling. While SymbolByFeature hands out clones of a symbol, ISymbolLookup provides a framework where references to symbols are handed out and modifications of the symbol are reset. Your renderer should implement this interface to make labeling perform efficiently.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 ISymbol lookupSymbol(boolean firstPass, IFeature feature)
          Returns a reference to the renderer's symbol for the input feature.
 void resetLookupSymbol(ISymbol symbol)
          Resets temporary options on the symbol (e.g.
 

Method Detail

lookupSymbol

ISymbol lookupSymbol(boolean firstPass,
                     IFeature feature)
                     throws IOException,
                            AutomationException
Returns a reference to the renderer's symbol for the input feature.

Remarks

This method hands out a reference to the symbol for a specific feature. The firstPass parameter is passed in as True on the first call of this method. This allows the renderer to internally cache the symbols for succesive calls.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
firstPass - The firstPass (in)
feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
Returns:
A reference to a com.esri.arcgis.display.ISymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

resetLookupSymbol

void resetLookupSymbol(ISymbol symbol)
                       throws IOException,
                              AutomationException
Resets temporary options on the symbol (e.g. Rotation).

Remarks

This method resets modifications to marker symbol angles that may be set on the symbol reference handed to the label engine. When implementing this interface it is important to reset any marker symbol rotation changes in this method.

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.ISymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.