CIMDimensionStyle (ArcObjects Java API)

java.lang.Object
- com.esri.arcgis.cartox.cim.CIMObject
- - com.esri.arcgis.cartox.cim.CIMDimensionStyle

```
public class CIMDimensionStyle
extends CIMObject
```
Represents an dimension style which defines dimension appearance.

Constructor Summary

Constructors
Constructor and Description

CIMDimensionStyle()

Constructors
Constructor and Description
`CIMDimensionStyle()`

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 CIMDimensionStyle`	`fromJSON(java.lang.String json)` Creates the object with a specified state from a JSON encoding.
`boolean`	`getAlign()` Gets a value indicating whether the text should be aligned with the dimension line.
`double`	`getBaselineHeight()` Gets the height of the construction for creating baseline dimensions with this style.
`CIMPointSymbol`	`getBeginMarkerSymbol()` Gets the symbol used for the begin arrow.
`boolean`	`getConvertUnits()` Gets a value indicating whether the length of the dimension needs to be converted for display.
`DimensionPartOptions`	`getDimensionLineOption()` Gets the dimension line display of the style.
`CIMLineSymbol`	`getDimensionLineSymbol()` Gets the symbol used for the dimension line.
`int`	`getDisplayPrecision()` Gets the precision for the value displayed by the dimension text.
`IUnit`	`getDisplayUnits()` Gets the units the length of the dimension text is displayed in.
`boolean`	`getDrawLineOnFit()` Gets a value indicating whether a dimension line should be drawn between the extension lines for an inward dimension.
`CIMPointSymbol`	`getEndMarkerSymbol()` Gets the symbol used for the end arrow.
`java.lang.String`	`getExpression()` Gets the text expression for the style.
`java.lang.String`	`getExpressionParserName()` Gets the text expression parser for the text expression for the style.
`java.lang.String`	`getExpressionTitle()` Gets the human readable text title that describes the dimension expression.
`boolean`	`getExtendLineOnFit()` Gets a value indicating whether the dimension line will be extended to underline the text on inward dimensions.
`double`	`getExtensionLineOffset()` Gets the length of the extension line offset.
`DimensionPartOptions`	`getExtensionLineOption()` Gets the extension line display options of the style.
`double`	`getExtensionLineOvershot()` Gets the length of the extension line overshot.
`CIMLineSymbol`	`getExtensionLineSymbol()` Gets the symbol used for extension lines.
`int`	`getID()` Gets the ID of the style.
`DimensionMarkerFit`	`getMarkerFit()` Gets the arrow fit policy of the style.
`double`	`getMarkerFitTolerance()` Gets the arrow fit tolerance of the style.
`DimensionPartOptions`	`getMarkerOption()` Gets the arrow display properties of the style.
`java.lang.String`	`getName()` Gets the name of the style.
`java.lang.String`	`getPrefix()` Gets the prefix for the text expression for the style.
`java.lang.String`	`getSuffix()` Gets the suffix for the text expression for the style.
`DimensionTextFit`	`getTextFit()` Gets the text fit policy for the style.
`DimensionTextOption`	`getTextOption()` Gets the text display option for the style.
`CIMTextSymbol`	`getTextSymbol()` Gets the text symbol used for the text.
`void`	`serialize(JSONObject jsonObject)` Serializes this object to its JSON representation.
`void`	`setAlign(boolean align)` Sets a value indicating whether the text should be aligned with the dimension line.
`void`	`setBaselineHeight(double baselineHeight)` Sets the height of the construction for creating baseline dimensions with this style.
`void`	`setBeginMarkerSymbol(CIMPointSymbol beginMarkerSymbol)` Sets the symbol used for the begin arrow.
`void`	`setConvertUnits(boolean convertUnits)` Sets a value indicating whether the length of the dimension needs to be converted for display.
`void`	`setDimensionLineOption(DimensionPartOptions dimensionLineOption)` Sets the dimension line display of the style.
`void`	`setDimensionLineSymbol(CIMLineSymbol dimensionLineSymbol)` Sets the symbol used for the dimension line.
`void`	`setDisplayPrecision(int displayPrecision)` Sets the precision for the value displayed by the dimension text.
`void`	`setDisplayUnits(IUnit displayUnits)` Sets the units the length of the dimension text is displayed in.
`void`	`setDrawLineOnFit(boolean drawLineOnFit)` Sets a value indicating whether a dimension line should be drawn between the extension lines for an inward dimension.
`void`	`setEndMarkerSymbol(CIMPointSymbol endMarkerSymbol)` Sets the symbol used for the end arrow.
`void`	`setExpression(java.lang.String expression)` Sets the text expression for the style.
`void`	`setExpressionParserName(java.lang.String expressionParserName)` Sets the text expression parser for the text expression for the style.
`void`	`setExpressionTitle(java.lang.String expressionTitle)` Sets the human readable text title that describes the dimension expression.
`void`	`setExtendLineOnFit(boolean extendLineOnFit)` Sets a value indicating whether the dimension line will be extended to underline the text on inward dimensions.
`void`	`setExtensionLineOffset(double extensionLineOffset)` Sets the length of the extension line offset.
`void`	`setExtensionLineOption(DimensionPartOptions extensionLineOption)` Sets the extension line display options of the style.
`void`	`setExtensionLineOvershot(double extensionLineOvershot)` Sets the length of the extension line overshot.
`void`	`setExtensionLineSymbol(CIMLineSymbol extensionLineSymbol)` Sets the symbol used for extension lines.
`void`	`setID(int iD)` Sets the ID of the style.
`void`	`setMarkerFit(DimensionMarkerFit markerFit)` Sets the arrow fit policy of the style.
`void`	`setMarkerFitTolerance(double markerFitTolerance)` Sets the arrow fit tolerance of the style.
`void`	`setMarkerOption(DimensionPartOptions markerOption)` Sets the arrow display properties of the style.
`void`	`setName(java.lang.String name)` Sets the name of the style.
`void`	`setPrefix(java.lang.String prefix)` Sets the prefix for the text expression for the style.
`void`	`setSuffix(java.lang.String suffix)` Sets the suffix for the text expression for the style.
`void`	`setTextFit(DimensionTextFit textFit)` Sets the text fit policy for the style.
`void`	`setTextOption(DimensionTextOption textOption)` Sets the text display option for the style.
`void`	`setTextSymbol(CIMTextSymbol textSymbol)` Sets the text symbol used for the text.
`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
  - CIMDimensionStyle
