com.esri.arcgis.cartox.cim

Class CIMGradientFill

java.lang.Object

com.esri.arcgis.cartox.cim.CIMObject

com.esri.arcgis.cartox.cim.CIMSymbolLayer

com.esri.arcgis.cartox.cim.CIMFill

com.esri.arcgis.cartox.cim.CIMGradientFill

public class CIMGradientFill
extends CIMFill

Represents a gradient fill which fills polygonal geometry with a specified color scheme.

Constructor Summary

Constructors

Constructor and Description
CIMGradientFill()

Method Summary

Modifier and Type	Method and Description
void	deserialize(JSONObject jsonObject) Deserializes this object from its JSON representation.
static CIMGradientFill	fromJSON(java.lang.String json) Creates the object with a specified state from a JSON encoding.
double	getAngle() Gets the angle of the gradient when the GradientMethod is set to Linear or Rectangular.
CIMColorRamp	getColorRamp() Gets the color scheme that is applied to the fill.
GradientFillMethod	getGradientMethod() Gets a value which specifies how the gradient is applied within the fill.
double	getGradientSize() Gets a value which determines how much of the feature is covered by the color scheme.
SymbolUnits	getGradientSizeUnits() Gets a value which specifies whether GradientSize is applied with an absolute distance or a relative percentage.
GradientStrokeType	getGradientType() Gets a value which specifies if the gradient is applied with discrete intervals or if it is continuous.
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	setAngle(double angle) Sets the angle of the gradient when the GradientMethod is set to Linear or Rectangular.
void	setColorRamp(CIMColorRamp colorRamp) Sets the color scheme that is applied to the fill.
void	setGradientMethod(GradientFillMethod gradientMethod) Sets a value which specifies how the gradient is applied within the fill.
void	setGradientSize(double gradientSize) Sets a value which determines how much of the feature is covered by the color scheme.
void	setGradientSizeUnits(SymbolUnits gradientSizeUnits) Sets a value which specifies whether GradientSize is applied with an absolute distance or a relative percentage.
void	setGradientType(GradientStrokeType gradientType) Sets a value which specifies if the gradient is applied with discrete intervals or if it is continuous.
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.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

CIMGradientFill

public CIMGradientFill()

Method Detail

getAngle

public double getAngle()

Gets the angle of the gradient when the GradientMethod is set to Linear or Rectangular.

setAngle

public void setAngle(double angle)

Sets the angle of the gradient when the GradientMethod is set to Linear or Rectangular.

getColorRamp

public CIMColorRamp getColorRamp()

Gets the color scheme that is applied to the fill.

setColorRamp

public void setColorRamp(CIMColorRamp colorRamp)

Sets the color scheme that is applied to the fill.

getGradientMethod

public GradientFillMethod getGradientMethod()

Gets a value which specifies how the gradient is applied within the fill.

setGradientMethod

public void setGradientMethod(GradientFillMethod gradientMethod)

Sets a value which specifies how the gradient is applied within the fill.

getGradientSize

public double getGradientSize()

Gets a value which determines 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 a value which determines 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 a value which specifies whether GradientSize is applied with an absolute distance or a relative percentage.

setGradientSizeUnits

public void setGradientSizeUnits(SymbolUnits gradientSizeUnits)

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

getGradientType

public GradientStrokeType getGradientType()

Gets a value which specifies if the gradient is applied with discrete intervals or if it is continuous.

setGradientType

public void setGradientType(GradientStrokeType gradientType)

Sets a value which specifies if the gradient is applied with discrete intervals or if it is continuous.

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 CIMGradientFill 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 CIMFill

Throws:

CIMJSONException

serialize

public void serialize(JSONObject jsonObject)

Serializes this object to its JSON representation.

Overrides:

serialize in class CIMFill