com.esri.arcgis.maplex
Interface IMaplexOverposter

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IMaplexOverposterProxy, MaplexOverposter

public interface IMaplexOverposter
extends java.io.Serializable

COM Interface 'IMaplexOverposter'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriMaplex.olb'

Description: 'Provides access to members that control the Maplex Overposter.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID20664808_0a3b_1eec_9fd3_feef422a6ea5
static int	xxDummy Deprecated. Internal use only

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.
int	getCapabilities(ILayer layer) Overposter capabilities for the specified layer.
int	getClassCount() The number of classes.
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.
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	resetClasses() Removes all classes from the overposter.

Field Detail

IID20664808_0a3b_1eec_9fd3_feef422a6ea5

static final int IID20664808_0a3b_1eec_9fd3_feef422a6ea5

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

initialize

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.

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

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

Overposter capabilities for the specified layer.

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

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

The number of classes.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addClass

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

Adds a class to the overposter and specifies its properties.

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

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

Removes all classes from the overposter.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addFeature

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.

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

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

Adds a barrier object that placed objects must avoid.

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

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

Adds a symbol to be placed.

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

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

Places labels using the overposter.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPlacedLabelCount

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

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

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUnplacedLabelCount

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

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

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPlacedLabels

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

Enumeration of placed labels.

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

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

Enumeration of unplaced labels.

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.