```
public CIMDimensionStyle()
```
- Method Detail
  - getAlign
```
public boolean getAlign()
```
    Gets a value indicating whether the text should be aligned with the dimension line.
  - setAlign
```
public void setAlign(boolean align)
```
    Sets a value indicating whether the text should be aligned with the dimension line.
  - getBaselineHeight
```
public double getBaselineHeight()
```
    Gets the height of the construction for creating baseline dimensions with this style.
  - setBaselineHeight
```
public void setBaselineHeight(double baselineHeight)
```
    Sets the height of the construction for creating baseline dimensions with this style.
  - getBeginMarkerSymbol
```
public CIMPointSymbol getBeginMarkerSymbol()
```
    Gets the symbol used for the begin arrow.
  - setBeginMarkerSymbol
```
public void setBeginMarkerSymbol(CIMPointSymbol beginMarkerSymbol)
```
    Sets the symbol used for the begin arrow.
  - getConvertUnits
```
public boolean getConvertUnits()
```
    Gets a value indicating whether the length of the dimension needs to be converted for display.
  - setConvertUnits
```
public void setConvertUnits(boolean convertUnits)
```
    Sets a value indicating whether the length of the dimension needs to be converted for display.
  - getDimensionLineOption
```
public DimensionPartOptions getDimensionLineOption()
```
    Gets the dimension line display of the style.
  - setDimensionLineOption
