com.esri.arcgis.carto
Class AnnotateMap

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

All Implemented Interfaces:

IAnnotateMap, IAnnotateMap2, IConnectionPointContainer, IPersist, IPersistStream, ISupportErrorInfo, java.io.Serializable

public class AnnotateMap

extends java.lang.Object

implements IAnnotateMap, IAnnotateMap2, IConnectionPointContainer, IPersist, IPersistStream, ISupportErrorInfo

A renderer for labeling feature layers in a map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

See Also:

Serialized Form

Constructor Summary

AnnotateMap()
Constructs a AnnotateMap using ArcGIS Engine.

AnnotateMap(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

void	addIAnnotationErrorEventsListener(IAnnotationErrorEvents theListener)
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) Supported Platforms
boolean	equals(java.lang.Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) Supported Platforms
IAnnotateMap	getAsIAnnotateMap() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IAnnotateMap2	getAsIAnnotateMap2() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IConnectionPointContainer	getAsIConnectionPointContainer() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersist	getAsIPersist() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ISupportErrorInfo	getAsISupportErrorInfo() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
IUID	getFeatureLayerPropertiesID() The UID that is expected for feature layer properties.
java.lang.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) Supported Platforms
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) Supported Platforms
void	isDirty() Supported Platforms
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) Supported Platforms
void	removeIAnnotationErrorEventsListener(IAnnotationErrorEvents theListener)
void	save(IStream pstm, int fClearDirty) Supported Platforms

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotateMap

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

Constructs a AnnotateMap using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

AnnotateMap

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

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.
AnnotateMap theAnnotateMap = (AnnotateMap) obj;

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()

getAsIAnnotateMap

public IAnnotateMap getAsIAnnotateMap()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIAnnotateMap2

public IAnnotateMap2 getAsIAnnotateMap2()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIConnectionPointContainer

public IConnectionPointContainer getAsIConnectionPointContainer()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersist

public IPersist getAsIPersist()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISupportErrorInfo

public ISupportErrorInfo getAsISupportErrorInfo()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

addIAnnotationErrorEventsListener

public void addIAnnotationErrorEventsListener(IAnnotationErrorEvents theListener)
                                       throws java.io.IOException

Throws:

java.io.IOException

removeIAnnotationErrorEventsListener

public void removeIAnnotationErrorEventsListener(IAnnotationErrorEvents theListener)
                                          throws java.io.IOException

Throws:

java.io.IOException

getName

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

Description copied from interface: IAnnotateMap

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IAnnotateMap

Returns:

The name

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getFeatureLayerPropertiesID

public IUID getFeatureLayerPropertiesID()
                                 throws java.io.IOException,
                                        AutomationException

Description copied from interface: IAnnotateMap

The UID that is expected for feature layer properties.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFeatureLayerPropertiesID in interface IAnnotateMap

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

label

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

Description copied from interface: IAnnotateMap

Labels feature layers based on the properties given.

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:

java.io.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 java.io.IOException,
                 AutomationException

Description copied from interface: IAnnotateMap

Draws labels for feature layers based on the properties given.

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:

java.io.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 java.io.IOException,
                  AutomationException

Description copied from interface: IAnnotateMap2

Labels feature layers based on the properties given.

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:

AutomationException - If the ArcObject component throws an exception.

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

draw

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

Description copied from interface: IAnnotateMap2

Draws labels for feature layers based on the properties given.

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:

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

AutomationException - If the ArcObject component throws an exception.

getOverposterPropertiesID

public IUID getOverposterPropertiesID()
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IAnnotateMap2

The UID that is expected for overposter properties.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOverposterPropertiesID in interface IAnnotateMap2

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

enumConnectionPoints

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

Description copied from interface: IConnectionPointContainer

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

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

Description copied from interface: IConnectionPointContainer

Supported Platforms

Windows, Solaris, Linux

Description

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

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:

AutomationException - If the ArcObject component throws an exception.

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

getClassID

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

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isDirty

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

save

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: ISupportErrorInfo

Supported Platforms

Windows, Solaris, Linux

Description

Indicates whether the interface supports IErrorInfo.

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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