com.esri.arcgis.carto
Interface IBarrierProperties2

All Superinterfaces:

Serializable

All Known Implementing Classes:

CadAnnotationLayer, ChartRenderer, ClassBreaksRenderer, CompositeGraphicsLayer, CoverageAnnotationLayer, DimensionLayer, FDOGraphicsLayer, GraphicsSubLayer, IBarrierProperties2Proxy, ProportionalSymbolRenderer

public interface IBarrierProperties2
extends Serializable

Provides access to members that control how objects (text, features, graphics) act as barriers for labelling with the cancel tracker.

Product Availability

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

Method Summary

int	getWeight() Weight of the barriers for this layer.
void	queryBarriers(IDisplay display, IGeometryCollection pBarriers, IEnvelope extent, ITrackCancel trackCancel) List of barriers within the specified extent, or all barriers if no extent given.
void	setWeight(int weight) Weight of the barriers for this layer.

Method Detail

getWeight

int getWeight()
              throws IOException,
                     AutomationException

Weight of the barriers for this layer.

Description

A Long value corresponding to a weight in esriBasicOverposterWeight.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The weight

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWeight

void setWeight(int weight)
               throws IOException,
                      AutomationException

Weight of the barriers for this layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

weight - The weight (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryBarriers

void queryBarriers(IDisplay display,
                   IGeometryCollection pBarriers,
                   IEnvelope extent,
                   ITrackCancel trackCancel)
                   throws IOException,
                          AutomationException

List of barriers within the specified extent, or all barriers if no extent given.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

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

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

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.