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, java.io.Externalizable, java.io.Serializable

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

COM Class 'AnnotateMap'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'A renderer for labeling feature layers in a map.' 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

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.carto.IAnnotateMap

IID, IID8c439003_14ec_11d2_a27e_080009b6f22b, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IAnnotateMap2

IID, IIDb3b6436f_87e8_42a9_98a7_0f301fc302fd, xxDummy

Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

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.
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(java.lang.Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
IUID	getFeatureLayerPropertiesID() The UID that is expected for feature layer properties.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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) 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(java.io.ObjectInput in)
void	release() Release a AnnotateMap.
void	removeIAnnotationErrorEventsListener(IAnnotationErrorEvents theListener) removeIAnnotationErrorEventsListener.
void	save(IStream pstm, int fClearDirty) save
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

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.
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:

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

Deprecated. Internal use only.

Specified by:

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

addIAnnotationErrorEventsListener

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

addIAnnotationErrorEventsListener. Listen to events generated by this class.

Parameters:

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

Throws:

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

removeIAnnotationErrorEventsListener

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

removeIAnnotationErrorEventsListener. Stop listening to events generated by this class.

Parameters:

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

Throws:

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

release

public void release()

Release a AnnotateMap.

Specified by:

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

getName

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

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

Specified by:

getName in interface IAnnotateMap

Specified by:

getName in interface IAnnotateMap2

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureLayerPropertiesID

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

The UID that is expected for feature layer properties.

Specified by:

getFeatureLayerPropertiesID in interface IAnnotateMap

Specified by:

getFeatureLayerPropertiesID in interface IAnnotateMap2

Returns:

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

Throws:

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

Labels feature layers based on the properties given.

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

Draws labels for feature layers based on the properties given.

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

Labels feature layers based on the properties given.

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:

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

Draws labels for feature layers based on the properties given.

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

The UID that is expected for overposter properties.

Specified by:

getOverposterPropertiesID in interface IAnnotateMap2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

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

enumConnectionPoints

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

findConnectionPoint

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:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

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

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

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

save

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

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

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException