com.esri.arcgis.display
Interface IBalloonCallout

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

public interface IBalloonCallout
extends ICallout, Serializable

Provides access to members that control the balloon callout.

Description

BalloonCallouts are a filled background that is placed behind text. Use the Style property to select from three different shapes for the balloon. Use the Symbol property to specify the fill symbol used as the background. Use the ICallout and the ITextMargins interfaces to set additional properties for IBalloonCallouts.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
ISimpleLineCallout, IBalloonCallout, ICallout, ILineCallout

Method Summary
 int getStyle()
          The balloon callout style.
 IFillSymbol getSymbol()
          The fill symbol.
 void setStyle(int style)
          The balloon callout style.
 void setSymbolByRef(IFillSymbol fillSym)
          The fill symbol.
 
Methods inherited from interface com.esri.arcgis.display.ICallout
getAnchorPoint, getLeaderTolerance, setAnchorPoint, setLeaderTolerance
 

Method Detail

getStyle

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

Description

Style is the enumeration that controls the shape of the balloon. The avaialble options include: esriBCSOval, esriBCSRectangle and esriBCSRoundedRectangle. esriBCSRectangle is the default Style.

Remarks

This property describes the drawing style of BalloonCallout, whether is has rounded or square corners etc., esriBCSOval is not currently implemented.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.display.esriBalloonCalloutStyle 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 balloon callout style.

Description

Style is the enumeration that controls the shape of the balloon. The avaialble options include: esriBCSOval, esriBCSRectangle and esriBCSRoundedRectangle. esriBCSRectangle is the default Style.

Remarks

This property describes the drawing style of BalloonCallout, whether is has rounded or square corners etc., esriBCSOval is not currently implemented.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getSymbol

IFillSymbol getSymbol()
                      throws IOException,
                             AutomationException
The fill symbol.

Description

Symbol is the fill symbol used as the background within the balloon. 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.

setSymbolByRef

void setSymbolByRef(IFillSymbol fillSym)
                    throws IOException,
                           AutomationException
The fill symbol.

Description

Symbol is the fill symbol used as the background within the balloon. 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:
fillSym - 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.