CIMCompositeCallout (ArcObjects Java API)

java.lang.Object
- com.esri.arcgis.cartox.cim.CIMObject
- - com.esri.arcgis.cartox.cim.CIMCallout
  - - com.esri.arcgis.cartox.cim.CIMCompositeCallout

```
public class CIMCompositeCallout
extends CIMCallout
```
Represents a composite callout. Composite callouts are a filled background along with an optional shadow, which is placed /// behind text. They may also have a leader line (consisting of one or both of a simple line, and filled dart) /// connecting the callout to an anchor point. Composite callouts may have additional surrounding text elements. /// The text representing these parts is specified in the text string using tags. Their relative position properties are /// specified in the CIMCompositeCallout through their corresponding CIMCompositeTextPartPosition elements specified below, /// but these properties can also be overridden with tag attributes.

Constructor Summary

Constructors
Constructor and Description

CIMCompositeCallout()

Constructors
Constructor and Description
`CIMCompositeCallout()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`deserialize(JSONObject jsonObject)` Deserializes this object from its JSON representation.
`static CIMCompositeCallout`	`fromJSON(java.lang.String json)` Creates the object with a specified state from a JSON encoding.
`CIMPolygonSymbol`	`getBackgroundSymbol()` Gets the symbol used to draw the background.
`CIMCompositeTextPartPosition`	`getBottom()` Gets the text part position properties for the bottom part of the callout text.
`CIMCompositeTextPartPosition`	`getBottomLeft()` Gets the text part position properties for the bottom left part of the callout text.
`CIMCompositeTextPartPosition`	`getBottomRight()` Gets the text part position properties for the bottom right part of the callout text.
`double`	`getCornerRadius()` Gets the callout corner radius in points.
`CIMPolygonSymbol`	`getDartSymbol()` Gets a symbol used to draw the dart.
`double`	`getDartWidth()` Gets the dart width.
`CIMCompositeTextPartPosition`	`getFloating()` Gets the text part position properties for the floating part of the callout text.
`double`	`getLeaderLinePercentage()` Gets the percentage of the leader line which is drawn as a line as opposed to a solid dart.
`CIMLineSymbol`	`getLeaderLineSymbol()` Gets the leader line symbol.
`CIMCompositeTextPartPosition`	`getLeft()` Gets the text part position properties for the left part of the callout text.
`CIMTextMargin`	`getMargin()` Gets the text margin defining the space around the text that is accounted for in balloon creation.
`CIMCompositeTextPartPosition`	`getMiddle()` Gets the text part position properties for the middle part of the callout text.
`CIMCompositeTextPartPosition`	`getRight()` Gets the text part position properties for the right part of the callout text.
`CIMPolygonSymbol`	`getShadowSymbol()` Gets the shadow symbol for the callout.
`double`	`getShadowXOffset()` Gets the shadow offset from the callout symbol in the horizontal direction.
`double`	`getShadowYOffset()` Gets the shadow offset from the callout symbol in the vertical direction.
`boolean`	`getSnapLeaderToCornersOnly()` Gets a value indicating whether the leader line should snap only to corners.
`CIMCompositeTextPartPosition`	`getTop()` Gets the text part position properties for the top part of the callout text.
`CIMCompositeTextPartPosition`	`getTopLeft()` Gets the text part position properties for the top left part of the callout text.
`CIMCompositeTextPartPosition`	`getTopRight()` Gets the text part position properties for the top right part of the callout text.
`void`	`serialize(JSONObject jsonObject)` Serializes this object to its JSON representation.
`void`	`setBackgroundSymbol(CIMPolygonSymbol backgroundSymbol)` Sets the symbol used to draw the background.
`void`	`setBottom(CIMCompositeTextPartPosition bottom)` Sets the text part position properties for the bottom part of the callout text.
`void`	`setBottomLeft(CIMCompositeTextPartPosition bottomLeft)` Sets the text part position properties for the bottom left part of the callout text.
`void`	`setBottomRight(CIMCompositeTextPartPosition bottomRight)` Sets the text part position properties for the bottom right part of the callout text.
`void`	`setCornerRadius(double cornerRadius)` Sets the callout corner radius in points.
`void`	`setDartSymbol(CIMPolygonSymbol dartSymbol)` Sets a symbol used to draw the dart.
`void`	`setDartWidth(double dartWidth)` Sets the dart width.
`void`	`setFloating(CIMCompositeTextPartPosition floating)` Sets the text part position properties for the floating part of the callout text.
`void`	`setLeaderLinePercentage(double leaderLinePercentage)` Sets the percentage of the leader line which is drawn as a line as opposed to a solid dart.
`void`	`setLeaderLineSymbol(CIMLineSymbol leaderLineSymbol)` Sets the leader line symbol.
`void`	`setLeft(CIMCompositeTextPartPosition left)` Sets the text part position properties for the left part of the callout text.
`void`	`setMargin(CIMTextMargin margin)` Sets the text margin defining the space around the text that is accounted for in balloon creation.
`void`	`setMiddle(CIMCompositeTextPartPosition middle)` Sets the text part position properties for the middle part of the callout text.
`void`	`setRight(CIMCompositeTextPartPosition right)` Sets the text part position properties for the right part of the callout text.
`void`	`setShadowSymbol(CIMPolygonSymbol shadowSymbol)` Sets the shadow symbol for the callout.
`void`	`setShadowXOffset(double shadowXOffset)` Sets the shadow offset from the callout symbol in the horizontal direction.
`void`	`setShadowYOffset(double shadowYOffset)` Sets the shadow offset from the callout symbol in the vertical direction.
`void`	`setSnapLeaderToCornersOnly(boolean snapLeaderToCornersOnly)` Sets a value indicating whether the leader line should snap only to corners.
`void`	`setTop(CIMCompositeTextPartPosition top)` Sets the text part position properties for the top part of the callout text.
`void`	`setTopLeft(CIMCompositeTextPartPosition topLeft)` Sets the text part position properties for the top left part of the callout text.
`void`	`setTopRight(CIMCompositeTextPartPosition topRight)` Sets the text part position properties for the top right part of the callout text.
`java.lang.String`	`toJSON()` Creates a JSON encoding of the object and its current state.

Methods inherited from class com.esri.arcgis.cartox.cim.CIMCallout
getLeaderOffset, getLeaderTolerance, setLeaderOffset, setLeaderTolerance

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CIMCompositeCallout
```
public CIMCompositeCallout()
```
- Method Detail
  - getCornerRadius
```
public double getCornerRadius()
```
    Gets the callout corner radius in points. /// 0.0 corresponds to a rectangle corner.
  - setCornerRadius
```
public void setCornerRadius(double cornerRadius)
```
    Sets the callout corner radius in points. /// 0.0 corresponds to a rectangle corner.
  - getBackgroundSymbol
```
public CIMPolygonSymbol getBackgroundSymbol()
```
    Gets the symbol used to draw the background.
  - setBackgroundSymbol
```
public void setBackgroundSymbol(CIMPolygonSymbol backgroundSymbol)
```
    Sets the symbol used to draw the background.
  - getMargin
```
public CIMTextMargin getMargin()
```
    Gets the text margin defining the space around the text that is accounted for in balloon creation.
  - setMargin
```
public void setMargin(CIMTextMargin margin)
```
    Sets the text margin defining the space around the text that is accounted for in balloon creation.
  - getDartWidth
```
public double getDartWidth()
```
    Gets the dart width.
  - setDartWidth
```
public void setDartWidth(double dartWidth)
```
    Sets the dart width.
  - getDartSymbol
```
public CIMPolygonSymbol getDartSymbol()
```
    Gets a symbol used to draw the dart. This is only used if LeaderLinePercentage is less than 100%.
  - setDartSymbol
```
public void setDartSymbol(CIMPolygonSymbol dartSymbol)
```
    Sets a symbol used to draw the dart. This is only used if LeaderLinePercentage is less than 100%.
  - getSnapLeaderToCornersOnly
```
public boolean getSnapLeaderToCornersOnly()
```
    Gets a value indicating whether the leader line should snap only to corners.
  - setSnapLeaderToCornersOnly
```
public void setSnapLeaderToCornersOnly(boolean snapLeaderToCornersOnly)
```
    Sets a value indicating whether the leader line should snap only to corners.
  - getLeaderLinePercentage
```
public double getLeaderLinePercentage()
```
    Gets the percentage of the leader line which is drawn as a line as opposed to a solid dart.
  - setLeaderLinePercentage
```
public void setLeaderLinePercentage(double leaderLinePercentage)
```
    Sets the percentage of the leader line which is drawn as a line as opposed to a solid dart.
  - getLeaderLineSymbol
```
public CIMLineSymbol getLeaderLineSymbol()
```
    Gets the leader line symbol. This is only used if LeaderLinePercentage is greater than 0%.
  - setLeaderLineSymbol
```
public void setLeaderLineSymbol(CIMLineSymbol leaderLineSymbol)
```
    Sets the leader line symbol. This is only used if LeaderLinePercentage is greater than 0%.
  - getShadowSymbol
```
public CIMPolygonSymbol getShadowSymbol()
```
    Gets the shadow symbol for the callout.
  - setShadowSymbol
```
public void setShadowSymbol(CIMPolygonSymbol shadowSymbol)
```
    Sets the shadow symbol for the callout.
  - getShadowXOffset
```
public double getShadowXOffset()
```
    Gets the shadow offset from the callout symbol in the horizontal direction. If X and Y are zero, no shadow is drawn.
  - setShadowXOffset
```
public void setShadowXOffset(double shadowXOffset)
```
    Sets the shadow offset from the callout symbol in the horizontal direction. If X and Y are zero, no shadow is drawn.
  - getShadowYOffset
```
public double getShadowYOffset()
```
    Gets the shadow offset from the callout symbol in the vertical direction. If X and Y are zero, no shadow is drawn.
  - setShadowYOffset
```
public void setShadowYOffset(double shadowYOffset)
```
    Sets the shadow offset from the callout symbol in the vertical direction. If X and Y are zero, no shadow is drawn.
  - getMiddle
```
public CIMCompositeTextPartPosition getMiddle()
```
    Gets the text part position properties for the middle part of the callout text. /// This contains the relative positioning information. Split offset and box will have no /// effect on this text part, since it is required that the middle part is in the center /// of the callout.
  - setMiddle
```
public void setMiddle(CIMCompositeTextPartPosition middle)
```
    Sets the text part position properties for the middle part of the callout text. /// This contains the relative positioning information. Split offset and box will have no /// effect on this text part, since it is required that the middle part is in the center /// of the callout.
  - getTopLeft
```
public CIMCompositeTextPartPosition getTopLeft()
```
    Gets the text part position properties for the top left part of the callout text. /// This contains the relative positioning information, as well as split offset indicating /// the extent to which the callout part will mask the callout outline, and whether or not the /// part should be boxed in by the overall callout, or not.
  - setTopLeft
```
public void setTopLeft(CIMCompositeTextPartPosition topLeft)
```
    Sets the text part position properties for the top left part of the callout text. /// This contains the relative positioning information, as well as split offset indicating /// the extent to which the callout part will mask the callout outline, and whether or not the /// part should be boxed in by the overall callout, or not.
  - getTop
```
public CIMCompositeTextPartPosition getTop()
```
    Gets the text part position properties for the top part of the callout text. /// This contains the relative positioning information, as well as split offset indicating /// the extent to which the callout part will mask the callout outline, and whether or not the /// part should be boxed in by the overall callout, or not.
  - setTop
```
public void setTop(CIMCompositeTextPartPosition top)
```
    Sets the text part position properties for the top part of the callout text. /// This contains the relative positioning information, as well as split offset indicating /// the extent to which the callout part will mask the callout outline, and whether or not the /// part should be boxed in by the overall callout, or not.
  - getTopRight
```
public CIMCompositeTextPartPosition getTopRight()
```
    Gets the text part position properties for the top right part of the callout text. /// This contains the relative positioning information, as well as split offset indicating /// the extent to which the callout part will mask the callout outline, and whether or not the /// part should be boxed in by the overall callout, or not.
  - setTopRight
```
public void setTopRight(CIMCompositeTextPartPosition topRight)
```
    Sets the text part position properties for the top right part of the callout text. /// This contains the relative positioning information, as well as split offset indicating /// the extent to which the callout part will mask the callout outline, and whether or not the /// part should be boxed in by the overall callout, or not.
  - getRight
```
public CIMCompositeTextPartPosition getRight()
```
    Gets the text part position properties for the right part of the callout text. /// This contains the relative positioning information, as well as split offset indicating /// the extent to which the callout part will mask the callout outline, and whether or not the /// part should be boxed in by the overall callout, or not.
  - setRight
```
public void setRight(CIMCompositeTextPartPosition right)
```
    Sets the text part position properties for the right part of the callout text. /// This contains the relative positioning information, as well as split offset indicating /// the extent to which the callout part will mask the callout outline, and whether or not the /// part should be boxed in by the overall callout, or not.
  - getLeft
```
public CIMCompositeTextPartPosition getLeft()
```
    Gets the text part position properties for the left part of the callout text. /// This contains the relative positioning information, as well as split offset indicating /// the extent to which the callout part will mask the callout outline, and whether or not the /// part should be boxed in by the overall callout, or not.
  - setLeft
```
public void setLeft(CIMCompositeTextPartPosition left)
```
    Sets the text part position properties for the left part of the callout text. /// This contains the relative positioning information, as well as split offset indicating /// the extent to which the callout part will mask the callout outline, and whether or not the /// part should be boxed in by the overall callout, or not.
  - getBottomLeft
```
public CIMCompositeTextPartPosition getBottomLeft()
```
    Gets the text part position properties for the bottom left part of the callout text. /// This contains the relative positioning information, as well as split offset indicating /// the extent to which the callout part will mask the callout outline, and whether or not the /// part should be boxed in by the overall callout, or not.
  - setBottomLeft
```
public void setBottomLeft(CIMCompositeTextPartPosition bottomLeft)
```
    Sets the text part position properties for the bottom left part of the callout text. /// This contains the relative positioning information, as well as split offset indicating /// the extent to which the callout part will mask the callout outline, and whether or not the /// part should be boxed in by the overall callout, or not.
  - getBottom
```
public CIMCompositeTextPartPosition getBottom()
```
    Gets the text part position properties for the bottom part of the callout text. /// This contains the relative positioning information, as well as split offset indicating /// the extent to which the callout part will mask the callout outline, and whether or not the /// part should be boxed in by the overall callout, or not.
  - setBottom
```
public void setBottom(CIMCompositeTextPartPosition bottom)
```
    Sets the text part position properties for the bottom part of the callout text. /// This contains the relative positioning information, as well as split offset indicating /// the extent to which the callout part will mask the callout outline, and whether or not the /// part should be boxed in by the overall callout, or not.
  - getBottomRight
```
public CIMCompositeTextPartPosition getBottomRight()
```
    Gets the text part position properties for the bottom right part of the callout text. /// This contains the relative positioning information, as well as split offset indicating /// the extent to which the callout part will mask the callout outline, and whether or not the /// part should be boxed in by the overall callout, or not.
  - setBottomRight
```
public void setBottomRight(CIMCompositeTextPartPosition bottomRight)
```
    Sets the text part position properties for the bottom right part of the callout text. /// This contains the relative positioning information, as well as split offset indicating /// the extent to which the callout part will mask the callout outline, and whether or not the /// part should be boxed in by the overall callout, or not.
  - getFloating
```
public CIMCompositeTextPartPosition getFloating()
```
    Gets the text part position properties for the floating part of the callout text. /// This contains the relative positioning information, as well as split offset indicating /// the extent to which the callout part will mask the callout outline, and whether or not the /// part should be boxed in by the overall callout, or not. The floating part is anchored below /// the bottom text part. If there is no bottom text part it is anchored below the middle text part /// plus margins.
  - setFloating
```
public void setFloating(CIMCompositeTextPartPosition floating)
```
    Sets the text part position properties for the floating part of the callout text. /// This contains the relative positioning information, as well as split offset indicating /// the extent to which the callout part will mask the callout outline, and whether or not the /// part should be boxed in by the overall callout, or not. The floating part is anchored below /// the bottom text part. If there is no bottom text part it is anchored below the middle text part /// plus margins.
  - fromJSON
```
public static CIMCompositeCallout fromJSON(java.lang.String json)
                                    throws CIMJSONException
```
    Creates the object with a specified state from a JSON encoding.
    
    Throws:
    
    CIMJSONException
  - toJSON
```
public java.lang.String toJSON()
```
    Creates a JSON encoding of the object and its current state.
    
    Specified by:
    
    toJSON in class CIMObject
  - deserialize
```
public void deserialize(JSONObject jsonObject)
                 throws CIMJSONException
```
    Deserializes this object from its JSON representation.
    
    Overrides:
    
    deserialize in class CIMCallout
    
    Throws:
    
    CIMJSONException
  - serialize
```
public void serialize(JSONObject jsonObject)
```
    Serializes this object to its JSON representation.
    
    Overrides:
    
    serialize in class CIMCallout

Class CIMCompositeCallout

Constructor Summary

Method Summary

Methods inherited from class com.esri.arcgis.cartox.cim.CIMCallout

Methods inherited from class java.lang.Object

Constructor Detail

CIMCompositeCallout

Method Detail

getCornerRadius

setCornerRadius

getBackgroundSymbol

setBackgroundSymbol

getMargin

setMargin

getDartWidth

setDartWidth

getDartSymbol

setDartSymbol

getSnapLeaderToCornersOnly

setSnapLeaderToCornersOnly

getLeaderLinePercentage

setLeaderLinePercentage

getLeaderLineSymbol

setLeaderLineSymbol

getShadowSymbol

setShadowSymbol

getShadowXOffset

setShadowXOffset

getShadowYOffset

setShadowYOffset

getMiddle

setMiddle

getTopLeft

setTopLeft

getTop

setTop

getTopRight

setTopRight

getRight

setRight

getLeft

setLeft

getBottomLeft

setBottomLeft

getBottom

setBottom

getBottomRight

setBottomRight

getFloating

setFloating

fromJSON

toJSON

deserialize

serialize