com.esri.arcgis.carto
Interface IAnnotationLayer

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

FDOGraphicsLayer, IAnnotationLayerProxy

public interface IAnnotationLayer
extends java.io.Serializable

COM Interface 'IAnnotationLayer'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control the annotation layer.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID4aedc069_b599_424b_a374_49602abad308
static int	xxDummy Deprecated. Internal use only

Method Summary

void	beginAddElements() Begins a batch process for adding elements to a graphics layer.
void	doAddElements(IElementCollection pElements, int zorder) Adds a batch of elements to a graphics layer.
void	doAddFeature(IFeature pFeature, IElement pElement, int zorder, int annotationClassID, int status) Adds a feature and its corresponding element to a graphics layer.
void	doAddNullElement(int featureId, int annotationClassID, int status) Adds a feature and its corresponding element to a graphics layer.
void	endAddElements() Ends the batch process for adding elements to a graphics layer.
void	getAddErrorInfo(java.lang.String[] errors, java.lang.String[] filePath) The errors and the file and path of the GL*.log file which stores error information when Add is called in batch (using BeginAddElements and EndAddElements).
IColor	getUnplacedAnnotationColor() Indicates the color with which unplaced annotation is drawn.
boolean	isDrawUnplacedAnnotation() Indicates if unplaced annotation is going to draw.
void	setDrawUnplacedAnnotation(boolean flag) Indicates if unplaced annotation is going to draw.
void	setUnplacedAnnotationColorByRef(IColor color) Indicates the color with which unplaced annotation is drawn.
void	setupAttributeConversion(int numAttributes, int[] inputCols, int[] outputCols) Sets up attribute conversion parameters for batch conversion.

Field Detail

IID4aedc069_b599_424b_a374_49602abad308

static final int IID4aedc069_b599_424b_a374_49602abad308

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

beginAddElements

void beginAddElements()
                      throws java.io.IOException,
                             AutomationException

Begins a batch process for adding elements to a graphics layer.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setupAttributeConversion

void setupAttributeConversion(int numAttributes,
                              int[] inputCols,
                              int[] outputCols)
                              throws java.io.IOException,
                                     AutomationException

Sets up attribute conversion parameters for batch conversion.

Parameters:

numAttributes - The numAttributes (in)

inputCols - The inputCols (in)

outputCols - The outputCols (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

doAddFeature

void doAddFeature(IFeature pFeature,
                  IElement pElement,
                  int zorder,
                  int annotationClassID,
                  int status)
                  throws java.io.IOException,
                         AutomationException

Adds a feature and its corresponding element to a graphics layer.

Parameters:

pFeature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

pElement - A reference to a com.esri.arcgis.carto.IElement (in)

zorder - The zorder (in)

annotationClassID - The annotationClassID (in)

status - A com.esri.arcgis.carto.esriAnnotationStatus constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

doAddElements

void doAddElements(IElementCollection pElements,
                   int zorder)
                   throws java.io.IOException,
                          AutomationException

Adds a batch of elements to a graphics layer.

Parameters:

pElements - A reference to a com.esri.arcgis.carto.IElementCollection (in)

zorder - The zorder (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

endAddElements

void endAddElements()
                    throws java.io.IOException,
                           AutomationException

Ends the batch process for adding elements to a graphics layer.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

doAddNullElement

void doAddNullElement(int featureId,
                      int annotationClassID,
                      int status)
                      throws java.io.IOException,
                             AutomationException

Adds a feature and its corresponding element to a graphics layer.

Parameters:

featureId - The featureId (in)

annotationClassID - The annotationClassID (in)

status - A com.esri.arcgis.carto.esriAnnotationStatus constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDrawUnplacedAnnotation

boolean isDrawUnplacedAnnotation()
                                 throws java.io.IOException,
                                        AutomationException

Indicates if unplaced annotation is going to draw.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDrawUnplacedAnnotation

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

Indicates if unplaced annotation is going to draw.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUnplacedAnnotationColor

IColor getUnplacedAnnotationColor()
                                  throws java.io.IOException,
                                         AutomationException

Indicates the color with which unplaced annotation is drawn.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUnplacedAnnotationColorByRef

void setUnplacedAnnotationColorByRef(IColor color)
                                     throws java.io.IOException,
                                            AutomationException

Indicates the color with which unplaced annotation is drawn.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAddErrorInfo

void getAddErrorInfo(java.lang.String[] errors,
                     java.lang.String[] filePath)
                     throws java.io.IOException,
                            AutomationException

The errors and the file and path of the GL*.log file which stores error information when Add is called in batch (using BeginAddElements and EndAddElements).

Parameters:

errors - The errors (out: use single element array)

filePath - The filePath (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.