com.esri.arcgis.display
Interface ILineCallout

All Superinterfaces:
ICallout, Serializable
All Known Implementing Classes:
LineCallout

public interface ILineCallout
extends ICallout, Serializable

Provides access to members that control the line callout.

Description

LineCallouts provide a filled background for text that can be linked, by a line, to an anchor point at a specified tolerance. The symbols used for the LeaderLine, Border and AccentBar can be changed to suit the needs of the specific application. Use the Style property to select from several different shapes and positioning of the LeaderLine. Use the ICallout and the ITextMargins interfaces to set additional properties for ILineCallouts.

Remarks

The LeaderLine property sets the symbol used to draw the leader line and can be set to any LineSymbol object. Similarly you can change the appearance of the accent bar by setting the AccentBar property.

The spacing between the Border and the AccentBar can be adjusted by setting the Gap property. This property indicates the separation between the center of the AccentBar and the edge of the Border as a distance in points and does not account for think outlines on either the AccentBar or Border.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 ILineSymbol getAccentBar()
          The line symbol used to render the accent bar.
 IFillSymbol getBorder()
          The fill symbol used to render the border.
 double getGap()
          The gap.
 ILineSymbol getLeaderLine()
          The line symbol used to render the leader line.
 int getStyle()
          The line callout style.
 void setAccentBarByRef(ILineSymbol accentBar)
          The line symbol used to render the accent bar.
 void setBorderByRef(IFillSymbol border)
          The fill symbol used to render the border.
 void setGap(double gap)
          The gap.
 void setLeaderLineByRef(ILineSymbol leaderLine)
          The line symbol used to render the leader line.
 void setStyle(int style)
          The line callout style.
 
Methods inherited from interface com.esri.arcgis.display.ICallout
getAnchorPoint, getLeaderTolerance, setAnchorPoint, setLeaderTolerance
 

Method Detail

getBorder

IFillSymbol getBorder()
                      throws IOException,
                             AutomationException
The fill symbol used to render the border.

Description

Border is the fill symbol used as the background for the text. Any fill supported by the IFillSymbol 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.IFillSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBorderByRef

void setBorderByRef(IFillSymbol border)
                    throws IOException,
                           AutomationException
The fill symbol used to render the border.

Description

Border is the fill symbol used as the background for the text. Any fill supported by the IFillSymbol object can be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getGap

double getGap()
              throws IOException,
                     AutomationException
The gap.

Description

Gap is the distance between the Border and the AccentBar. The Gap 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 gap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGap

void setGap(double gap)
            throws IOException,
                   AutomationException
The gap.

Description

Gap is the distance between the Border and the AccentBar. The Gap 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:
gap - The gap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAccentBar

ILineSymbol getAccentBar()
                         throws IOException,
                                AutomationException
The line symbol used to render the accent bar.

Description

AccentBar is a vertical line placed at either the right or left edge of the Border. Any line supported by the 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.

setAccentBarByRef

void setAccentBarByRef(ILineSymbol accentBar)
                       throws IOException,
                              AutomationException
The line symbol used to render the accent bar.

Description

AccentBar is a vertical line placed at either the right or left edge of the Border. Any line supported by the ILineSymbol object can be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
accentBar - 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.

getStyle

int getStyle()
             throws IOException,
                    AutomationException
The line callout style.

Description

Style is the enumeration that controls the shape of the LeaderLine as well as the positioning of the AccentBar. The avaialble options include: esriLCSBase, esriLCSCircularCCW, esriLCSCircularCW, esriLCSCustom, esriLCSFourPoint, esriLCSMidpoint, esriLCSThreePoint and esriLCSUnderline. esriLCSMidpoint is the default Style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.display.esriLineCalloutStyle constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStyle

void setStyle(int style)
              throws IOException,
                     AutomationException
The line callout style.

Description

Style is the enumeration that controls the shape of the LeaderLine as well as the positioning of the AccentBar. The avaialble options include: esriLCSBase, esriLCSCircularCCW, esriLCSCircularCW, esriLCSCustom, esriLCSFourPoint, esriLCSMidpoint, esriLCSThreePoint and esriLCSUnderline. esriLCSMidpoint is the default Style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
style - A com.esri.arcgis.display.esriLineCalloutStyle constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLeaderLine

ILineSymbol getLeaderLine()
                          throws IOException,
                                 AutomationException
The line symbol used to render the leader line.

Description

LeaderLine is the line that connects the text to the anchor point. Any line supported by the 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.

setLeaderLineByRef

void setLeaderLineByRef(ILineSymbol leaderLine)
                        throws IOException,
                               AutomationException
The line symbol used to render the leader line.

Description

LeaderLine is the line that connects the text to the anchor point. Any line supported by the ILineSymbol object can be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
leaderLine - 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.