com.esri.arcgis.display
Interface ICallout

All Superinterfaces:
Serializable
All Known Subinterfaces:
IBalloonCallout, ILineCallout, ISimpleLineCallout
All Known Implementing Classes:
BalloonCallout, LineCallout, SimpleLineCallout

public interface ICallout
extends Serializable

Provides access to members that control the callout.

Description

ICallout is the genereric interface for properties common to IBalloonCallout, ILineCallout and ISimpleLineCallout. AnchorPoint is the location of the fixed from point on the leader. LeaderTolerance is the minimum distance the callout must be from the anchor before a leader is drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
ISimpleLineCallout, IBalloonCallout, ICallout, ILineCallout

Method Summary
 IPoint getAnchorPoint()
          The anchor point.
 double getLeaderTolerance()
          The closest distance to the text the anchor point can be for the callout to draw.
 void setAnchorPoint(IPoint point)
          The anchor point.
 void setLeaderTolerance(double leaderTolerance)
          The closest distance to the text the anchor point can be for the callout to draw.
 

Method Detail

getAnchorPoint

IPoint getAnchorPoint()
                      throws IOException,
                             AutomationException
The anchor point.

Description

AnchorPoint is the location from which the leader will be drawn to the callout. This is typically the X,Y coordinates of the feature being labeled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geometry.IPoint
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnchorPoint

void setAnchorPoint(IPoint point)
                    throws IOException,
                           AutomationException
The anchor point.

Description

AnchorPoint is the location from which the leader will be drawn to the callout. This is typically the X,Y coordinates of the feature being labeled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLeaderTolerance

double getLeaderTolerance()
                          throws IOException,
                                 AutomationException
The closest distance to the text the anchor point can be for the callout to draw.

Description

LeaderTolerance is the minimum distance the callout must be from the anchor before a leader is drawn. This distance is specified in points (approx. 1/72 of an inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The leaderTolerance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLeaderTolerance

void setLeaderTolerance(double leaderTolerance)
                        throws IOException,
                               AutomationException
The closest distance to the text the anchor point can be for the callout to draw.

Description

LeaderTolerance is the minimum distance the callout must be from the anchor before a leader is drawn. This distance is specified in points (approx. 1/72 of an inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
leaderTolerance - The leaderTolerance (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.