001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2020, by Object Refinery Limited 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 * RendererChangeEvent.java
029 * ------------------------
030 * (C) Copyright 2003-2020, by Object Refinery Limited.
031 *
032 * Original Author:  David Gilbert (for Object Refinery Limited);
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.chart.event;
038
039/**
040 * An event that can be forwarded to any {@link RendererChangeListener} to
041 * signal a change to a renderer.
042 */
043public class RendererChangeEvent extends ChartChangeEvent {
044
045    /** The renderer that generated the event. */
046    private Object renderer;
047
048    /**
049     * A flag that indicates whether this event relates to a change in the
050     * series visibility.  If so, the receiver (if it is a plot) may want to
051     * update the axis bounds.
052     *
053     * @since 1.0.13
054     */
055    private boolean seriesVisibilityChanged;
056
057    /**
058     * Creates a new event.
059     *
060     * @param renderer  the renderer that generated the event.
061     */
062    public RendererChangeEvent(Object renderer) {
063        this(renderer, false);
064    }
065
066    /**
067     * Creates a new event.
068     *
069     * @param renderer  the renderer that generated the event.
070     * @param seriesVisibilityChanged  a flag that indicates whether or not
071     *         the event relates to a change in the series visibility flags.
072     */
073    public RendererChangeEvent(Object renderer,
074            boolean seriesVisibilityChanged) {
075        super(renderer);
076        this.renderer = renderer;
077        this.seriesVisibilityChanged = seriesVisibilityChanged;
078    }
079
080    /**
081     * Returns the renderer that generated the event.
082     *
083     * @return The renderer that generated the event.
084     */
085    public Object getRenderer() {
086        return this.renderer;
087    }
088
089    /**
090     * Returns the flag that indicates whether or not the event relates to
091     * a change in series visibility.
092     *
093     * @return A boolean.
094     *
095     * @since 1.0.13
096     */
097    public boolean getSeriesVisibilityChanged() {
098        return this.seriesVisibilityChanged;
099    }
100
101}