```
public void setDimensionLineOption(DimensionPartOptions dimensionLineOption)
```
    Sets the dimension line display of the style.
  - getDimensionLineSymbol
```
public CIMLineSymbol getDimensionLineSymbol()
```
    Gets the symbol used for the dimension line.
  - setDimensionLineSymbol
```
public void setDimensionLineSymbol(CIMLineSymbol dimensionLineSymbol)
```
    Sets the symbol used for the dimension line.
  - getDisplayPrecision
```
public int getDisplayPrecision()
```
    Gets the precision for the value displayed by the dimension text.
  - setDisplayPrecision
```
public void setDisplayPrecision(int displayPrecision)
```
    Sets the precision for the value displayed by the dimension text.
  - getDisplayUnits
```
public IUnit getDisplayUnits()
```
    Gets the units the length of the dimension text is displayed in.
  - setDisplayUnits
```
public void setDisplayUnits(IUnit displayUnits)
```
    Sets the units the length of the dimension text is displayed in.
  - getDrawLineOnFit
```
public boolean getDrawLineOnFit()
```
    Gets a value indicating whether a dimension line should be drawn between the extension lines for an inward dimension.
  - setDrawLineOnFit
```
public void setDrawLineOnFit(boolean drawLineOnFit)
```
    Sets a value indicating whether a dimension line should be drawn between the extension lines for an inward dimension.
  - getEndMarkerSymbol
```
public CIMPointSymbol getEndMarkerSymbol()
```
    Gets the symbol used for the end arrow.
  - setEndMarkerSymbol
```
public void setEndMarkerSymbol(CIMPointSymbol endMarkerSymbol)
```
    Sets the symbol used for the end arrow.
  - getExpression
```
public java.lang.String getExpression()
```
    Gets the text expression for the style.
  - setExpression
```
public void setExpression(java.lang.String expression)
```
    Sets the text expression for the style.
  - getExpressionParserName
```
public java.lang.String getExpressionParserName()
```
    Gets the text expression parser for the text expression for the style.
  - setExpressionParserName
```
public void setExpressionParserName(java.lang.String expressionParserName)
```
    Sets the text expression parser for the text expression for the style.
  - getExpressionTitle
```
public java.lang.String getExpressionTitle()
```
    Gets the human readable text title that describes the dimension expression.
  - setExpressionTitle
```
public void setExpressionTitle(java.lang.String expressionTitle)
```
    Sets the human readable text title that describes the dimension expression.
  - getExtendLineOnFit
```
public boolean getExtendLineOnFit()
```
    Gets a value indicating whether the dimension line will be extended to underline the text on inward dimensions.
  - setExtendLineOnFit
```
public void setExtendLineOnFit(boolean extendLineOnFit)
```
    Sets a value indicating whether the dimension line will be extended to underline the text on inward dimensions.
  - getExtensionLineOffset
```
public double getExtensionLineOffset()
```
    Gets the length of the extension line offset.
  - setExtensionLineOffset
```
public void setExtensionLineOffset(double extensionLineOffset)
```
    Sets the length of the extension line offset.
  - getExtensionLineOption
```
public DimensionPartOptions getExtensionLineOption()
```
    Gets the extension line display options of the style.
  - setExtensionLineOption
```
public void setExtensionLineOption(DimensionPartOptions extensionLineOption)
```
    Sets the extension line display options of the style.
  - getExtensionLineOvershot
```
public double getExtensionLineOvershot()
```
    Gets the length of the extension line overshot.
  - setExtensionLineOvershot
```
public void setExtensionLineOvershot(double extensionLineOvershot)
```
    Sets the length of the extension line overshot.
  - getExtensionLineSymbol
```
public CIMLineSymbol getExtensionLineSymbol()
```
    Gets the symbol used for extension lines.
  - setExtensionLineSymbol
```
public void setExtensionLineSymbol(CIMLineSymbol extensionLineSymbol)
```
    Sets the symbol used for extension lines.
  - getID
