public class CIMDimensionStyle extends CIMObject
| Constructor and Description |
|---|
CIMDimensionStyle() |
| 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.
|
public boolean getAlign()
public void setAlign(boolean align)
public double getBaselineHeight()
public void setBaselineHeight(double baselineHeight)
public CIMPointSymbol getBeginMarkerSymbol()
public void setBeginMarkerSymbol(CIMPointSymbol beginMarkerSymbol)
public boolean getConvertUnits()
public void setConvertUnits(boolean convertUnits)
public DimensionPartOptions getDimensionLineOption()
public void setDimensionLineOption(DimensionPartOptions dimensionLineOption)
public CIMLineSymbol getDimensionLineSymbol()
public void setDimensionLineSymbol(CIMLineSymbol dimensionLineSymbol)
public int getDisplayPrecision()
public void setDisplayPrecision(int displayPrecision)
public IUnit getDisplayUnits()
public void setDisplayUnits(IUnit displayUnits)
public boolean getDrawLineOnFit()
public void setDrawLineOnFit(boolean drawLineOnFit)
public CIMPointSymbol getEndMarkerSymbol()
public void setEndMarkerSymbol(CIMPointSymbol endMarkerSymbol)
public java.lang.String getExpression()
public void setExpression(java.lang.String expression)
public java.lang.String getExpressionParserName()
public void setExpressionParserName(java.lang.String expressionParserName)
public java.lang.String getExpressionTitle()
public void setExpressionTitle(java.lang.String expressionTitle)
public boolean getExtendLineOnFit()
public void setExtendLineOnFit(boolean extendLineOnFit)
public double getExtensionLineOffset()
public void setExtensionLineOffset(double extensionLineOffset)
public DimensionPartOptions getExtensionLineOption()
public void setExtensionLineOption(DimensionPartOptions extensionLineOption)
public double getExtensionLineOvershot()
public void setExtensionLineOvershot(double extensionLineOvershot)
public CIMLineSymbol getExtensionLineSymbol()
public void setExtensionLineSymbol(CIMLineSymbol extensionLineSymbol)
public int getID()
public void setID(int iD)
public DimensionMarkerFit getMarkerFit()
public void setMarkerFit(DimensionMarkerFit markerFit)
public double getMarkerFitTolerance()
public void setMarkerFitTolerance(double markerFitTolerance)
public DimensionPartOptions getMarkerOption()
public void setMarkerOption(DimensionPartOptions markerOption)
public java.lang.String getName()
public void setName(java.lang.String name)
public java.lang.String getPrefix()
public void setPrefix(java.lang.String prefix)
public java.lang.String getSuffix()
public void setSuffix(java.lang.String suffix)
public DimensionTextFit getTextFit()
public void setTextFit(DimensionTextFit textFit)
public DimensionTextOption getTextOption()
public void setTextOption(DimensionTextOption textOption)
public CIMTextSymbol getTextSymbol()
public void setTextSymbol(CIMTextSymbol textSymbol)
public static CIMDimensionStyle fromJSON(java.lang.String json) throws CIMJSONException
CIMJSONExceptionpublic java.lang.String toJSON()
public void deserialize(JSONObject jsonObject) throws CIMJSONException
deserialize in class CIMObjectCIMJSONExceptionpublic void serialize(JSONObject jsonObject)