com.esri.arcgis.cartox

Class MEAnnotationFeatureClassExtension

java.lang.Object

com.esri.arcgis.cartox.MEAnnotationFeatureClassExtension

All Implemented Interfaces:

IMEAnnotationFeatureClassExtensionBridge, IClassExtension, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class MEAnnotationFeatureClassExtension
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IClassExtension, IMEAnnotationFeatureClassExtensionBridge

COM Class 'MEAnnotationFeatureClassExtension'. Generated 9/23/2025 7:46:20 AM from 'X:\ArcGIS\com\server\esriCartoX.tlb'

Description 'A class extension which contains all the properties for an annotation feature class.' 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.cartox.IMEAnnotationFeatureClassExtensionBridge

IID, IID76aa4719_0c0c_455d_b84c_0f2080f90e51, xxDummy

Constructor Summary

Constructors

Constructor and Description
MEAnnotationFeatureClassExtension() Constructs a MEAnnotationFeatureClassExtension using ArcGIS Engine.
MEAnnotationFeatureClassExtension(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. MEAnnotationFeatureClassExtension theMEAnnotationFeatureClassExtension = (MEAnnotationFeatureClassExtension) obj;

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	getBuild() The build number of the annotation feature class.
java.lang.String	getCIMVersion() The CIM Version of the annotation feature class.
static java.lang.String	getClsid() getClsid.
IFeatureClass	getFeatureClass() The annotation feature class this class extension applies to.
java.lang.String	getGeneralPlacementPropertiesJSON() The general placement properties of the label engine.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
java.lang.String	getLabelClassCollectionJSON() The annotation class properties of the annotation feature class expressed as a collection of label classes.
IFeatureClass	getLinkedFeatureClass() The feature class to which the annotation class is feature linked.
int	getMaxLabelClassID() The maximum symbol ID value of the symbol collection.
int	getMaxSymbolID() The maximum symbol ID value of the symbol collection.
double	getReferenceScale() The reference scale.
IUnit	getReferenceScaleUnit() The reference scale units of the annotation feature class.
java.lang.String	getSymbolCollectionJSON() The symbol collection of the annotation feature class as a JSON string.
short	getVersion() The version of the annotation feature class.
int	hashCode() the hashcode for this object
void	init(IClassHelper classHelper, IPropertySet extensionProperties) Initializes the extension, passing in a reference to its class helper.
boolean	isAllowSymbolOverrides() Indicates if an annotation may override a symbol property even though it references the symbol collection.
boolean	isAutoCreate() Indicates if feature-linked annotation is to be automatically created when a feature is created.
boolean	isRequireSymbolID() Indicates if an annotation must reference a symbol in the symbol collection.
boolean	isUpdateOnShapeChange() Indicates if an annotation is to be automatically recreated when a feature's shape is changed.
void	release() Release this COM object reference
void	resetProperties() Resets the annotation feature class extension to the properties persisted in the dataset.
void	setAllowSymbolOverrides(boolean flag) Indicates if an annotation may override a symbol property even though it references the symbol collection.
void	setAutoCreate(boolean flag) Indicates if feature-linked annotation is to be automatically created when a feature is created.
void	setBuild(java.lang.String build) The build number of the annotation feature class.
void	setCIMVersion(java.lang.String version) The CIM Version of the annotation feature class.
void	setGeneralPlacementPropertiesJSON(java.lang.String json) The general placement properties of the label engine.
void	setLabelClassCollectionJSON(java.lang.String json) The annotation class properties of the annotation feature class expressed as a collection of label classes.
void	setReferenceScale(double refScale) The reference scale.
void	setReferenceScaleUnit(IUnit unit) The reference scale units of the annotation feature class.
void	setRequireSymbolID(boolean flag) Indicates if an annotation must reference a symbol in the symbol collection.
void	setSymbolCollectionJSON(java.lang.String json) The symbol collection of the annotation feature class as a JSON string.
void	setUpdateOnShapeChange(boolean flag) Indicates if an annotation is to be automatically recreated when a feature's shape is changed.
void	setVersion(short vers) The version of the annotation feature class.
void	shutdown() Informs the extension that its class helper is going away.
void	updateProperties() Updates the annotation feature class extension properties in the database with this object's properties in their current state.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MEAnnotationFeatureClassExtension

public MEAnnotationFeatureClassExtension()
                                  throws java.io.IOException,
                                         java.net.UnknownHostException

Constructs a MEAnnotationFeatureClassExtension using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

MEAnnotationFeatureClassExtension

public MEAnnotationFeatureClassExtension(java.lang.Object obj)
                                  throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MEAnnotationFeatureClassExtension theMEAnnotationFeatureClassExtension = (MEAnnotationFeatureClassExtension) obj;

Construct a MEAnnotationFeatureClassExtension using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to MEAnnotationFeatureClassExtension.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

init

public void init(IClassHelper classHelper,
                 IPropertySet extensionProperties)
          throws java.io.IOException,
                 AutomationException

Initializes the extension, passing in a reference to its class helper.

Remarks

If a reference to the class is required by other class extension members, the class helper should be stored in a member variable. Storing an object or feature class directly within a class extension is strongly discouraged.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

init in interface IClassExtension

Parameters:

classHelper - A reference to a com.esri.arcgis.geodatabase.IClassHelper (in)

extensionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

shutdown

public void shutdown()
              throws java.io.IOException,
                     AutomationException

Informs the extension that its class helper is going away.

Remarks

Shutdown is called when the extension's class is cleared from the client's memory, or when the extension is removed from the class. Note that if a class is deleted from a geodatabase, it may remain in memory, so this should not be relied upon for behavior that should be triggered by a class' deletion.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

shutdown in interface IClassExtension

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReferenceScale

public void setReferenceScale(double refScale)
                       throws java.io.IOException,
                              AutomationException

The reference scale.

Specified by:

setReferenceScale in interface IMEAnnotationFeatureClassExtensionBridge

Parameters:

refScale - The refScale (in)

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.

Specified by:

getReferenceScale in interface IMEAnnotationFeatureClassExtensionBridge

Returns:

The refScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReferenceScaleUnit

public void setReferenceScaleUnit(IUnit unit)
                           throws java.io.IOException,
                                  AutomationException

The reference scale units of the annotation feature class. Only applicable if the feature class has an unknown coordinate system.

Specified by:

setReferenceScaleUnit in interface IMEAnnotationFeatureClassExtensionBridge

Parameters:

unit - A reference to a com.esri.arcgis.geometry.IUnit (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getReferenceScaleUnit

public IUnit getReferenceScaleUnit()
                            throws java.io.IOException,
                                   AutomationException

The reference scale units of the annotation feature class. Only applicable if the feature class has an unknown coordinate system.

Specified by:

getReferenceScaleUnit in interface IMEAnnotationFeatureClassExtensionBridge

Returns:

A reference to a com.esri.arcgis.geometry.IUnit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRequireSymbolID

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

Indicates if an annotation must reference a symbol in the symbol collection.

Specified by:

setRequireSymbolID in interface IMEAnnotationFeatureClassExtensionBridge

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRequireSymbolID

public boolean isRequireSymbolID()
                          throws java.io.IOException,
                                 AutomationException

Indicates if an annotation must reference a symbol in the symbol collection.

Specified by:

isRequireSymbolID in interface IMEAnnotationFeatureClassExtensionBridge

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAllowSymbolOverrides

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

Indicates if an annotation may override a symbol property even though it references the symbol collection.

Specified by:

setAllowSymbolOverrides in interface IMEAnnotationFeatureClassExtensionBridge

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAllowSymbolOverrides

public boolean isAllowSymbolOverrides()
                               throws java.io.IOException,
                                      AutomationException

Indicates if an annotation may override a symbol property even though it references the symbol collection.

Specified by:

isAllowSymbolOverrides in interface IMEAnnotationFeatureClassExtensionBridge

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAutoCreate

public boolean isAutoCreate()
                     throws java.io.IOException,
                            AutomationException

Indicates if feature-linked annotation is to be automatically created when a feature is created.

Specified by:

isAutoCreate in interface IMEAnnotationFeatureClassExtensionBridge

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAutoCreate

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

Indicates if feature-linked annotation is to be automatically created when a feature is created.

Specified by:

setAutoCreate in interface IMEAnnotationFeatureClassExtensionBridge

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUpdateOnShapeChange

public boolean isUpdateOnShapeChange()
                              throws java.io.IOException,
                                     AutomationException

Indicates if an annotation is to be automatically recreated when a feature's shape is changed.

Specified by:

isUpdateOnShapeChange in interface IMEAnnotationFeatureClassExtensionBridge

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUpdateOnShapeChange

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

Indicates if an annotation is to be automatically recreated when a feature's shape is changed.

Specified by:

setUpdateOnShapeChange in interface IMEAnnotationFeatureClassExtensionBridge

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymbolCollectionJSON

public void setSymbolCollectionJSON(java.lang.String json)
                             throws java.io.IOException,
                                    AutomationException

The symbol collection of the annotation feature class as a JSON string.

Specified by:

setSymbolCollectionJSON in interface IMEAnnotationFeatureClassExtensionBridge

Parameters:

json - The json (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSymbolCollectionJSON

public java.lang.String getSymbolCollectionJSON()
                                         throws java.io.IOException,
                                                AutomationException

The symbol collection of the annotation feature class as a JSON string.

Specified by:

getSymbolCollectionJSON in interface IMEAnnotationFeatureClassExtensionBridge

Returns:

The json

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 feature class. Used for internal purposes.

Specified by:

getVersion in interface IMEAnnotationFeatureClassExtensionBridge

Returns:

The vers

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVersion

public void setVersion(short vers)
                throws java.io.IOException,
                       AutomationException

The version of the annotation feature class. Used for internal purposes.

Specified by:

setVersion in interface IMEAnnotationFeatureClassExtensionBridge

Parameters:

vers - The vers (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelClassCollectionJSON

public void setLabelClassCollectionJSON(java.lang.String json)
                                 throws java.io.IOException,
                                        AutomationException

The annotation class properties of the annotation feature class expressed as a collection of label classes.

Specified by:

setLabelClassCollectionJSON in interface IMEAnnotationFeatureClassExtensionBridge

Parameters:

json - The json (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelClassCollectionJSON

public java.lang.String getLabelClassCollectionJSON()
                                             throws java.io.IOException,
                                                    AutomationException

The annotation class properties of the annotation feature class expressed as a collection of label classes.

Specified by:

getLabelClassCollectionJSON in interface IMEAnnotationFeatureClassExtensionBridge

Returns:

The json

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeneralPlacementPropertiesJSON

public void setGeneralPlacementPropertiesJSON(java.lang.String json)
                                       throws java.io.IOException,
                                              AutomationException

The general placement properties of the label engine.

Specified by:

setGeneralPlacementPropertiesJSON in interface IMEAnnotationFeatureClassExtensionBridge

Parameters:

json - The json (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeneralPlacementPropertiesJSON

public java.lang.String getGeneralPlacementPropertiesJSON()
                                                   throws java.io.IOException,
                                                          AutomationException

The general placement properties of the label engine.

Specified by:

getGeneralPlacementPropertiesJSON in interface IMEAnnotationFeatureClassExtensionBridge

Returns:

The json

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateProperties

public void updateProperties()
                      throws java.io.IOException,
                             AutomationException

Updates the annotation feature class extension properties in the database with this object's properties in their current state.

Specified by:

updateProperties in interface IMEAnnotationFeatureClassExtensionBridge

Throws:

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

AutomationException - If the ArcObject component throws an exception.

resetProperties

public void resetProperties()
                     throws java.io.IOException,
                            AutomationException

Resets the annotation feature class extension to the properties persisted in the dataset.

Specified by:

resetProperties in interface IMEAnnotationFeatureClassExtensionBridge

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureClass

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

The annotation feature class this class extension applies to.

Specified by:

getFeatureClass in interface IMEAnnotationFeatureClassExtensionBridge

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.

getLinkedFeatureClass

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

The feature class to which the annotation class is feature linked.

Specified by:

getLinkedFeatureClass in interface IMEAnnotationFeatureClassExtensionBridge

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.

getMaxLabelClassID

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

The maximum symbol ID value of the symbol collection.

Specified by:

getMaxLabelClassID in interface IMEAnnotationFeatureClassExtensionBridge

Returns:

The val

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxSymbolID

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

The maximum symbol ID value of the symbol collection.

Specified by:

getMaxSymbolID in interface IMEAnnotationFeatureClassExtensionBridge

Returns:

The val

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCIMVersion

public java.lang.String getCIMVersion()
                               throws java.io.IOException,
                                      AutomationException

The CIM Version of the annotation feature class.

Specified by:

getCIMVersion in interface IMEAnnotationFeatureClassExtensionBridge

Returns:

The version

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCIMVersion

public void setCIMVersion(java.lang.String version)
                   throws java.io.IOException,
                          AutomationException

The CIM Version of the annotation feature class.

Specified by:

setCIMVersion in interface IMEAnnotationFeatureClassExtensionBridge

Parameters:

version - The version (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBuild

public java.lang.String getBuild()
                          throws java.io.IOException,
                                 AutomationException

The build number of the annotation feature class. Used for internal purposes.

Specified by:

getBuild in interface IMEAnnotationFeatureClassExtensionBridge

Returns:

The build

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBuild

public void setBuild(java.lang.String build)
              throws java.io.IOException,
                     AutomationException

The build number of the annotation feature class. Used for internal purposes.

Specified by:

setBuild in interface IMEAnnotationFeatureClassExtensionBridge

Parameters:

build - The build (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.