KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jfree > xml > factory > objects > ColorObjectDescription


1 /* ========================================================================
2  * JCommon : a free general purpose class library for the Java(tm) platform
3  * ========================================================================
4  *
5  * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
6  *
7  * Project Info: http://www.jfree.org/jcommon/index.html
8  *
9  * This library is free software; you can redistribute it and/or modify it
10  * under the terms of the GNU Lesser General Public License as published by
11  * the Free Software Foundation; either version 2.1 of the License, or
12  * (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful, but
15  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
16  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
17  * License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with this library; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
22  * USA.
23  *
24  * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
25  * in the United States and other countries.]
26  *
27  * ---------------------------
28  * ColorObjectDescription.java
29  * ---------------------------
30  * (C)opyright 2003, 2004, by Thomas Morgner and Contributors.
31  *
32  * Original Author: Thomas Morgner;
33  * Contributor(s): David Gilbert (for Object Refinery Limited);
34  *
35  * $Id: ColorObjectDescription.java,v 1.4 2005/11/14 11:01:17 mungady Exp $
36  *
37  * Changes (from 19-Feb-2003)
38  * -------------------------
39  * 19-Feb-2003 : Added standard header and Javadocs (DG);
40  * 29-Apr-2003 : Distilled from the JFreeReport project and moved into JCommon
41  */
42
43 package org.jfree.xml.factory.objects;
44
45 import java.awt.Color JavaDoc;
46
47 import org.jfree.util.PaintUtilities;
48
49 /**
50  * An object-description for a <code>Color</code> object.
51  *
52  * @author Thomas Morgner
53  */
54 public class ColorObjectDescription extends AbstractObjectDescription {
55
56     /**
57      * Creates a new object description.
58      */
59     public ColorObjectDescription() {
60         super(Color JavaDoc.class);
61         setParameterDefinition("value", String JavaDoc.class);
62     }
63
64     /**
65      * Creates an object based on this description.
66      *
67      * @return The object.
68      */
69     public Object JavaDoc createObject() {
70         final String JavaDoc value = (String JavaDoc) getParameter("value");
71         return PaintUtilities.stringToColor(value);
72     }
73
74     /**
75      * Sets the parameters of this description object to match the supplied object.
76      *
77      * @param o the object (should be an instance of <code>Color</code>).
78      *
79      * @throws ObjectFactoryException if there is a problem while reading the
80      * properties of the given object.
81      */
82     public void setParameterFromObject(final Object JavaDoc o) throws ObjectFactoryException {
83         if (!(o instanceof Color JavaDoc)) {
84             throw new ObjectFactoryException("Is no instance of java.awt.Color");
85         }
86         final Color JavaDoc c = (Color JavaDoc) o;
87         setParameter("value", PaintUtilities.colorToString(c));
88     }
89 }
90
Popular Tags