com.esri.arcgis.display
Interface ISimpleLineCallout

All Superinterfaces:

ICallout, Serializable

All Known Implementing Classes:

SimpleLineCallout

public interface ISimpleLineCallout
extends ICallout, Serializable

Provides access to members that control the Simple Line Callout.

Description

SimpleLineCallout can be used to display a callout comprised of a single leader line drawn from the anchor point to the text. Use the ICallout interface to set additional properties for the ISimpleLineCallout.

Product Availability

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

Method Summary

IGeometry	getLineGeometry() The geometry used for the Callout.
ILineSymbol	getLineSymbol() The line symbol used for the Callout.
boolean	isAutoSnap() Indicates if the auto-snap property is enabled.
void	setAutoSnap(boolean flag) Indicates if the auto-snap property is enabled.
void	setLineGeometry(IGeometry geometry) The geometry used for the Callout.
void	setLineSymbol(ILineSymbol lineSymbol) The line symbol used for the Callout.

Methods inherited from interface com.esri.arcgis.display.ICallout

getAnchorPoint, getLeaderTolerance, setAnchorPoint, setLeaderTolerance

Method Detail

getLineGeometry

IGeometry getLineGeometry()
                          throws IOException,
                                 AutomationException

The geometry used for the Callout.

Description

LineGeometry is the geometry that controls the actual shape of the leader. Use the IPolyLine object to create the coordinate spcifications for the leader.

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.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLineGeometry

void setLineGeometry(IGeometry geometry)
                     throws IOException,
                            AutomationException

The geometry used for the Callout.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLineSymbol

ILineSymbol getLineSymbol()
                          throws IOException,
                                 AutomationException

The line symbol used for the Callout.

Description

LineSymbol is the symbol used as the leader line for SimpleLineCallout. Any ILineSymbol object can be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.display.ILineSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLineSymbol

void setLineSymbol(ILineSymbol lineSymbol)
                   throws IOException,
                          AutomationException

The line symbol used for the Callout.

Description

LineSymbol is the symbol used as the leader line for SimpleLineCallout. Any ILineSymbol object can be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAutoSnap

boolean isAutoSnap()
                   throws IOException,
                          AutomationException

Indicates if the auto-snap property is enabled.

Description

AutoSnap is a boolean indicator that specifies if the leader will be snapped the the closest horizontal and vertical alignment zones of the text. The default AutoSnap is True.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoSnap

void setAutoSnap(boolean flag)
                 throws IOException,
                        AutomationException

Indicates if the auto-snap property is enabled.

Description

AutoSnap is a boolean indicator that specifies if the leader will be snapped the the closest horizontal and vertical alignment zones of the text. The default AutoSnap is True.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.