org.cip4.jdflib.datatypes
Class JDFCMYKColor

java.lang.Object
  extended by java.util.AbstractCollection<E>
      extended by java.util.AbstractList<E>
          extended by java.util.Vector<Object>
              extended by org.cip4.jdflib.datatypes.JDFNumList
                  extended by org.cip4.jdflib.datatypes.JDFCMYKColor
All Implemented Interfaces:
Serializable, Cloneable, Iterable<Object>, Collection<Object>, List<Object>, RandomAccess, JDFBaseDataTypes

public class JDFCMYKColor
extends JDFNumList

This class is a representation of a CMYK color (JDFCMYKColor). It is a blank separated list of double values consisting of C the cyan color, M the magenta color, Y the yellow color and K the black color value.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.cip4.jdflib.datatypes.JDFBaseDataTypes
JDFBaseDataTypes.EnumFitsValue
 
Field Summary
 
Fields inherited from class java.util.Vector
capacityIncrement, elementCount, elementData
 
Fields inherited from class java.util.AbstractList
modCount
 
Fields inherited from interface org.cip4.jdflib.datatypes.JDFBaseDataTypes
EPSILON, MAX_CMYK_COLOR, MAX_LAB_COLOR, MAX_MATRIX_DIMENSION, MAX_RECTANGLE_DIMENSION, MAX_RGB_COLOR, MAX_SHAPE_DIMENSION, MAX_XY_DIMENSION
 
Constructor Summary
JDFCMYKColor()
          constructs a CMYK color with all values set to 0.0 Double
JDFCMYKColor(double c, double m, double y, double k)
          constructs a new CMYK color with the given double values
JDFCMYKColor(JDFNumList nl)
          constructs a CMYK color with a given JDFNumberList
JDFCMYKColor(String s)
          constructs a CMYK color with the given String
JDFCMYKColor(Vector v)
          Deprecated. use typesafe constructors
 
Method Summary
static JDFCMYKColor createCMYKColor(String s)
          factory for JDFCMYKColor that silently returns null in case of illegal strings
 double getC()
          getC - returns the value C of the CMYK color
 double getK()
          getK - returns the value K of the CMYK color
 double getM()
          getM - returns the value M of the CMYK color
 JDFRGBColor getRGB()
           
 double getY()
          getY - returns the value Y of the CMYK color
 boolean isValid()
          isValid - the size of the vector must be 4 and all instances are Double types
 void setC(double c)
          setC - sets the value C of the CMYK color
 void setK(double k)
          setK - sets the value K of the CMYK color
 void setM(double m)
          setM - sets the value M of the CMYK color
 void setNamedColor(String name)
          set the cmyk value of this to a matching value
 void setY(double y)
          setY - sets the value Y of the CMYK color
 
Methods inherited from class org.cip4.jdflib.datatypes.JDFNumList
abs, clone, contains, containsAll, copyNumList, doubleAt, elementAt, equals, getDoubleList, getIntArray, getString, getString, hashCode, isValidString, matches, removeElementAt, replaceElementAt, scale, scaleFromCM, scaleFromMM, scaleToCM, scaleToMM, set, setString, subtract, toString, unify
 
Methods inherited from class java.util.Vector
add, add, addAll, addAll, addElement, capacity, clear, contains, containsAll, copyInto, elements, ensureCapacity, firstElement, get, indexOf, indexOf, insertElementAt, isEmpty, lastElement, lastIndexOf, lastIndexOf, remove, remove, removeAll, removeAllElements, removeElement, removeRange, retainAll, set, setElementAt, setSize, size, subList, toArray, toArray, trimToSize
 
Methods inherited from class java.util.AbstractList
iterator, listIterator, listIterator
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.List
iterator, listIterator, listIterator
 

Constructor Detail

JDFCMYKColor

public JDFCMYKColor()
constructs a CMYK color with all values set to 0.0 Double


JDFCMYKColor

@Deprecated
public JDFCMYKColor(Vector v)
             throws DataFormatException
Deprecated. use typesafe constructors

constructs a CMYK color with the given vector

Parameters:
Vector - v - the given vector
Throws:
DataFormatException - - if the Vector has not a valid format

JDFCMYKColor

public JDFCMYKColor(String s)
             throws DataFormatException
constructs a CMYK color with the given String

Parameters:
s - - the given String
Throws:
DataFormatException - - if the String has not a valid format

JDFCMYKColor

public JDFCMYKColor(JDFNumList nl)
             throws DataFormatException
constructs a CMYK color with a given JDFNumberList

Parameters:
nl - - the given number list
Throws:
DataFormatException - - if the String has not a valid format

JDFCMYKColor

public JDFCMYKColor(double c,
                    double m,
                    double y,
                    double k)
constructs a new CMYK color with the given double values

Parameters:
c - - the value c
m - - the value m
y - - the value y
k - - the value k
Method Detail

createCMYKColor

public static JDFCMYKColor createCMYKColor(String s)
factory for JDFCMYKColor that silently returns null in case of illegal strings

Parameters:
s - the string to parse
Returns:
the JDFCMYKColor, null if s is not compatible

isValid

public boolean isValid()
                throws DataFormatException
isValid - the size of the vector must be 4 and all instances are Double types

Specified by:
isValid in class JDFNumList
Returns:
boolean - true if all instances are Double or Integer types
Throws:
DataFormatException - - if the Vector has not a valid format

getC

public double getC()
getC - returns the value C of the CMYK color

Returns:
double - the value C of the CMYK color

setC

public void setC(double c)
setC - sets the value C of the CMYK color

Parameters:
c - the value C of the CMYK color

getM

public double getM()
getM - returns the value M of the CMYK color

Returns:
double - the value M of the CMYK color

setM

public void setM(double m)
setM - sets the value M of the CMYK color

Parameters:
m - the value M of the CMYK color

getY

public double getY()
getY - returns the value Y of the CMYK color

Returns:
double - the value Y of the CMYK color

setY

public void setY(double y)
setY - sets the value Y of the CMYK color

Parameters:
y - the value Y of the CMYK color

getK

public double getK()
getK - returns the value K of the CMYK color

Returns:
double - the value K of the CMYK color

setK

public void setK(double k)
setK - sets the value K of the CMYK color

Parameters:
k - the value K of the CMYK color

getRGB

public JDFRGBColor getRGB()
Returns:
the rgb color that roughly represents this

setNamedColor

public void setNamedColor(String name)
set the cmyk value of this to a matching value

Parameters:
name -


Copyright © 2013. All Rights Reserved.