com.esri.arcgis.carto
Interface IBarrierCollection

All Superinterfaces:

Serializable

All Known Implementing Classes:

BarrierCollection

public interface IBarrierCollection
extends Serializable

Provides access to members that control a collection of objects that act as barriers to label placement.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

void	add(IGeometryCollection barriers, int weight) Adds the specified item to the collection.
void	clear() Removes all the items in the collection.
int	getCount() The number of items in the collection.
void	queryItem(int index, IGeometryCollection[] barrier, int[] weight) Returns the item in the collection at the specified index.

Method Detail

add

void add(IGeometryCollection barriers,
         int weight)
         throws IOException,
                AutomationException

Adds the specified item to the collection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

int getCount()
             throws IOException,
                    AutomationException

The number of items in the collection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryItem

void queryItem(int index,
               IGeometryCollection[] barrier,
               int[] weight)
               throws IOException,
                      AutomationException

Returns the item in the collection at the specified index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

barrier - A reference to a com.esri.arcgis.geometry.IGeometryCollection (out: use single element array)

weight - A com.esri.arcgis.carto.esriBasicOverposterWeight constant (out: use single element array, optional, pass single element of null if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clear

void clear()
           throws IOException,
                  AutomationException

Removes all the items in the collection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.