com.esri.arcgis.cartox.cim

Class CIMSpotColorSpace

java.lang.Object

com.esri.arcgis.cartox.cim.CIMObject

com.esri.arcgis.cartox.cim.CIMColorSpace

com.esri.arcgis.cartox.cim.CIMSpotColorSpace

public class CIMSpotColorSpace
extends CIMColorSpace

Represents a color space for spot colors.

Constructor Summary

Constructors

Constructor and Description
CIMSpotColorSpace()

Method Summary

Modifier and Type	Method and Description
void	deserialize(JSONObject jsonObject) Deserializes this object from its JSON representation.
static CIMSpotColorSpace	fromJSON(java.lang.String json) Creates the object with a specified state from a JSON encoding.
CIMColor	getAlternativeColor() Gets the standard (non-spot) color that is used to display the color on-screen.
CIMColor	getBookColor() Gets the if present, the color used during output.
java.lang.String	getBookID() Gets the ID of the book the color name belongs to.
java.lang.String	getDescription() Gets a description of the ink.
boolean	getIsReferencedColor() Gets a value indicating whether or not the color is a referenced color.
java.lang.String	getName() Gets the defined ink name for the spot color.
void	serialize(JSONObject jsonObject) Serializes this object to its JSON representation.
void	setAlternativeColor(CIMColor alternativeColor) Sets the standard (non-spot) color that is used to display the color on-screen.
void	setBookColor(CIMColor bookColor) Sets the if present, the color used during output.
void	setBookID(java.lang.String bookID) Sets the ID of the book the color name belongs to.
void	setDescription(java.lang.String description) Sets a description of the ink.
void	setIsReferencedColor(boolean isReferencedColor) Sets a value indicating whether or not the color is a referenced color.
void	setName(java.lang.String name) Sets the defined ink name for the spot color.
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

CIMSpotColorSpace

public CIMSpotColorSpace()

Method Detail

getDescription

public java.lang.String getDescription()

Gets a description of the ink. This can provide more information than the name.

setDescription

public void setDescription(java.lang.String description)

Sets a description of the ink. This can provide more information than the name.

getName

public java.lang.String getName()

Gets the defined ink name for the spot color. Usually this is a well-known color standard name.

setName

public void setName(java.lang.String name)

Sets the defined ink name for the spot color. Usually this is a well-known color standard name.

getAlternativeColor

public CIMColor getAlternativeColor()

Gets the standard (non-spot) color that is used to display the color on-screen.

setAlternativeColor

public void setAlternativeColor(CIMColor alternativeColor)

Sets the standard (non-spot) color that is used to display the color on-screen.

getBookColor

public CIMColor getBookColor()

Gets the if present, the color used during output.

setBookColor

public void setBookColor(CIMColor bookColor)

Sets the if present, the color used during output.

getBookID

public java.lang.String getBookID()

Gets the ID of the book the color name belongs to.

setBookID

public void setBookID(java.lang.String bookID)

Sets the ID of the book the color name belongs to.

getIsReferencedColor

public boolean getIsReferencedColor()

Gets a value indicating whether or not the color is a referenced color. When this property is true, the alternative color will be looked up from the color book based on the BookID and Name.

setIsReferencedColor

public void setIsReferencedColor(boolean isReferencedColor)

Sets a value indicating whether or not the color is a referenced color. When this property is true, the alternative color will be looked up from the color book based on the BookID and Name.

fromJSON

public static CIMSpotColorSpace 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 CIMColorSpace

Throws:

CIMJSONException

serialize

public void serialize(JSONObject jsonObject)

Serializes this object to its JSON representation.

Overrides:

serialize in class CIMColorSpace