CIMTextSymbol (ArcObjects Java API)

java.lang.Object
- com.esri.arcgis.cartox.cim.CIMObject
- - com.esri.arcgis.cartox.cim.CIMSymbol
  - - com.esri.arcgis.cartox.cim.CIMTextSymbol

```
public class CIMTextSymbol
extends CIMSymbol
```
Represents a text symbol which is used to draw text graphics, bleeds, and annotation. Text symbols do not contain any symbol layers but can have callouts.

Constructor Summary

Constructors
Constructor and Description

CIMTextSymbol()

Constructors
Constructor and Description
`CIMTextSymbol()`

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 CIMTextSymbol`	`fromJSON(java.lang.String json)` Creates the object with a specified state from a JSON encoding.
`double`	`getAngle()` Gets the amount of rotation applied to the text symbol, measured in degrees, around the geometry.
`double`	`getAngleX()` Gets the amount of rotation of the text symbol around the X axis, measured in degrees, around the geometry.
`double`	`getAngleY()` Gets the amount of rotation of the text symbol around the Y axis, measured in degrees, around the geometry.
`BillboardMode`	`getBillboardMode3D()` Gets the billboard mode of the text symbol.
`BlockProgression`	`getBlockProgression()` Gets the direction in which multi-line text is stacked.
`CIMCallout`	`getCallout()` Gets the callout or background of the text with optional leader lines.
`boolean`	`getCompatibilityMode()` Gets a value indicating whether to draw the text in a fashion compatible with ArcMap.
`java.lang.String`	`getCountryISO()` Gets the ISO code for the base country of the text.
`double`	`getDepth3D()` Gets the depth of the glyph when drawn in 3D.
`boolean`	`getDrawGlyphsAsGeometry()` Gets a value indicating whether fonts that are drawn as rasters at some scales to draw as vectors instead.
`boolean`	`getDrawSoftHyphen()` Gets a value indicating whether soft hyphens should be drawn.
`boolean`	`getExtrapolateBaselines()` Gets a value indicating whether the baseline of the text geometry should be expanded in the same manner as the existing geometry if the text extends beyond the baseline.
`double`	`getFlipAngle()` Gets the angle (in degrees from vertical) at which point rotated text is flipped (mirrored) in place.
`FontEffects`	`getFontEffects()` Gets whether the text is drawn as subscript or superscript.
`FontEncoding`	`getFontEncoding()` Gets the font encoding.
`java.lang.String`	`getFontFamilyName()` Gets the font family name of the font.
`java.lang.String`	`getFontStyleName()` Gets the style name for the font family.
`FontType`	`getFontType()` Gets the type of font that the font family/style name reference.
`CIMFontVariation[]`	`getFontVariationSettings()` Gets an array of CIM font variation objects, describing a particular instance of a variable font through the font axis tags and their values.
`double`	`getGlyphRotation()` Gets an additional rotation that is applied to the individual glyphs contained in the text.
`double`	`getHaloSize()` Gets the size of the halo that extends beyond the symbol shape.
`CIMPolygonSymbol`	`getHaloSymbol()` Gets the polygon symbol that is used to draw the halo for a text symbol.
`double`	`getHeight()` Gets the size of the text in points.
`GlyphHinting`	`getHinting()` Gets if hinting from the font is used for text rendering.
`HorizontalAlignment`	`getHorizontalAlignment()` Gets the alignment type used to align the text to the geometry horizontally.
`double`	`getIndentAfter()` Gets how many points to indent the text back from the end of the baseline.
`double`	`getIndentBefore()` Gets how many points to indent the text from the beginning of the baseline.
`double`	`getIndentFirstLine()` Gets how many points to indent the text from the beginning of the baseline for the first line only.
`boolean`	`getKerning()` Gets a value indicating whether the text is drawn with metric kerning, which adjusts the spacing between individual letter forms.
`java.lang.String`	`getLanguageISO()` Gets whether the ISO code for the base language of the text.
`double`	`getLetterSpacing()` Gets the additional spacing that is added to each glyph beyond what is defined by its character box in the font.
`double`	`getLetterWidth()` Gets the width that is added to each glyph beyond what is defined by its character box in its font.
`boolean`	`getLigatures()` Gets a value indicating whether text is to be drawn with ligatures, which occur when two or more letters or portions of letters are joined to form a single glyph.
`double`	`getLineGap()` Gets the spacing between lines of text.
`LineGapType`	`getLineGapType()` Gets the type of line gap that is applied.
`double`	`getOffsetX()` Gets the X offset.
`double`	`getOffsetY()` Gets the Y offset.
`double`	`getOffsetZ()` Gets the Z offset.
`boolean`	`getOverprint()` Gets a value indicating whether or not the symbol should overprint in press printing.
`CIMColor`	`getShadowColor()` Gets the color of the shadow that is defined for the text symbol.
`double`	`getShadowOffsetX()` Gets the shadow offset from the text symbol in the horizontal direction.
`double`	`getShadowOffsetY()` Gets the shadow offset from the text symbol in the vertical direction.
`boolean`	`getSmallCaps()` Gets a value indicating whether the text should be drawn as Small Capitals, where lower case text is converted to small caps and upper case text is left as upper case.
`boolean`	`getStrikethrough()` Gets a value indicating whether to draw the text with a strike through it.
`CIMPolygonSymbol`	`getSymbol()` Gets the polygon symbol that is used to draw the glyphs of the text.
`CIM3DSymbolProperties`	`getSymbol3DProperties()` Gets the collection of properties that are applied to the text symbol only in a 3D context.
`TextCase`	`getTextCase()` Gets the letter case used to draw the text.
`TextReadingDirection`	`getTextDirection()` Gets the base text direction to draw the text.
`boolean`	`getUnderline()` Gets a value indicating whether to draw the text with an underline.
`VerticalAlignment`	`getVerticalAlignment()` Gets the vertical alignment of the text.
`VerticalGlyphOrientation`	`getVerticalGlyphOrientation()` Gets the orientation for the non-vertical text in a vertical layout.
`double`	`getWordSpacing()` Gets the additional spacing that is added to between the words of the text string.
`void`	`serialize(JSONObject jsonObject)` Serializes this object to its JSON representation.
`void`	`setAngle(double angle)` Sets the amount of rotation applied to the text symbol, measured in degrees, around the geometry.
`void`	`setAngleX(double angleX)` Sets the amount of rotation of the text symbol around the X axis, measured in degrees, around the geometry.
`void`	`setAngleY(double angleY)` Sets the amount of rotation of the text symbol around the Y axis, measured in degrees, around the geometry.
`void`	`setBillboardMode3D(BillboardMode billboardMode3D)` Sets the billboard mode of the text symbol.
`void`	`setBlockProgression(BlockProgression blockProgression)` Sets the direction in which multi-line text is stacked.
`void`	`setCallout(CIMCallout callout)` Sets the callout or background of the text with optional leader lines.
`void`	`setCompatibilityMode(boolean compatibilityMode)` Sets a value indicating whether to draw the text in a fashion compatible with ArcMap.
`void`	`setCountryISO(java.lang.String countryISO)` Sets the ISO code for the base country of the text.
`void`	`setDepth3D(double depth3D)` Sets the depth of the glyph when drawn in 3D.
`void`	`setDrawGlyphsAsGeometry(boolean drawGlyphsAsGeometry)` Sets a value indicating whether fonts that are drawn as rasters at some scales to draw as vectors instead.
`void`	`setDrawSoftHyphen(boolean drawSoftHyphen)` Sets a value indicating whether soft hyphens should be drawn.
`void`	`setExtrapolateBaselines(boolean extrapolateBaselines)` Sets a value indicating whether the baseline of the text geometry should be expanded in the same manner as the existing geometry if the text extends beyond the baseline.
`void`	`setFlipAngle(double flipAngle)` Sets the angle (in degrees from vertical) at which point rotated text is flipped (mirrored) in place.
`void`	`setFontEffects(FontEffects fontEffects)` Sets whether the text is drawn as subscript or superscript.
`void`	`setFontEncoding(FontEncoding fontEncoding)` Sets the font encoding.
`void`	`setFontFamilyName(java.lang.String fontFamilyName)` Sets the font family name of the font.
`void`	`setFontStyleName(java.lang.String fontStyleName)` Sets the style name for the font family.
`void`	`setFontType(FontType fontType)` Sets the type of font that the font family/style name reference.
`void`	`setFontVariationSettings(CIMFontVariation[] fontVariationSettings)` Sets an array of CIM font variation objects, describing a particular instance of a variable font through the font axis tags and their values.
`void`	`setGlyphRotation(double glyphRotation)` Sets an additional rotation that is applied to the individual glyphs contained in the text.
`void`	`setHaloSize(double haloSize)` Sets the size of the halo that extends beyond the symbol shape.
`void`	`setHaloSymbol(CIMPolygonSymbol haloSymbol)` Sets the polygon symbol that is used to draw the halo for a text symbol.
`void`	`setHeight(double height)` Sets the size of the text in points.
`void`	`setHinting(GlyphHinting hinting)` Sets if hinting from the font is used for text rendering.
`void`	`setHorizontalAlignment(HorizontalAlignment horizontalAlignment)` Sets the alignment type used to align the text to the geometry horizontally.
`void`	`setIndentAfter(double indentAfter)` Sets how many points to indent the text back from the end of the baseline.
`void`	`setIndentBefore(double indentBefore)` Sets how many points to indent the text from the beginning of the baseline.
`void`	`setIndentFirstLine(double indentFirstLine)` Sets how many points to indent the text from the beginning of the baseline for the first line only.
`void`	`setKerning(boolean kerning)` Sets a value indicating whether the text is drawn with metric kerning, which adjusts the spacing between individual letter forms.
`void`	`setLanguageISO(java.lang.String languageISO)` Sets whether the ISO code for the base language of the text.
`void`	`setLetterSpacing(double letterSpacing)` Sets the additional spacing that is added to each glyph beyond what is defined by its character box in the font.
`void`	`setLetterWidth(double letterWidth)` Sets the width that is added to each glyph beyond what is defined by its character box in its font.
`void`	`setLigatures(boolean ligatures)` Sets a value indicating whether text is to be drawn with ligatures, which occur when two or more letters or portions of letters are joined to form a single glyph.
`void`	`setLineGap(double lineGap)` Sets the spacing between lines of text.
`void`	`setLineGapType(LineGapType lineGapType)` Sets the type of line gap that is applied.
`void`	`setOffsetX(double offsetX)` Sets the X offset.
`void`	`setOffsetY(double offsetY)` Sets the Y offset.
`void`	`setOffsetZ(double offsetZ)` Sets the Z offset.
`void`	`setOverprint(boolean overprint)` Sets a value indicating whether or not the symbol should overprint in press printing.
`void`	`setShadowColor(CIMColor shadowColor)` Sets the color of the shadow that is defined for the text symbol.
`void`	`setShadowOffsetX(double shadowOffsetX)` Sets the shadow offset from the text symbol in the horizontal direction.
`void`	`setShadowOffsetY(double shadowOffsetY)` Sets the shadow offset from the text symbol in the vertical direction.
`void`	`setSmallCaps(boolean smallCaps)` Sets a value indicating whether the text should be drawn as Small Capitals, where lower case text is converted to small caps and upper case text is left as upper case.
`void`	`setStrikethrough(boolean strikethrough)` Sets a value indicating whether to draw the text with a strike through it.
`void`	`setSymbol(CIMPolygonSymbol symbol)` Sets the polygon symbol that is used to draw the glyphs of the text.
`void`	`setSymbol3DProperties(CIM3DSymbolProperties symbol3DProperties)` Sets the collection of properties that are applied to the text symbol only in a 3D context.
`void`	`setTextCase(TextCase textCase)` Sets the letter case used to draw the text.
`void`	`setTextDirection(TextReadingDirection textDirection)` Sets the base text direction to draw the text.
`void`	`setUnderline(boolean underline)` Sets a value indicating whether to draw the text with an underline.
`void`	`setVerticalAlignment(VerticalAlignment verticalAlignment)` Sets the vertical alignment of the text.
`void`	`setVerticalGlyphOrientation(VerticalGlyphOrientation verticalGlyphOrientation)` Sets the orientation for the non-vertical text in a vertical layout.
`void`	`setWordSpacing(double wordSpacing)` Sets the additional spacing that is added to between the words of the text string.
`java.lang.String`	`toJSON()` Creates a JSON encoding of the object and its current state.

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

- Constructor Detail
  - CIMTextSymbol
```
public CIMTextSymbol()
```
- Method Detail
  - getAngle
```
public double getAngle()
```
    Gets the amount of rotation applied to the text symbol, measured in degrees, around the geometry.
  - setAngle
```
public void setAngle(double angle)
```
    Sets the amount of rotation applied to the text symbol, measured in degrees, around the geometry.
  - getAngleX
```
public double getAngleX()
```
    Gets the amount of rotation of the text symbol around the X axis, measured in degrees, around the geometry. This type of rotation is also referred to as tilt. It is applied in 3D.
  - setAngleX
```
public void setAngleX(double angleX)
```
    Sets the amount of rotation of the text symbol around the X axis, measured in degrees, around the geometry. This type of rotation is also referred to as tilt. It is applied in 3D.
  - getAngleY
```
public double getAngleY()
```
    Gets the amount of rotation of the text symbol around the Y axis, measured in degrees, around the geometry. This type of rotation is also referred to as roll. It is applied in 3D.
  - setAngleY
```
public void setAngleY(double angleY)
```
    Sets the amount of rotation of the text symbol around the Y axis, measured in degrees, around the geometry. This type of rotation is also referred to as roll. It is applied in 3D.
  - getBlockProgression
```
public BlockProgression getBlockProgression()
```
    Gets the direction in which multi-line text is stacked.
  - setBlockProgression
```
public void setBlockProgression(BlockProgression blockProgression)
```
    Sets the direction in which multi-line text is stacked.
  - getCallout
```
public CIMCallout getCallout()
```
    Gets the callout or background of the text with optional leader lines.
  - setCallout
```
public void setCallout(CIMCallout callout)
```
    Sets the callout or background of the text with optional leader lines.
  - getCompatibilityMode
```
public boolean getCompatibilityMode()
```
    Gets a value indicating whether to draw the text in a fashion compatible with ArcMap.
  - setCompatibilityMode
```
public void setCompatibilityMode(boolean compatibilityMode)
```
    Sets a value indicating whether to draw the text in a fashion compatible with ArcMap.
  - getCountryISO
```
public java.lang.String getCountryISO()
```
    Gets the ISO code for the base country of the text.
  - setCountryISO
```
public void setCountryISO(java.lang.String countryISO)
```
    Sets the ISO code for the base country of the text.
  - getDepth3D
```
public double getDepth3D()
```
    Gets the depth of the glyph when drawn in 3D. This is an extrusion of the characters of the text in the Z axis.
  - setDepth3D
```
public void setDepth3D(double depth3D)
```
    Sets the depth of the glyph when drawn in 3D. This is an extrusion of the characters of the text in the Z axis.
  - getDrawGlyphsAsGeometry
```
public boolean getDrawGlyphsAsGeometry()
```
    Gets a value indicating whether fonts that are drawn as rasters at some scales to draw as vectors instead.
  - setDrawGlyphsAsGeometry
```
public void setDrawGlyphsAsGeometry(boolean drawGlyphsAsGeometry)
```
    Sets a value indicating whether fonts that are drawn as rasters at some scales to draw as vectors instead.
  - getDrawSoftHyphen
```
public boolean getDrawSoftHyphen()
```
    Gets a value indicating whether soft hyphens should be drawn. Soft hyphens are invisible markers that indicate where a hyphenated break is allowed within the text. They are only drawn if there is word wrapping at the end of a line.
  - setDrawSoftHyphen
```
public void setDrawSoftHyphen(boolean drawSoftHyphen)
```
    Sets a value indicating whether soft hyphens should be drawn. Soft hyphens are invisible markers that indicate where a hyphenated break is allowed within the text. They are only drawn if there is word wrapping at the end of a line.
  - getExtrapolateBaselines
```
public boolean getExtrapolateBaselines()
```
    Gets a value indicating whether the baseline of the text geometry should be expanded in the same manner as the existing geometry if the text extends beyond the baseline.
  - setExtrapolateBaselines
```
public void setExtrapolateBaselines(boolean extrapolateBaselines)
```
    Sets a value indicating whether the baseline of the text geometry should be expanded in the same manner as the existing geometry if the text extends beyond the baseline.
  - getFlipAngle
```
public double getFlipAngle()
```
    Gets the angle (in degrees from vertical) at which point rotated text is flipped (mirrored) in place.
  - setFlipAngle
```
public void setFlipAngle(double flipAngle)
```
    Sets the angle (in degrees from vertical) at which point rotated text is flipped (mirrored) in place.
  - getFontEffects
```
public FontEffects getFontEffects()
```
    Gets whether the text is drawn as subscript or superscript.
  - setFontEffects
```
public void setFontEffects(FontEffects fontEffects)
```
    Sets whether the text is drawn as subscript or superscript.
  - getFontEncoding
```
public FontEncoding getFontEncoding()
```
    Gets the font encoding.
  - setFontEncoding
```
public void setFontEncoding(FontEncoding fontEncoding)
```
    Sets the font encoding.
  - getFontFamilyName
```
public java.lang.String getFontFamilyName()
```
    Gets the font family name of the font. e.g. Comic Sans.
  - setFontFamilyName
```
public void setFontFamilyName(java.lang.String fontFamilyName)
```
    Sets the font family name of the font. e.g. Comic Sans.
  - getFontStyleName
```
public java.lang.String getFontStyleName()
```
    Gets the style name for the font family. e.g. Regular, Bold, or Italic.
  - setFontStyleName
```
public void setFontStyleName(java.lang.String fontStyleName)
```
    Sets the style name for the font family. e.g. Regular, Bold, or Italic.
  - getFontType
```
public FontType getFontType()
```
    Gets the type of font that the font family/style name reference.
  - setFontType
```
public void setFontType(FontType fontType)
```
    Sets the type of font that the font family/style name reference.
  - getFontVariationSettings
```
public CIMFontVariation[] getFontVariationSettings()
```
    Gets an array of CIM font variation objects, describing a particular instance of a variable font through the font axis tags and their values. The number of CIM font variations will correspond to the number of variation axes specified by the font. This is only used for variable fonts.
  - setFontVariationSettings
```
public void setFontVariationSettings(CIMFontVariation[] fontVariationSettings)
```
    Sets an array of CIM font variation objects, describing a particular instance of a variable font through the font axis tags and their values. The number of CIM font variations will correspond to the number of variation axes specified by the font. This is only used for variable fonts.
  - getGlyphRotation
```
public double getGlyphRotation()
```
    Gets an additional rotation that is applied to the individual glyphs contained in the text. This is applied to the individual glyphs whereas Angle, AngleX and AngleY are affect how the entire text string is oriented.
  - setGlyphRotation
```
public void setGlyphRotation(double glyphRotation)
```
    Sets an additional rotation that is applied to the individual glyphs contained in the text. This is applied to the individual glyphs whereas Angle, AngleX and AngleY are affect how the entire text string is oriented.
  - getHaloSize
```
public double getHaloSize()
```
    Gets the size of the halo that extends beyond the symbol shape.
  - setHaloSize
```
public void setHaloSize(double haloSize)
```
    Sets the size of the halo that extends beyond the symbol shape.
  - getHaloSymbol
```
public CIMPolygonSymbol getHaloSymbol()
```
    Gets the polygon symbol that is used to draw the halo for a text symbol.
  - setHaloSymbol
```
public void setHaloSymbol(CIMPolygonSymbol haloSymbol)
```
    Sets the polygon symbol that is used to draw the halo for a text symbol.
  - getHeight
```
public double getHeight()
```
    Gets the size of the text in points.
  - setHeight
```
public void setHeight(double height)
```
    Sets the size of the text in points.
  - getHinting
```
public GlyphHinting getHinting()
```
    Gets if hinting from the font is used for text rendering. Hinting is information included with most fonts to effectively fit the vector glyphs of the font into the raster grid onto which they are displayed.
  - setHinting
```
public void setHinting(GlyphHinting hinting)
```
    Sets if hinting from the font is used for text rendering. Hinting is information included with most fonts to effectively fit the vector glyphs of the font into the raster grid onto which they are displayed.
  - getHorizontalAlignment
```
public HorizontalAlignment getHorizontalAlignment()
```
    Gets the alignment type used to align the text to the geometry horizontally. Affects which side of a point geometry the point text is drawn or which end of a line it is drawn close to. Commonly used to define how stacked text appears.
  - setHorizontalAlignment
```
public void setHorizontalAlignment(HorizontalAlignment horizontalAlignment)
```
    Sets the alignment type used to align the text to the geometry horizontally. Affects which side of a point geometry the point text is drawn or which end of a line it is drawn close to. Commonly used to define how stacked text appears.
  - getIndentAfter
```
public double getIndentAfter()
```
    Gets how many points to indent the text back from the end of the baseline.
  - setIndentAfter
```
public void setIndentAfter(double indentAfter)
```
    Sets how many points to indent the text back from the end of the baseline.
  - getIndentBefore
```
public double getIndentBefore()
```
    Gets how many points to indent the text from the beginning of the baseline.
  - setIndentBefore
```
public void setIndentBefore(double indentBefore)
```
    Sets how many points to indent the text from the beginning of the baseline.
  - getIndentFirstLine
```
public double getIndentFirstLine()
```
    Gets how many points to indent the text from the beginning of the baseline for the first line only.
  - setIndentFirstLine
```
public void setIndentFirstLine(double indentFirstLine)
```
    Sets how many points to indent the text from the beginning of the baseline for the first line only.
  - getKerning
```
public boolean getKerning()
```
    Gets a value indicating whether the text is drawn with metric kerning, which adjusts the spacing between individual letter forms.
  - setKerning
```
public void setKerning(boolean kerning)
```
    Sets a value indicating whether the text is drawn with metric kerning, which adjusts the spacing between individual letter forms.
  - getLanguageISO
```
public java.lang.String getLanguageISO()
```
    Gets whether the ISO code for the base language of the text.
  - setLanguageISO
```
public void setLanguageISO(java.lang.String languageISO)
```
    Sets whether the ISO code for the base language of the text.
  - getLetterSpacing
```
public double getLetterSpacing()
```
    Gets the additional spacing that is added to each glyph beyond what is defined by its character box in the font. Value indicates the percentage of a glyph's width. Also known as tracking.
  - setLetterSpacing
```
public void setLetterSpacing(double letterSpacing)
```
    Sets the additional spacing that is added to each glyph beyond what is defined by its character box in the font. Value indicates the percentage of a glyph's width. Also known as tracking.
  - getLetterWidth
```
public double getLetterWidth()
```
    Gets the width that is added to each glyph beyond what is defined by its character box in its font. This is a percentage of the original glyph.
  - setLetterWidth
```
public void setLetterWidth(double letterWidth)
```
    Sets the width that is added to each glyph beyond what is defined by its character box in its font. This is a percentage of the original glyph.
  - getLigatures
```
public boolean getLigatures()
```
    Gets a value indicating whether text is to be drawn with ligatures, which occur when two or more letters or portions of letters are joined to form a single glyph.
  - setLigatures
```
public void setLigatures(boolean ligatures)
```
    Sets a value indicating whether text is to be drawn with ligatures, which occur when two or more letters or portions of letters are joined to form a single glyph.
  - getLineGap
```
public double getLineGap()
```
    Gets the spacing between lines of text. This is also known as leading or line spacing.
  - setLineGap
```
public void setLineGap(double lineGap)
```
    Sets the spacing between lines of text. This is also known as leading or line spacing.
  - getLineGapType
```
public LineGapType getLineGapType()
```
    Gets the type of line gap that is applied.
  - setLineGapType
```
public void setLineGapType(LineGapType lineGapType)
```
    Sets the type of line gap that is applied.
  - getOffsetX
```
public double getOffsetX()
```
    Gets the X offset.
  - setOffsetX
```
public void setOffsetX(double offsetX)
```
    Sets the X offset.
  - getOffsetY
```
public double getOffsetY()
```
    Gets the Y offset.
  - setOffsetY
```
public void setOffsetY(double offsetY)
```
    Sets the Y offset.
  - getOffsetZ
```
public double getOffsetZ()
```
    Gets the Z offset.
  - setOffsetZ
```
public void setOffsetZ(double offsetZ)
```
    Sets the Z offset.
  - getShadowColor
```
public CIMColor getShadowColor()
```
    Gets the color of the shadow that is defined for the text symbol. The shadow is drawn as an offset copy of the text.
  - setShadowColor
```
public void setShadowColor(CIMColor shadowColor)
```
    Sets the color of the shadow that is defined for the text symbol. The shadow is drawn as an offset copy of the text.
  - getShadowOffsetX
```
public double getShadowOffsetX()
```
    Gets the shadow offset from the text symbol in the horizontal direction. If X and Y are zero, no shadow is drawn.
  - setShadowOffsetX
```
public void setShadowOffsetX(double shadowOffsetX)
```
    Sets the shadow offset from the text symbol in the horizontal direction. If X and Y are zero, no shadow is drawn.
  - getShadowOffsetY
```
public double getShadowOffsetY()
```
    Gets the shadow offset from the text symbol in the vertical direction. If X and Y are zero, no shadow is drawn.
  - setShadowOffsetY
```
public void setShadowOffsetY(double shadowOffsetY)
```
    Sets the shadow offset from the text symbol in the vertical direction. If X and Y are zero, no shadow is drawn.
  - getSmallCaps
```
public boolean getSmallCaps()
```
    Gets a value indicating whether the text should be drawn as Small Capitals, where lower case text is converted to small caps and upper case text is left as upper case.
  - setSmallCaps
```
public void setSmallCaps(boolean smallCaps)
```
    Sets a value indicating whether the text should be drawn as Small Capitals, where lower case text is converted to small caps and upper case text is left as upper case.
  - getStrikethrough
```
public boolean getStrikethrough()
```
    Gets a value indicating whether to draw the text with a strike through it.
  - setStrikethrough
```
public void setStrikethrough(boolean strikethrough)
```
    Sets a value indicating whether to draw the text with a strike through it.
  - getSymbol
```
public CIMPolygonSymbol getSymbol()
```
    Gets the polygon symbol that is used to draw the glyphs of the text.
  - setSymbol
```
public void setSymbol(CIMPolygonSymbol symbol)
```
    Sets the polygon symbol that is used to draw the glyphs of the text.
  - getSymbol3DProperties
```
public CIM3DSymbolProperties getSymbol3DProperties()
```
    Gets the collection of properties that are applied to the text symbol only in a 3D context.
  - setSymbol3DProperties
```
public void setSymbol3DProperties(CIM3DSymbolProperties symbol3DProperties)
```
    Sets the collection of properties that are applied to the text symbol only in a 3D context.
  - getTextCase
```
public TextCase getTextCase()
```
    Gets the letter case used to draw the text.
  - setTextCase
```
public void setTextCase(TextCase textCase)
```
    Sets the letter case used to draw the text.
  - getTextDirection
```
public TextReadingDirection getTextDirection()
```
    Gets the base text direction to draw the text.
  - setTextDirection
```
public void setTextDirection(TextReadingDirection textDirection)
```
    Sets the base text direction to draw the text.
  - getUnderline
```
public boolean getUnderline()
```
    Gets a value indicating whether to draw the text with an underline.
  - setUnderline
```
public void setUnderline(boolean underline)
```
    Sets a value indicating whether to draw the text with an underline.
  - getVerticalAlignment
```
public VerticalAlignment getVerticalAlignment()
```
    Gets the vertical alignment of the text.
  - setVerticalAlignment
```
public void setVerticalAlignment(VerticalAlignment verticalAlignment)
```
    Sets the vertical alignment of the text.
  - getVerticalGlyphOrientation
```
public VerticalGlyphOrientation getVerticalGlyphOrientation()
```
    Gets the orientation for the non-vertical text in a vertical layout. For example, an English fragment in a Japanese text.
  - setVerticalGlyphOrientation
```
public void setVerticalGlyphOrientation(VerticalGlyphOrientation verticalGlyphOrientation)
```
    Sets the orientation for the non-vertical text in a vertical layout. For example, an English fragment in a Japanese text.
  - getWordSpacing
```
public double getWordSpacing()
```
    Gets the additional spacing that is added to between the words of the text string. 100% indicates that regular spacing is used.
  - setWordSpacing
```
public void setWordSpacing(double wordSpacing)
```
    Sets the additional spacing that is added to between the words of the text string. 100% indicates that regular spacing is used.
  - getBillboardMode3D
```
public BillboardMode getBillboardMode3D()
```
    Gets the billboard mode of the text symbol.
  - setBillboardMode3D
```
public void setBillboardMode3D(BillboardMode billboardMode3D)
```
    Sets the billboard mode of the text symbol.
  - getOverprint
```
public boolean getOverprint()
```
    Gets a value indicating whether or not the symbol should overprint in press printing.
  - setOverprint
```
public void setOverprint(boolean overprint)
```
    Sets a value indicating whether or not the symbol should overprint in press printing.
  - fromJSON
```
public static CIMTextSymbol 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 CIMSymbol
    
    Throws:
    
    CIMJSONException
  - serialize
