com.esri.arcgis.carto
Class AnnotateMap

java.lang.Object
  com.esri.arcgis.carto.AnnotateMap

All Implemented Interfaces:

IAnnotateMap, IAnnotateMap2, IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, ISupportErrorInfo, Externalizable, Serializable

public class AnnotateMap
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAnnotateMap, IAnnotateMap2, IConnectionPointContainer, IPersist, IPersistStream, ISupportErrorInfo, Externalizable

A renderer for labeling feature layers in a map.

Description

AnnotateMap wraps the low level functionaility of the BasicOverposter (ESRI Standard Label Engine) and is used for map labeling and creating annotation from labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

AnnotateMap()
Constructs a AnnotateMap using ArcGIS Engine.

AnnotateMap(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AnnotateMap theAnnotateMap = (AnnotateMap) obj;

Method Summary

void	addIAnnotationErrorEventsListener(IAnnotationErrorEvents theListener) addIAnnotationErrorEventsListener.
void	draw(IDisplay display, IAnnotateMapProperties annoMapCmdProps, IMap map, ITrackCancel trackCancel) Draws labels for feature layers based on the properties given.
void	draw(IDisplay display, IOverposterProperties overposterProps, IAnnotateMapProperties annoMapCmdProps, IMap map, ITrackCancel trackCancel) Draws labels for feature layers based on the properties given.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
IUID	getFeatureLayerPropertiesID() The UID that is expected for feature layer properties.
String	getName() Name of the engine that will create the labels ( annotation).
IUID	getOverposterPropertiesID() The UID that is expected for overposter properties.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	isDirty() isDirty
void	label(IAnnotateMapProperties annoMapCmdProps, IMap map, ITrackCancel trackCancel) Labels feature layers based on the properties given.
void	label(IOverposterProperties overposterProps, IAnnotateMapProperties annoMapCmdProps, IMap map, ITrackCancel trackCancel) Labels feature layers based on the properties given.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	removeIAnnotationErrorEventsListener(IAnnotationErrorEvents theListener) removeIAnnotationErrorEventsListener.
void	save(IStream pstm, int fClearDirty) save
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

AnnotateMap

public AnnotateMap()
            throws IOException,
                   UnknownHostException

Constructs a AnnotateMap using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

AnnotateMap

public AnnotateMap(Object obj)
            throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

addIAnnotationErrorEventsListener

public void addIAnnotationErrorEventsListener(IAnnotationErrorEvents theListener)
                                       throws IOException

addIAnnotationErrorEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.IAnnotationErrorEvents interface.

Throws:

IOException - If there are communications problems.

removeIAnnotationErrorEventsListener

public void removeIAnnotationErrorEventsListener(IAnnotationErrorEvents theListener)
                                          throws IOException

removeIAnnotationErrorEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.IAnnotationErrorEvents interface.

Throws:

IOException - If there are communications problems.

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the engine that will create the labels ( annotation).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IAnnotateMap

Specified by:

getName in interface IAnnotateMap2

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureLayerPropertiesID

public IUID getFeatureLayerPropertiesID()
                                 throws IOException,
                                        AutomationException

The UID that is expected for feature layer properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFeatureLayerPropertiesID in interface IAnnotateMap

Specified by:

getFeatureLayerPropertiesID in interface IAnnotateMap2

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

label

public void label(IAnnotateMapProperties annoMapCmdProps,
                  IMap map,
                  ITrackCancel trackCancel)
           throws IOException,
                  AutomationException

Labels feature layers based on the properties given.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

label in interface IAnnotateMap

Parameters:

annoMapCmdProps - A reference to a com.esri.arcgis.carto.IAnnotateMapProperties (in)

map - A reference to a com.esri.arcgis.carto.IMap (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass 0 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IDisplay display,
                 IAnnotateMapProperties annoMapCmdProps,
                 IMap map,
                 ITrackCancel trackCancel)
          throws IOException,
                 AutomationException

Draws labels for feature layers based on the properties given.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

draw in interface IAnnotateMap

Parameters:

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

annoMapCmdProps - A reference to a com.esri.arcgis.carto.IAnnotateMapProperties (in)

map - A reference to a com.esri.arcgis.carto.IMap (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass 0 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

label

public void label(IOverposterProperties overposterProps,
                  IAnnotateMapProperties annoMapCmdProps,
                  IMap map,
                  ITrackCancel trackCancel)
           throws IOException,
                  AutomationException

Labels feature layers based on the properties given.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

label in interface IAnnotateMap2

Parameters:

overposterProps - A reference to a com.esri.arcgis.carto.IOverposterProperties (in)

annoMapCmdProps - A reference to a com.esri.arcgis.carto.IAnnotateMapProperties (in)

map - A reference to a com.esri.arcgis.carto.IMap (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass 0 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IDisplay display,
                 IOverposterProperties overposterProps,
                 IAnnotateMapProperties annoMapCmdProps,
                 IMap map,
                 ITrackCancel trackCancel)
          throws IOException,
                 AutomationException

Draws labels for feature layers based on the properties given.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

draw in interface IAnnotateMap2

Parameters:

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

overposterProps - A reference to a com.esri.arcgis.carto.IOverposterProperties (in)

annoMapCmdProps - A reference to a com.esri.arcgis.carto.IAnnotateMapProperties (in)

map - A reference to a com.esri.arcgis.carto.IMap (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass 0 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOverposterPropertiesID

public IUID getOverposterPropertiesID()
                               throws IOException,
                                      AutomationException

The UID that is expected for overposter properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOverposterPropertiesID in interface IAnnotateMap2

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws IOException,
                                 AutomationException

enumConnectionPoints

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws IOException,
                                AutomationException

findConnectionPoint

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (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

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException