001/* ================================================
002 * JFreeChart-FX : JavaFX extensions for JFreeChart
003 * ================================================
004 *
005 * (C) Copyright 2017, by Object Refinery Limited and Contributors.
006 *
007 * Project Info:  https://github.com/jfree/jfreechart-fx
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 * OverlayFX.java
029 * --------------
030 * (C) Copyright 2016, 2017, by Object Refinery Limited and Contributors.
031 *
032 * Original Author:  David Gilbert (for Object Refinery Limited);
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.chart.fx.overlay;
038
039import java.awt.Graphics2D;
040import org.jfree.chart.fx.ChartCanvas;
041import org.jfree.chart.panel.Overlay;
042
043/**
044 * An overlay that can be added to a {@link ChartCanvas}.
045 */
046public interface OverlayFX extends Overlay {
047
048    /**
049     * Paints the content of the overlay onto the specified chart canvas.
050     *
051     * @param g2  the graphics target ({@code null} not permitted).
052     * @param chartCanvas  the chart canvas ({@code null} not permitted).
053     */
054    public void paintOverlay(Graphics2D g2, ChartCanvas chartCanvas);
055
056}