```
public void serialize(JSONObject jsonObject)
```
    Serializes this object to its JSON representation.
    
    Overrides:
    
    serialize in class CIMSymbol

Class CIMTextSymbol

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CIMTextSymbol

Method Detail

getAngle

setAngle

getAngleX

setAngleX

getAngleY

setAngleY

getBlockProgression

setBlockProgression

getCallout

setCallout

getCompatibilityMode

setCompatibilityMode

getCountryISO

setCountryISO

getDepth3D

setDepth3D

getDrawGlyphsAsGeometry

setDrawGlyphsAsGeometry

getDrawSoftHyphen

setDrawSoftHyphen

getExtrapolateBaselines

setExtrapolateBaselines

getFlipAngle

setFlipAngle

getFontEffects

setFontEffects

getFontEncoding

setFontEncoding

getFontFamilyName

setFontFamilyName

getFontStyleName

setFontStyleName

getFontType

setFontType

getFontVariationSettings

setFontVariationSettings

getGlyphRotation

setGlyphRotation

getHaloSize

setHaloSize

getHaloSymbol

setHaloSymbol

getHeight

setHeight

getHinting

setHinting

getHorizontalAlignment

setHorizontalAlignment

getIndentAfter

setIndentAfter

getIndentBefore

setIndentBefore

getIndentFirstLine

setIndentFirstLine

getKerning

setKerning

getLanguageISO

setLanguageISO

getLetterSpacing

setLetterSpacing

getLetterWidth

setLetterWidth

getLigatures

setLigatures

getLineGap

setLineGap

getLineGapType

setLineGapType

getOffsetX

setOffsetX

getOffsetY

setOffsetY

getOffsetZ