com.esri.arcgis.cartox.cim

Class CIMGradientStroke

java.lang.Object

com.esri.arcgis.cartox.cim.CIMObject

com.esri.arcgis.cartox.cim.CIMSymbolLayer

com.esri.arcgis.cartox.cim.CIMStroke

com.esri.arcgis.cartox.cim.CIMGradientStroke

public class CIMGradientStroke
extends CIMStroke

Represents a gradient stroke which draws linear geometry with a specified color scheme.

Constructor Summary

Constructors

Constructor and Description
CIMGradientStroke()

Method Summary

Modifier and Type	Method and Description
void	deserialize(JSONObject jsonObject) Deserializes this object from its JSON representation.
static CIMGradientStroke	fromJSON(java.lang.String json) Creates the object with a specified state from a JSON encoding.
CIMColorRamp	getColorRamp() Gets the color scheme that is applied to the stroke.
GradientStrokeMethod	getGradientMethod() Gets how the gradient is applied along the stroke.
double	getGradientSize() Gets how much of the feature is covered by the color scheme.
SymbolUnits	getGradientSizeUnits() Gets whether GradientSize is applied with an absolute distance or a relative percentage.
GradientStrokeType	getGradientType() Gets whether the gradient is applied with discrete or continuous intervals.
int	getInterval() Gets how many bands draw when the GradientType is set to Discrete.
void	serialize(JSONObject jsonObject) Serializes this object to its JSON representation.
void	setColorRamp(CIMColorRamp colorRamp) Sets the color scheme that is applied to the stroke.
void	setGradientMethod(GradientStrokeMethod gradientMethod) Sets how the gradient is applied along the stroke.
void	setGradientSize(double gradientSize) Sets how much of the feature is covered by the color scheme.
void	setGradientSizeUnits(SymbolUnits gradientSizeUnits) Sets whether GradientSize is applied with an absolute distance or a relative percentage.
void	setGradientType(GradientStrokeType gradientType) Sets whether the gradient is applied with discrete or continuous intervals.
void	setInterval(int interval) Sets how many bands draw when the GradientType is set to Discrete.
java.lang.String	toJSON() Creates a JSON encoding of the object and its current state.

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

getAnchor3D, getCapStyle, getCloseCaps3D, getHeight3D, getJoinStyle, getLineStyle3D, getMiterLimit, getWidth, setAnchor3D, setCapStyle, setCloseCaps3D, setHeight3D, setJoinStyle, setLineStyle3D, setMiterLimit, setWidth

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

getAnimations, getColorLocked, getEffects, getEnable, getName, getOverprint, getPrimitiveName, setAnimations, setColorLocked, setEffects, setEnable, setName, setOverprint, setPrimitiveName

Methods inherited from class java.lang.Object

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

Constructor Detail

CIMGradientStroke

public CIMGradientStroke()

Method Detail

getColorRamp

public CIMColorRamp getColorRamp()

Gets the color scheme that is applied to the stroke.

setColorRamp

public void setColorRamp(CIMColorRamp colorRamp)

Sets the color scheme that is applied to the stroke.

getGradientMethod

public GradientStrokeMethod getGradientMethod()

Gets how the gradient is applied along the stroke.

setGradientMethod

public void setGradientMethod(GradientStrokeMethod gradientMethod)

Sets how the gradient is applied along the stroke.

getGradientSize

public double getGradientSize()

Gets how much of the feature is covered by the color scheme. This is either a percentage of the total area which the color scheme spans or the number of page units from the starting point at which the gradient displays.

setGradientSize

public void setGradientSize(double gradientSize)

Sets how much of the feature is covered by the color scheme. This is either a percentage of the total area which the color scheme spans or the number of page units from the starting point at which the gradient displays.

getGradientSizeUnits

public SymbolUnits getGradientSizeUnits()

Gets whether GradientSize is applied with an absolute distance or a relative percentage.

setGradientSizeUnits

public void setGradientSizeUnits(SymbolUnits gradientSizeUnits)

Sets whether GradientSize is applied with an absolute distance or a relative percentage.

getGradientType

public GradientStrokeType getGradientType()

Gets whether the gradient is applied with discrete or continuous intervals.

setGradientType

public void setGradientType(GradientStrokeType gradientType)

Sets whether the gradient is applied with discrete or continuous intervals.

getInterval

public int getInterval()

Gets how many bands draw when the GradientType is set to Discrete.

setInterval

public void setInterval(int interval)

Sets how many bands draw when the GradientType is set to Discrete.

fromJSON

public static CIMGradientStroke 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 CIMStroke

Throws:

CIMJSONException

serialize

public void serialize(JSONObject jsonObject)

Serializes this object to its JSON representation.

Overrides:

serialize in class CIMStroke