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