com.esri.arcgis.maplex
Class MaplexAnnotateFeature

java.lang.Object
  com.esri.arcgis.maplex.MaplexAnnotateFeature

All Implemented Interfaces:

IAnnotateFeature, IAnnotateFeature2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class MaplexAnnotateFeature
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAnnotateFeature, IAnnotateFeature2

A renderer for labeling one feature.

Description

MaplexAnnotateFeature labels a single feature based on the properties given, and returns a TextElement (as an IElement).

Used for one-off labeling of a feature - updating feature-linked annotation and edit tools, for example.

No other labels or features are considered during placement.

The spatial reference of the data is used - no map is involved.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

MaplexAnnotateFeature()
Constructs a MaplexAnnotateFeature using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	hashCode() the hashcode for this object
void	label(IAnnotateLayerProperties annoLayerProps, IFeature feature, IDisplay display, ISpatialReference pSpatialRef, IBarrierCollection barrierColl, IElement[] placedElement, IElement[] unplacedElement) Labels a feature based on the properties given.
void	label(IOverposterProperties overposterProps, IAnnotateLayerProperties annoLayerProps, IFeature feature, IDisplay display, ISpatialReference pSpatialRef, IBarrierCollection barrierColl, IElement[] placedElement, IElement[] unplacedElement) Labels a feature based on the properties given.

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

MaplexAnnotateFeature

public MaplexAnnotateFeature()
                      throws IOException,
                             UnknownHostException

Constructs a MaplexAnnotateFeature using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

MaplexAnnotateFeature

public MaplexAnnotateFeature(Object obj)
                      throws IOException

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

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

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

label

public void label(IAnnotateLayerProperties annoLayerProps,
                  IFeature feature,
                  IDisplay display,
                  ISpatialReference pSpatialRef,
                  IBarrierCollection barrierColl,
                  IElement[] placedElement,
                  IElement[] unplacedElement)
           throws IOException,
                  AutomationException

Labels a feature 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 IAnnotateFeature

Parameters:

annoLayerProps - A reference to a com.esri.arcgis.carto.IAnnotateLayerProperties (in)

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

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

pSpatialRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

barrierColl - A reference to a com.esri.arcgis.carto.IBarrierCollection (in)

placedElement - A reference to a com.esri.arcgis.carto.IElement (out: use single element array)

unplacedElement - A reference to a com.esri.arcgis.carto.IElement (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

label

public void label(IOverposterProperties overposterProps,
                  IAnnotateLayerProperties annoLayerProps,
                  IFeature feature,
                  IDisplay display,
                  ISpatialReference pSpatialRef,
                  IBarrierCollection barrierColl,
                  IElement[] placedElement,
                  IElement[] unplacedElement)
           throws IOException,
                  AutomationException

Labels a feature 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 IAnnotateFeature2

Parameters:

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

annoLayerProps - A reference to a com.esri.arcgis.carto.IAnnotateLayerProperties (in)

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

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

pSpatialRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

barrierColl - A reference to a com.esri.arcgis.carto.IBarrierCollection (in)

placedElement - A reference to a com.esri.arcgis.carto.IElement (out: use single element array)

unplacedElement - A reference to a com.esri.arcgis.carto.IElement (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.