jfreechart example source code file (BlockParams.java)

This example jfreechart source code file (BlockParams.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - jfreechart tags/keywords

blockparams, blockparams, entityblockparams, entityblockparams

The jfreechart BlockParams.java source code

/* ===========================================================
 * JFreeChart : a free chart library for the Java(tm) platform
 * ===========================================================
 *
 * (C) Copyright 2000-2008, by Object Refinery Limited and Contributors.
 *
 * Project Info:  http://www.jfree.org/jfreechart/index.html
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
 * USA.
 *
 * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
 * in the United States and other countries.]
 *
 * ----------------
 * BlockParams.java
 * ----------------
 * (C) Copyright 2005-2008, by Object Refinery Limited.
 *
 * Original Author:  David Gilbert (for Object Refinery Limited);
 * Contributor(s):   -;
 *
 * Changes:
 * --------
 * 19-Apr-2005 : Version 1 (DG);
 *
 */

package org.jfree.chart.block;

/**
 * A standard parameter object that can be passed to the draw() method defined
 * by the {@link Block} class.
 */
public class BlockParams implements EntityBlockParams {

    /**
     * A flag that controls whether or not the block should generate and
     * return chart entities for the items it draws.
     */
    private boolean generateEntities;

    /**
     * The x-translation (used to enable chart entities to use global
     * coordinates rather than coordinates that are local to the container
     * they are within).
     */
    private double translateX;

    /**
     * The y-translation (used to enable chart entities to use global
     * coordinates rather than coordinates that are local to the container
     * they are within).
     */
    private double translateY;

    /**
     * Creates a new instance.
     */
    public BlockParams() {
        this.translateX = 0.0;
        this.translateY = 0.0;
        this.generateEntities = false;
    }

    /**
     * Returns the flag that controls whether or not chart entities are
     * generated.
     *
     * @return A boolean.
     */
    public boolean getGenerateEntities() {
        return this.generateEntities;
    }

    /**
     * Sets the flag that controls whether or not chart entities are generated.
     *
     * @param generate  the flag.
     */
    public void setGenerateEntities(boolean generate) {
        this.generateEntities = generate;
    }

    /**
     * Returns the translation required to convert local x-coordinates back to
     * the coordinate space of the container.
     *
     * @return The x-translation amount.
     */
    public double getTranslateX() {
        return this.translateX;
    }

    /**
     * Sets the translation required to convert local x-coordinates into the
     * coordinate space of the container.
     *
     * @param x  the x-translation amount.
     */
    public void setTranslateX(double x) {
        this.translateX = x;
    }

    /**
     * Returns the translation required to convert local y-coordinates back to
     * the coordinate space of the container.
     *
     * @return The y-translation amount.
     */
    public double getTranslateY() {
        return this.translateY;
    }

    /**
     * Sets the translation required to convert local y-coordinates into the
     * coordinate space of the container.
     *
     * @param y  the y-translation amount.
     */
    public void setTranslateY(double y) {
        this.translateY = y;
    }

}