```
public int getID()
```
    Gets the ID of the style.
  - setID
```
public void setID(int iD)
```
    Sets the ID of the style.
  - getMarkerFit
```
public DimensionMarkerFit getMarkerFit()
```
    Gets the arrow fit policy of the style.
  - setMarkerFit
```
public void setMarkerFit(DimensionMarkerFit markerFit)
```
    Sets the arrow fit policy of the style.
  - getMarkerFitTolerance
```
public double getMarkerFitTolerance()
```
    Gets the arrow fit tolerance of the style.
  - setMarkerFitTolerance
```
public void setMarkerFitTolerance(double markerFitTolerance)
```
    Sets the arrow fit tolerance of the style.
  - getMarkerOption
```
public DimensionPartOptions getMarkerOption()
```
    Gets the arrow display properties of the style.
  - setMarkerOption
```
public void setMarkerOption(DimensionPartOptions markerOption)
```
    Sets the arrow display properties of the style.
  - getName
```
public java.lang.String getName()
```
    Gets the name of the style.
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name of the style.
  - getPrefix
```
public java.lang.String getPrefix()
```
    Gets the prefix for the text expression for the style.
  - setPrefix
```
public void setPrefix(java.lang.String prefix)
```
    Sets the prefix for the text expression for the style.
  - getSuffix
```
public java.lang.String getSuffix()
```
    Gets the suffix for the text expression for the style.
  - setSuffix
```
public void setSuffix(java.lang.String suffix)
```
    Sets the suffix for the text expression for the style.
  - getTextFit
```
public DimensionTextFit getTextFit()
```
    Gets the text fit policy for the style.
  - setTextFit
```
public void setTextFit(DimensionTextFit textFit)
```
    Sets the text fit policy for the style.
  - getTextOption
```
public DimensionTextOption getTextOption()
```
    Gets the text display option for the style.
  - setTextOption
```
public void setTextOption(DimensionTextOption textOption)
```
    Sets the text display option for the style.
  - getTextSymbol
```
public CIMTextSymbol getTextSymbol()
```
    Gets the text symbol used for the text.
  - setTextSymbol
```
public void setTextSymbol(CIMTextSymbol textSymbol)
```
    Sets the text symbol used for the text.
  - fromJSON
```
public static CIMDimensionStyle 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 CIMObject
    
    Throws:
    
    CIMJSONException
  - serialize
```
public void serialize(JSONObject jsonObject)
```
    Serializes this object to its JSON representation.
    
    Overrides:
    
    serialize in class CIMObject

Class CIMDimensionStyle

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CIMDimensionStyle

Method Detail

getAlign

setAlign

getBaselineHeight

setBaselineHeight

getBeginMarkerSymbol

setBeginMarkerSymbol

getConvertUnits

setConvertUnits

getDimensionLineOption

setDimensionLineOption

getDimensionLineSymbol

setDimensionLineSymbol

getDisplayPrecision

setDisplayPrecision

getDisplayUnits

setDisplayUnits

getDrawLineOnFit

setDrawLineOnFit

getEndMarkerSymbol

setEndMarkerSymbol

getExpression

setExpression

getExpressionParserName

setExpressionParserName

getExpressionTitle

setExpressionTitle

getExtendLineOnFit

setExtendLineOnFit

getExtensionLineOffset

setExtensionLineOffset

getExtensionLineOption

setExtensionLineOption

getExtensionLineOvershot

setExtensionLineOvershot

getExtensionLineSymbol

setExtensionLineSymbol

getID

setID

getMarkerFit

setMarkerFit

getMarkerFitTolerance

setMarkerFitTolerance

getMarkerOption

setMarkerOption

getName

setName

getPrefix

setPrefix

getSuffix

setSuffix

getTextFit

setTextFit

getTextOption

setTextOption

getTextSymbol

setTextSymbol

fromJSON

toJSON

deserialize

serialize