com.esri.arcgis.carto
Interface IAnnoClass

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IAnnotationClassExtension

All Known Implementing Classes:

AnnotationFeatureClassExtension, IAnnoClassProxy, IAnnotationClassExtensionProxy

public interface IAnnoClass

extends java.io.Serializable

Provides access to members that control the annotation class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

When To Use

The IAnnoClass interface is mainly for getting properties of an annotation feature class. For example, use the IAnnoClass interface to view the reference scale and symbols associated with it. You can also draw individual annotation features using this interface.

See Also:

IFeatureClass, IAnnoClassAdmin3, IAnnotationClassExtension

Method Summary

void	draw(IAnnotationFeature annoFeature, IDisplay display, ISymbol symbol) Draws the given annotation feature.
IAnnotateLayerPropertiesCollection	getAnnoProperties() The labeling properties annotation classes.
int	getElementFieldIndex() The element field index.
IFeatureClass	getFeatureClass() The feature class.
int	getFeatureIDFieldIndex() The feature ID field index.
double	getReferenceScale() The reference scale.
int	getReferenceScaleUnits() The units of the reference scale.
ISymbol	getSymbol(int symbolID) The symbol associated with the given ID.
ISymbolCollection	getSymbolCollection() The symbol collection.
short	getVersion() The version of the annotation class.

Method Detail

getFeatureClass

public IFeatureClass getFeatureClass()
                              throws java.io.IOException,
                                     AutomationException

The feature class.

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geodatabase.IFeatureClass

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAnnoProperties

public IAnnotateLayerPropertiesCollection getAnnoProperties()
                                                     throws java.io.IOException,
                                                            AutomationException

The labeling properties annotation classes.

Supported Platforms

Windows, Solaris, Linux

Remarks

Returns Nothing if no labeling properties set. This occurs when the annotation feature class is created by converting labels to annotation or when created as an annotation target containing graphics.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSymbol

public ISymbol getSymbol(int symbolID)
                  throws java.io.IOException,
                         AutomationException

The symbol associated with the given ID.

Supported Platforms

Windows, Solaris, Linux

Parameters:

symbolID - The symbolID (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getReferenceScale

public double getReferenceScale()
                         throws java.io.IOException,
                                AutomationException

The reference scale.

Supported Platforms

Windows, Solaris, Linux

Returns:

The referenceScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getReferenceScaleUnits

public int getReferenceScaleUnits()
                           throws java.io.IOException,
                                  AutomationException

The units of the reference scale.

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSymbolCollection

public ISymbolCollection getSymbolCollection()
                                      throws java.io.IOException,
                                             AutomationException

The symbol collection.

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVersion

public short getVersion()
                 throws java.io.IOException,
                        AutomationException

The version of the annotation class.

Supported Platforms

Windows, Solaris, Linux

Returns:

The version

Throws:

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

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IAnnotationFeature annoFeature,
                 IDisplay display,
                 ISymbol symbol)
          throws java.io.IOException,
                 AutomationException

Draws the given annotation feature.

Supported Platforms

Windows, Solaris, Linux

Parameters:

annoFeature - A reference to a com.esri.arcgis.carto.IAnnotationFeature (in)

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getElementFieldIndex

public int getElementFieldIndex()
                         throws java.io.IOException,
                                AutomationException

The element field index.

Supported Platforms

Windows, Solaris, Linux

Returns:

The elementFieldIndex

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureIDFieldIndex

public int getFeatureIDFieldIndex()
                           throws java.io.IOException,
                                  AutomationException

The feature ID field index.

Supported Platforms

Windows, Solaris, Linux

Returns:

The featureIDFieldIndex

Throws:

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

AutomationException - If the ArcObject component throws an exception.