|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface ILineCallout
Provides access to members that control the line callout.
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.
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.
| 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 |
|---|
IFillSymbol getBorder()
throws IOException,
AutomationException
Border is the fill symbol used as the background for the text. Any fill supported by the IFillSymbol object can be used.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setBorderByRef(IFillSymbol border)
throws IOException,
AutomationException
Border is the fill symbol used as the background for the text. Any fill supported by the IFillSymbol object can be used.
border - A reference to a com.esri.arcgis.display.IFillSymbol (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
double getGap()
throws IOException,
AutomationException
Gap is the distance between the Border and the AccentBar. The Gap is specified in points (approx. 1/72 of an inch).
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setGap(double gap)
throws IOException,
AutomationException
Gap is the distance between the Border and the AccentBar. The Gap is specified in points (approx. 1/72 of an inch).
gap - The gap (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
ILineSymbol getAccentBar()
throws IOException,
AutomationException
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.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setAccentBarByRef(ILineSymbol accentBar)
throws IOException,
AutomationException
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.
accentBar - A reference to a com.esri.arcgis.display.ILineSymbol (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
int getStyle()
throws IOException,
AutomationException
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.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setStyle(int style)
throws IOException,
AutomationException
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.
style - A com.esri.arcgis.display.esriLineCalloutStyle constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
ILineSymbol getLeaderLine()
throws IOException,
AutomationException
LeaderLine is the line that connects the text to the anchor point. Any line supported by the ILineSymbol object can be used.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setLeaderLineByRef(ILineSymbol leaderLine)
throws IOException,
AutomationException
LeaderLine is the line that connects the text to the anchor point. Any line supported by the ILineSymbol object can be used.
leaderLine - A reference to a com.esri.arcgis.display.ILineSymbol (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||