001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-present, by David Gilbert and Contributors.
006 *
007 * Project Info:  http://www.jfree.org/jfreechart/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 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
025 * Other names may be trademarks of their respective owners.]
026 *
027 * ---------------
028 * BarPainter.java
029 * ---------------
030 * (C) Copyright 2008-present, by David Gilbert.
031 *
032 * Original Author:  David Gilbert;
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.chart.renderer.category;
038
039import java.awt.Graphics2D;
040import java.awt.geom.RectangularShape;
041import org.jfree.chart.ui.RectangleEdge;
042
043/**
044 * The interface for plugin painter for the {@link BarRenderer} class.  When
045 * developing a class that implements this interface, bear in mind the
046 * following:
047 * <ul>
048 * <li>the {@code equals(Object)} method should be overridden;</li>
049 * <li>instances of the class should be immutable OR implement the
050 *     {@code PublicCloneable} interface, so that a renderer using the
051 *     painter can be cloned reliably;
052 * <li>the class should be {@code Serializable}, otherwise chart
053 *     serialization will not be supported.</li>
054 * </ul>
055 */
056public interface BarPainter {
057
058    /**
059     * Paints a single bar on behalf of a renderer.
060     *
061     * @param g2  the graphics target.
062     * @param renderer  the renderer.
063     * @param row  the row index for the item.
064     * @param column  the column index for the item.
065     * @param bar  the bounds for the bar.
066     * @param base  the base of the bar.
067     */
068    void paintBar(Graphics2D g2, BarRenderer renderer,
069                  int row, int column, RectangularShape bar, RectangleEdge base);
070
071    /**
072     * Paints the shadow for a single bar on behalf of a renderer.
073     *
074     * @param g2  the graphics target.
075     * @param renderer  the renderer.
076     * @param row  the row index for the item.
077     * @param column  the column index for the item.
078     * @param bar  the bounds for the bar.
079     * @param base  the base of the bar.
080     * @param pegShadow  peg the shadow to the base of the bar?
081     */
082    void paintBarShadow(Graphics2D g2, BarRenderer renderer,
083                        int row, int column, RectangularShape bar, RectangleEdge base,
084                        boolean pegShadow);
085
086}