com.esri.arcgis.maplex
Class MaplexOverposter

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IMaplexOverposter, java.io.Serializable

public class MaplexOverposter
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMaplexOverposter

COM Class 'MaplexOverposter'. Generated 3/19/2015 1:20:49 PM from 'C:\ArcGIS\COM\esriMaplex.olb'

Description 'A label placement engine based on the Maplex label placement algorithms.' 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

Fields inherited from interface com.esri.arcgis.maplex.IMaplexOverposter

IID, IID20664808_0a3b_1eec_9fd3_feef422a6ea5, xxDummy

Constructor Summary

MaplexOverposter()
Constructs a MaplexOverposter using ArcGIS Engine.

MaplexOverposter(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MaplexOverposter theMaplexOverposter = (MaplexOverposter) obj;

Method Summary

void	addBarriers(int weight, IGeometryCollection barriers) Adds a barrier object that placed objects must avoid.
int	addClass(ILabelEngineLayerProperties props) Adds a class to the overposter and specifies its properties.
void	addFeature(int classIndex, IGeometry featureShape, ISymbol featureSymbol, int featureID, java.lang.String label, double labelAngle, int mapLevel) Adds a feature with its associated label (optional) to the overposter.
void	addSymbol(int classIndex, ISymbol symbol, IGeometry geometry, int featureID) Adds a symbol to be placed.
boolean	equals(java.lang.Object o) Compare this object with another
int	getCapabilities(ILayer layer) Overposter capabilities for the specified layer.
int	getClassCount() The number of classes.
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getPlacedLabelCount() The number of unplaced labels.
IEnumMaplexPlacedLabel	getPlacedLabels() Enumeration of placed labels.
int	getUnplacedLabelCount() The number of unplaced labels.
IEnumMaplexPlacedLabel	getUnplacedLabels() Enumeration of unplaced labels.
int	hashCode() the hashcode for this object
void	initialize(IEnvelope extent, IDisplay display, ISpatialReference spatialReference, IMaplexOverposterProperties overposterProps, ITrackCancel trackCancel) Initializes the overposter for drawing into the specified area of the map display.
void	placeLabels() Places labels using the overposter.
void	release() Release a MaplexOverposter.
void	resetClasses() Removes all classes from the overposter.

Methods inherited from class java.lang.Object

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

Constructor Detail

MaplexOverposter

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

Constructs a MaplexOverposter using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

MaplexOverposter

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

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

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

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

release

public void release()

Release a MaplexOverposter.

Specified by:

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

initialize

public void initialize(IEnvelope extent,
                       IDisplay display,
                       ISpatialReference spatialReference,
                       IMaplexOverposterProperties overposterProps,
                       ITrackCancel trackCancel)
                throws java.io.IOException,
                       AutomationException

Initializes the overposter for drawing into the specified area of the map display.

Specified by:

initialize in interface IMaplexOverposter

Parameters:

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

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

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

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCapabilities

public int getCapabilities(ILayer layer)
                    throws java.io.IOException,
                           AutomationException

Overposter capabilities for the specified layer.

Specified by:

getCapabilities in interface IMaplexOverposter

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

Returns:

A com.esri.arcgis.carto.esriOverposterCaps constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassCount

public int getClassCount()
                  throws java.io.IOException,
                         AutomationException

The number of classes.

Specified by:

getClassCount in interface IMaplexOverposter

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addClass

public int addClass(ILabelEngineLayerProperties props)
             throws java.io.IOException,
                    AutomationException

Adds a class to the overposter and specifies its properties.

Specified by:

addClass in interface IMaplexOverposter

Parameters:

props - A reference to a com.esri.arcgis.carto.ILabelEngineLayerProperties (in)

Returns:

The classIndex

Throws:

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

AutomationException - If the ArcObject component throws an exception.

resetClasses

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

Removes all classes from the overposter.

Specified by:

resetClasses in interface IMaplexOverposter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addFeature

public void addFeature(int classIndex,
                       IGeometry featureShape,
                       ISymbol featureSymbol,
                       int featureID,
                       java.lang.String label,
                       double labelAngle,
                       int mapLevel)
                throws java.io.IOException,
                       AutomationException

Adds a feature with its associated label (optional) to the overposter.

Specified by:

addFeature in interface IMaplexOverposter

Parameters:

classIndex - The classIndex (in)

featureShape - A reference to a com.esri.arcgis.geometry.IGeometry (in)

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

featureID - The featureID (in)

label - The label (in)

labelAngle - The labelAngle (in)

mapLevel - The mapLevel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addBarriers

public void addBarriers(int weight,
                        IGeometryCollection barriers)
                 throws java.io.IOException,
                        AutomationException

Adds a barrier object that placed objects must avoid.

Specified by:

addBarriers in interface IMaplexOverposter

Parameters:

weight - A com.esri.arcgis.carto.esriBasicOverposterWeight constant (in)

barriers - A reference to a com.esri.arcgis.geometry.IGeometryCollection (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addSymbol

public void addSymbol(int classIndex,
                      ISymbol symbol,
                      IGeometry geometry,
                      int featureID)
               throws java.io.IOException,
                      AutomationException

Adds a symbol to be placed.

Specified by:

addSymbol in interface IMaplexOverposter

Parameters:

classIndex - The classIndex (in)

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

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

featureID - The featureID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

placeLabels

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

Places labels using the overposter.

Specified by:

placeLabels in interface IMaplexOverposter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPlacedLabelCount

public int getPlacedLabelCount()
                        throws java.io.IOException,
                               AutomationException

The number of unplaced labels. Only valid after calling PlaceObjects.

Specified by:

getPlacedLabelCount in interface IMaplexOverposter

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUnplacedLabelCount

public int getUnplacedLabelCount()
                          throws java.io.IOException,
                                 AutomationException

The number of unplaced labels. Only valid after calling PlaceObjects.

Specified by:

getUnplacedLabelCount in interface IMaplexOverposter

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPlacedLabels

public IEnumMaplexPlacedLabel getPlacedLabels()
                                       throws java.io.IOException,
                                              AutomationException

Enumeration of placed labels.

Specified by:

getPlacedLabels in interface IMaplexOverposter

Returns:

A reference to a com.esri.arcgis.maplex.IEnumMaplexPlacedLabel

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUnplacedLabels

public IEnumMaplexPlacedLabel getUnplacedLabels()
                                         throws java.io.IOException,
                                                AutomationException

Enumeration of unplaced labels.

Specified by:

getUnplacedLabels in interface IMaplexOverposter

Returns:

A reference to a com.esri.arcgis.maplex.IEnumMaplexPlacedLabel

Throws:

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

AutomationException - If the ArcObject component throws an exception.