com.esri.arcgis.maplex
Class IMaplexOverposterProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.maplex.IMaplexOverposterProxy

All Implemented Interfaces:

java.io.Externalizable, IMaplexOverposter, java.io.Serializable

public class IMaplexOverposterProxy

extends Dispatch

implements IMaplexOverposter, java.io.Serializable

Provides access to members that control the Maplex Overposter.

Product Availability

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

See Also:

Serialized Form

Field Summary

static java.lang.Class

targetClass

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF

Constructor Summary

	IMaplexOverposterProxy() For internal use only
	IMaplexOverposterProxy(java.lang.Object obj)
protected	IMaplexOverposterProxy(java.lang.Object obj, java.lang.String iid)
	IMaplexOverposterProxy(java.lang.String CLSID, java.lang.String host, AuthInfo authInfo)
protected	IMaplexOverposterProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, AuthInfo authInfo)

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	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) Adds a Java object to be a listener for a specific kind of event generated by the COM object.
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	removeListener(java.lang.String iidStr, java.lang.Object theListener) Removes a Java object as a listener to events generated by a COM object.
void	resetClasses() Removes all classes from the overposter.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, hashCode, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, readExternal, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

targetClass

public static final java.lang.Class targetClass

Constructor Detail

IMaplexOverposterProxy

public IMaplexOverposterProxy(java.lang.String CLSID,
                              java.lang.String host,
                              AuthInfo authInfo)
                       throws java.net.UnknownHostException,
                              java.io.IOException

IMaplexOverposterProxy

public IMaplexOverposterProxy()

For internal use only

IMaplexOverposterProxy

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

IMaplexOverposterProxy

protected IMaplexOverposterProxy(java.lang.Object obj,
                                 java.lang.String iid)
                          throws java.io.IOException

IMaplexOverposterProxy

protected IMaplexOverposterProxy(java.lang.String CLSID,
                                 java.lang.String iid,
                                 java.lang.String host,
                                 AuthInfo authInfo)
                          throws java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Description copied from class: Dispatch

Adds a Java object to be a listener for a specific kind of event generated by the COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

addListener in class Dispatch

Parameters:

iidStr - the ID of the outgoing interface, implemented by the listener

theListener - the object to be informed of the events

theSource - the proxy class that represents the COM class that is the source of the events

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Description copied from class: Dispatch

Removes a Java object as a listener to events generated by a COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

removeListener in class Dispatch

Parameters:

iidStr - the ID of the outgoing interface, implemented by the listener

theListener - the object that no longer wishes to be informed of the events

Throws:

java.io.IOException

initialize

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

Description copied from interface: IMaplexOverposter

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

Supported Platforms

Windows

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:

AutomationException - If the ArcObject component throws an exception.

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

getCapabilities

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

Description copied from interface: IMaplexOverposter

Overposter capabilities for the specified layer.

Supported Platforms

Windows

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:

AutomationException - If the ArcObject component throws an exception.

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

getClassCount

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

Description copied from interface: IMaplexOverposter

The number of classes.

Supported Platforms

Windows

Description

The number of labeling classes which have been added to the overposter.

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

Description copied from interface: IMaplexOverposter

Adds a class to the overposter and specifies its properties.

Supported Platforms

Windows

Specified by:

addClass in interface IMaplexOverposter

Parameters:

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

Returns:

The classIndex

Throws:

AutomationException - If the ArcObject component throws an exception.

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

resetClasses

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

Description copied from interface: IMaplexOverposter

Removes all classes from the overposter.

Supported Platforms

Windows

Specified by:

resetClasses in interface IMaplexOverposter

Throws:

AutomationException - If the ArcObject component throws an exception.

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

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

Description copied from interface: IMaplexOverposter

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

Supported Platforms

Windows

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

Description copied from interface: IMaplexOverposter

Adds a barrier object that placed objects must avoid.

Supported Platforms

Windows

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

Description copied from interface: IMaplexOverposter

Adds a symbol to be placed.

Supported Platforms

Windows

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

Description copied from interface: IMaplexOverposter

Places labels using the overposter.

Supported Platforms

Windows

Description

Tells the MaplexOverposter to place the labels.

Specified by:

placeLabels in interface IMaplexOverposter

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getPlacedLabelCount

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

Description copied from interface: IMaplexOverposter

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

Supported Platforms

Windows

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

Description copied from interface: IMaplexOverposter

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

Supported Platforms

Windows

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

Description copied from interface: IMaplexOverposter

Enumeration of placed labels.

Supported Platforms

Windows

Description

Returns an enumeration containing the labels (as MaplexPlacedLabels) for which Maplex has obtained satisfactory positions.

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

Description copied from interface: IMaplexOverposter

Enumeration of unplaced labels.

Supported Platforms

Windows

Description

Returns an enumeration containing the labels (as MaplexPlacedLabels) for which Maplex could not obtain satisfactory positions. The best possible position is given to each label anyway and its PlacementCode is set to esriPlacementUnplaced.

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.