com.esri.arcgis.geodatabase
Class IFeatureWorkspaceAnnoProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.geodatabase.IFeatureWorkspaceAnnoProxy
All Implemented Interfaces:
IFeatureWorkspaceAnno, Externalizable, Serializable

public class IFeatureWorkspaceAnnoProxy
extends com.esri.arcgis.interop.Dispatch
implements IFeatureWorkspaceAnno, Serializable

Provides access to creating an annotation class as well as managing a symbol collection.

Remarks

IFeatureWorkspaceAnno is an optional interface supported by workspaces that represent geodatabases and contains specialized methods for creating geodatabase annotation feature classes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IFeatureWorkspaceAnnoProxy()
           
  IFeatureWorkspaceAnnoProxy(Object obj)
           
protected IFeatureWorkspaceAnnoProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 void addSymbolCollection(String name, Object symbolCollection)
          Updates the symbol collection in the class extension.
 IFeatureClass createAnnotationClass(String name, IFields fields, IUID cLSID, IUID eXTCLSID, String shapeFieldName, String configKeyword, IFeatureDataset dstFeatureDataset, IFeatureClass srcFeatureClass, Object annoProperties, Object referenceScale, Object symbolCollection, boolean autoCreate)
          Creates a new annotation feature class in the workspace.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void replaceSymbolCollection(String name, Object symbolCollection)
          Replaces the symbol collection in the class extension.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IFeatureWorkspaceAnnoProxy

public IFeatureWorkspaceAnnoProxy()

IFeatureWorkspaceAnnoProxy

public IFeatureWorkspaceAnnoProxy(Object obj)
                           throws IOException
Throws:
IOException

IFeatureWorkspaceAnnoProxy

protected IFeatureWorkspaceAnnoProxy(Object obj,
                                     String iid)
                              throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

createAnnotationClass

public IFeatureClass createAnnotationClass(String name,
                                           IFields fields,
                                           IUID cLSID,
                                           IUID eXTCLSID,
                                           String shapeFieldName,
                                           String configKeyword,
                                           IFeatureDataset dstFeatureDataset,
                                           IFeatureClass srcFeatureClass,
                                           Object annoProperties,
                                           Object referenceScale,
                                           Object symbolCollection,
                                           boolean autoCreate)
                                    throws IOException,
                                           AutomationException
Creates a new annotation feature class in the workspace.

Remarks

The CreateAnnotationClass method creates a new annotation feature class that may or may not be feature linked via a relationship class to features in a source feature class (the feature class being annotated).

The CLSID property must be set to esriCarto.AnnotationFeature and the EXTCLSID property must be set to esriCarto.AnnotationFeatureClassExtension. The srcFeatureClass parameter specifies the source feature class and may be set to 0 or Nothing for non-feature linked annotation.

The AnnoProperties parameter specifies the labeling properties to be used for the annotation, and must support the IAnnotateLayerPropertiesCollection interface. The ReferenceScale parameter specifies the reference scale to be used for the annotation. The SymbolCollection parameter specifies the symbols that will be referenced by the annotation elements for the annotation features in this feature class and must support the ISymbolCollection interface.

The autoCreate parameter applies to feature-linked annotation; setting it to True results in a new annotation feature being automatically created when a new feature in the source feature class is created.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
createAnnotationClass in interface IFeatureWorkspaceAnno
Parameters:
name - The name (in)
fields - A reference to a com.esri.arcgis.geodatabase.IFields (in)
cLSID - A reference to a com.esri.arcgis.system.IUID (in)
eXTCLSID - A reference to a com.esri.arcgis.system.IUID (in)
shapeFieldName - The shapeFieldName (in)
configKeyword - The configKeyword (in)
dstFeatureDataset - A reference to a com.esri.arcgis.geodatabase.IFeatureDataset (in)
srcFeatureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
annoProperties - A reference to another Object (IUnknown) (in)
referenceScale - A reference to another Object (IUnknown) (in)
symbolCollection - A reference to another Object (IUnknown) (in)
autoCreate - The autoCreate (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IFeatureClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addSymbolCollection

public void addSymbolCollection(String name,
                                Object symbolCollection)
                         throws IOException,
                                AutomationException
Updates the symbol collection in the class extension.

Remarks

The AddSymbolCollection and ReplaceSymbolCollection may be used to augment and replace the symbol collection associated with an annotation feature class. Use extreme caution when using these methods--be aware that there may be existing annotation features in the annotation feature class that have annotation elements that may reference symbols by ID. Deleting the symbol for such an ID or replacing it with a different symbol may leave the geometry of the annotation feature out of phase with its symbol, resulting in subsequent problems during drawing and selection. These methods are for use by specialized data loaders that can guarantee the integrity of referenced symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
addSymbolCollection in interface IFeatureWorkspaceAnno
Parameters:
name - The name (in)
symbolCollection - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

replaceSymbolCollection

public void replaceSymbolCollection(String name,
                                    Object symbolCollection)
                             throws IOException,
                                    AutomationException
Replaces the symbol collection in the class extension.

Remarks

The AddSymbolCollection and ReplaceSymbolCollection may be used to augment and replace the symbol collection associated with an annotation feature class. Use extreme caution when using these methods--be aware that there may be existing annotation features in the annotation feature class that have annotation elements that may reference symbols by ID. Deleting the symbol for such an ID or replacing it with a different symbol may leave the geometry of the annotation feature out of phase with its symbol, resulting in subsequent problems during drawing and selection. These methods are for use by specialized data loaders that can guarantee the integrity of referenced symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
replaceSymbolCollection in interface IFeatureWorkspaceAnno
Parameters:
name - The name (in)
symbolCollection - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException