com.esri.arcgis.carto
Interface ICoverageAnnotationLayer

All Superinterfaces:

Serializable

All Known Implementing Classes:

CadAnnotationLayer, CoverageAnnotationLayer

public interface ICoverageAnnotationLayer
extends Serializable

Provides access to members that control a coverage annotation layer.

Superseded By

ICoverageAnnotationLayer2

When To Use

The ICoverageAnnotationLayer interface controls the display of coverage annotation. For example, use this interface to set the Symbol to display annotation with.

Example:

 
//This example assumes that you already have an IFeatureClass (fC) set to a valid    
//coverage annotation feature class
  
//get CoverageAnnotationLayer
ICoverageAnnotationLayer pCovAnnoLayer = null;   
// implements IFeatureLayer   
pCovAnnoLayer = new CoverageAnnotationLayer();   
IFeatureLayer fL = new IFeatureLayerProxy(pCovAnnoLayer);   
fL.setFeatureClassByRef(fC);   
System.out.println(pCovAnnoLayer.getLevelCount());

Product Availability

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

Method Summary

IEnumElement	generateGraphics(IEnvelope box, IDisplay display) Generates graphic elements from the annotation features.
ILineSymbol	getArrowSymbol() The line symbol for the arrow.
Font	getFont(int symbolNumber) The font for the specified symbol number.
IColor	getFontColor(int symbolNumber) The font color for the specified symbol number.
int	getLevelCount() The number of levels in the layer.
int	getLevelNumber(int index) The level number at the specified index.
IElement	getNextGraphic() Generates the next graphic element in the graphics generation loop.
int	getSymbolCount() The number of symbols used by the layer.
int	getSymbolNumber(int index) The symbol number at the specified index.
ITextSymbol	getTextSymbol(int symbolNumber) The text symbol for the specified symbol number.
boolean	isLevelVisibility(int levelNumber) Indicates if the level at the specified level number is visible.
void	nextFeatureAndGraphic(IFeature[] feature, IElement[] element) Generates the next feature and graphic element in the graphics generation loop.
void	setArrowSymbolByRef(ILineSymbol symbol) The line symbol for the arrow.
void	setFontByRef(int symbolNumber, Font font) The font for the specified symbol number.
void	setFontColorByRef(int symbolNumber, IColor color) The font color for the specified symbol number.
void	setLevelVisibility(int levelNumber, boolean visible) Indicates if the level at the specified level number is visible.
void	setTextSymbolByRef(int symbolNumber, ITextSymbol symbol) The text symbol for the specified symbol number.
void	startGeneratingGraphics(IEnvelope box, IDisplay display, boolean withAttributes) Starts a graphics generation process from the annotation features.

Method Detail

getSymbolCount

int getSymbolCount()
                   throws IOException,
                          AutomationException

The number of symbols used by the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbolNumber

int getSymbolNumber(int index)
                    throws IOException,
                           AutomationException

The symbol number at the specified index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The symbolNumber

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFont

Font getFont(int symbolNumber)
             throws IOException,
                    AutomationException

The font for the specified symbol number.

Product Availability

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

Parameters:

symbolNumber - The symbolNumber (in)

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFontByRef

void setFontByRef(int symbolNumber,
                  Font font)
                  throws IOException,
                         AutomationException

The font for the specified symbol number.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

symbolNumber - The symbolNumber (in)

font - A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFontColor

IColor getFontColor(int symbolNumber)
                    throws IOException,
                           AutomationException

The font color for the specified symbol number.

Product Availability

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

Parameters:

symbolNumber - The symbolNumber (in)

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFontColorByRef

void setFontColorByRef(int symbolNumber,
                       IColor color)
                       throws IOException,
                              AutomationException

The font color for the specified symbol number.

Product Availability

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

Parameters:

symbolNumber - The symbolNumber (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextSymbol

ITextSymbol getTextSymbol(int symbolNumber)
                          throws IOException,
                                 AutomationException

The text symbol for the specified symbol number.

Product Availability

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

Parameters:

symbolNumber - The symbolNumber (in)

Returns:

A reference to a com.esri.arcgis.display.ITextSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextSymbolByRef

void setTextSymbolByRef(int symbolNumber,
                        ITextSymbol symbol)
                        throws IOException,
                               AutomationException

The text symbol for the specified symbol number.

Product Availability

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

Parameters:

symbolNumber - The symbolNumber (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLevelCount

int getLevelCount()
                  throws IOException,
                         AutomationException

The number of levels in the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLevelNumber

int getLevelNumber(int index)
                   throws IOException,
                          AutomationException

The level number at the specified index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The pLevelNumber

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLevelVisibility

boolean isLevelVisibility(int levelNumber)
                          throws IOException,
                                 AutomationException

Indicates if the level at the specified level number is visible.

Product Availability

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

Parameters:

levelNumber - The levelNumber (in)

Returns:

The visible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLevelVisibility

void setLevelVisibility(int levelNumber,
                        boolean visible)
                        throws IOException,
                               AutomationException

Indicates if the level at the specified level number is visible.

Product Availability

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

Parameters:

levelNumber - The levelNumber (in)

visible - The visible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getArrowSymbol

ILineSymbol getArrowSymbol()
                           throws IOException,
                                  AutomationException

The line symbol for the arrow.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.display.ILineSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setArrowSymbolByRef

void setArrowSymbolByRef(ILineSymbol symbol)
                         throws IOException,
                                AutomationException

The line symbol for the arrow.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

generateGraphics

IEnumElement generateGraphics(IEnvelope box,
                              IDisplay display)
                              throws IOException,
                                     AutomationException

Generates graphic elements from the annotation features. The optional envelope specifies a bounding box. The display is used for converting from map units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startGeneratingGraphics

void startGeneratingGraphics(IEnvelope box,
                             IDisplay display,
                             boolean withAttributes)
                             throws IOException,
                                    AutomationException

Starts a graphics generation process from the annotation features. The optional envelope specifies a bounding box. The display is used for converting from map units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

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

withAttributes - The withAttributes (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNextGraphic

IElement getNextGraphic()
                        throws IOException,
                               AutomationException

Generates the next graphic element in the graphics generation loop. Returns a NULL element after the last annotation feature has been read. Call only after StartGeneratingGraphics.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

nextFeatureAndGraphic

void nextFeatureAndGraphic(IFeature[] feature,
                           IElement[] element)
                           throws IOException,
                                  AutomationException

Generates the next feature and graphic element in the graphics generation loop. Returns a NULL feature and element after the last annotation feature has been read. Call only after StartGeneratingGraphics.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (out: use single element array)

element - A reference to a com.esri.arcgis.carto.IElement (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.