com.esri.arcgis.cartox.cim

Class CIMGeometricEffectDashes

java.lang.Object

com.esri.arcgis.cartox.cim.CIMObject

com.esri.arcgis.cartox.cim.CIMGeometricEffect

com.esri.arcgis.cartox.cim.CIMGeometricEffectDashes

public class CIMGeometricEffectDashes
extends CIMGeometricEffect

Represents the dashes geometric effect which creates a dynamic multipart line geometry from a line feature or the outline of a polygon based on a template.

Constructor Summary

Constructors

Constructor and Description
CIMGeometricEffectDashes()

Method Summary

Modifier and Type	Method and Description
void	deserialize(JSONObject jsonObject) Deserializes this object from its JSON representation.
static CIMGeometricEffectDashes	fromJSON(java.lang.String json) Creates the object with a specified state from a JSON encoding.
LineDashEnding	getControlPointEnding() Gets the line dash ending position.
double	getCustomEndingOffset() Gets where the pattern should end relative to the ending point of the geometry.
double[]	getDashTemplate() Gets the distance for each dash and gap.
LineDashEnding	getLineDashEnding() Gets the setting which determines how the strokes with dash patterns and other patterns (pictures, placement effects) are handled at the end points of the line geometry's segments.
double	getOffsetAlongLine() Gets the position where the pattern should begin relative to the starting point of the geometry.
void	serialize(JSONObject jsonObject) Serializes this object to its JSON representation.
void	setControlPointEnding(LineDashEnding controlPointEnding) Sets the line dash ending position.
void	setCustomEndingOffset(double customEndingOffset) Sets where the pattern should end relative to the ending point of the geometry.
void	setDashTemplate(double[] dashTemplate) Sets the distance for each dash and gap.
void	setLineDashEnding(LineDashEnding lineDashEnding) Sets the setting which determines how the strokes with dash patterns and other patterns (pictures, placement effects) are handled at the end points of the line geometry's segments.
void	setOffsetAlongLine(double offsetAlongLine) Sets the position where the pattern should begin relative to the starting point of the geometry.
java.lang.String	toJSON() Creates a JSON encoding of the object and its current state.

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

getPrimitiveName, setPrimitiveName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CIMGeometricEffectDashes

public CIMGeometricEffectDashes()

Method Detail

getCustomEndingOffset

public double getCustomEndingOffset()

Gets where the pattern should end relative to the ending point of the geometry. Negative numbers indicate a shift to the left and positive numbers a shift to the right. This property is only applied if the LineDashEnding is set to Custom.

setCustomEndingOffset

public void setCustomEndingOffset(double customEndingOffset)

Sets where the pattern should end relative to the ending point of the geometry. Negative numbers indicate a shift to the left and positive numbers a shift to the right. This property is only applied if the LineDashEnding is set to Custom.

getDashTemplate

public double[] getDashTemplate()

Gets the distance for each dash and gap. There can be multiple dash and gap values to form a complex pattern.

setDashTemplate

public void setDashTemplate(double[] dashTemplate)

Sets the distance for each dash and gap. There can be multiple dash and gap values to form a complex pattern.

getLineDashEnding

public LineDashEnding getLineDashEnding()

Gets the setting which determines how the strokes with dash patterns and other patterns (pictures, placement effects) are handled at the end points of the line geometry's segments.

setLineDashEnding

public void setLineDashEnding(LineDashEnding lineDashEnding)

Sets the setting which determines how the strokes with dash patterns and other patterns (pictures, placement effects) are handled at the end points of the line geometry's segments.

getOffsetAlongLine

public double getOffsetAlongLine()

Gets the position where the pattern should begin relative to the starting point of the geometry. It shifts the entire pattern along the line the specified distance. Negative values indicate a shift to the left and positive numbers a shift to the right. This property is only applied if LineDashEnding is set to NoConstraint or Custom.

setOffsetAlongLine

public void setOffsetAlongLine(double offsetAlongLine)

Sets the position where the pattern should begin relative to the starting point of the geometry. It shifts the entire pattern along the line the specified distance. Negative values indicate a shift to the left and positive numbers a shift to the right. This property is only applied if LineDashEnding is set to NoConstraint or Custom.

getControlPointEnding

public LineDashEnding getControlPointEnding()

Gets the line dash ending position.

setControlPointEnding

public void setControlPointEnding(LineDashEnding controlPointEnding)

Sets the line dash ending position.

fromJSON

public static CIMGeometricEffectDashes 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 CIMGeometricEffect

Throws:

CIMJSONException

serialize

public void serialize(JSONObject jsonObject)

Serializes this object to its JSON representation.

Overrides:

serialize in class CIMGeometricEffect