    001/* ========================================================================
    002 * JCommon : a free general purpose class library for the Java(tm) platform
    003 * ========================================================================
    004 *
    005 * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
    006 *
    007 * Project Info:  http://www.jfree.org/jcommon/index.html
    008 *
    009 * This library is free software; you can redistribute it and/or modify it
    010 * under the terms of the GNU Lesser General Public License as published by
    011 * the Free Software Foundation; either version 2.1 of the License, or
    012 * (at your option) any later version.
    013 *
    014 * This library is distributed in the hope that it will be useful, but
    015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
    016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
    017 * License for more details.
    018 *
    019 * You should have received a copy of the GNU Lesser General Public
    020 * License along with this library; if not, write to the Free Software
    021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
    022 * USA.
    023 *
    024 * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
    025 * in the United States and other countries.]
    026 *
    027 * ---------------------------------
    028 * BasicStrokeObjectDescription.java
    029 * ---------------------------------
    030 * (C)opyright 2003, 2004, by Thomas Morgner and Contributors.
    031 *
    032 * Original Author:  Thomas Morgner;
    033 * Contributor(s):   David Gilbert (for Object Refinery Limited);
    034 *
    035 * $Id: BasicStrokeObjectDescription.java,v 1.4 2006/01/27 18:53:15 taqua Exp $
    036 *
    037 * Changes (from 19-Feb-2003)
    038 * -------------------------
    039 * 19-Feb-2003 : Added standard header and Javadocs (DG);
    040 * 29-Apr-2003 : Distilled from the JFreeReport project and moved into JCommon
    041 *
    042 */
    043
    044package org.jfree.xml.factory.objects;
    045
    046import java.awt.BasicStroke;
    047
    048/**
    049 * An object-description for a <code>BasicStroke</code> object.
    050 *
    051 * @author Thomas Morgner
    052 */
    053public class BasicStrokeObjectDescription extends AbstractObjectDescription {
    054
    055    /**
    056     * Creates a new object description.
    057     */
    058    public BasicStrokeObjectDescription() {
    059        super(BasicStroke.class);
    060        setParameterDefinition("value", String.class);
    061        setParameterDefinition("width", Float.class);
    062        setParameterDefinition("dashes", Float[].class);
    063    }
    064
    065    /**
    066     * Returns a parameter as a float.
    067     *
    068     * @param param  the parameter name.
    069     *
    070     * @return The float value.
    071     */
    072    private float getFloatParameter(final String param) {
    073        final String p = (String) getParameter(param);
    074        if (p == null) {
    075            return 0;
    076        }
    077        try {
    078            return Float.parseFloat(p);
    079        }
    080        catch (Exception e) {
    081            return 0;
    082        }
    083    }
    084
    085    /**
    086     * Creates a new <code>BasicStroke</code> object based on this description.
    087     *
    088     * @return The <code>BasicStroke</code> object.
    089     */
    090    public Object createObject() {
    091
    092        final float width = getFloatParameter("value");
    093        if (width > 0) {
    094          return new BasicStroke(width);
    095        }
    096
    097        Float realWidth = (Float) getParameter("width");
    098        Float[] dashes = (Float[]) getParameter("dashes");
    099        if (realWidth == null || dashes == null) {
    100            return null;
    101        }
    102        float[] dashesPrimitive = new float[dashes.length];
    103        for (int i = 0; i < dashes.length; i++) {
    104          Float dash = dashes[i];
    105          dashesPrimitive[i] = dash.floatValue();
    106        }
    107        return new BasicStroke(realWidth.floatValue(),
    108                BasicStroke.CAP_SQUARE, BasicStroke.JOIN_MITER,
    109                10.0f, dashesPrimitive, 0.0f);
    110    }
    111
    112    /**
    113     * Sets the parameters for this description to match the supplied object.
    114     *
    115     * @param o  the object (instance of <code>BasicStroke</code> required).
    116     *
    117     * @throws ObjectFactoryException if the supplied object is not an instance of
    118     *         <code>BasicStroke</code>.
    119     */
    120    public void setParameterFromObject(final Object o) throws ObjectFactoryException {
    121        if (!(o instanceof BasicStroke)) {
    122            throw new ObjectFactoryException("Expected object of type BasicStroke");
    123        }
    124        final BasicStroke bs = (BasicStroke) o;
    125        setParameter("value", String.valueOf(bs.getLineWidth()));
    126    }
    127}