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 * ChartFrame.java
029 * ---------------
030 * (C) Copyright 2001-present, by David Gilbert and Contributors.
031 *
032 * Original Author:  David Gilbert;
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.chart;
038
039import javax.swing.JFrame;
040import javax.swing.JScrollPane;
041import javax.swing.WindowConstants;
042
043/**
044 * A frame for displaying a chart.
045 */
046public class ChartFrame extends JFrame {
047
048    /** The chart panel. */
049    private final ChartPanel chartPanel;
050
051    /**
052     * Constructs a frame for a chart.
053     *
054     * @param title  the frame title.
055     * @param chart  the chart.
056     */
057    public ChartFrame(String title, JFreeChart chart) {
058        this(title, chart, false);
059    }
060
061    /**
062     * Constructs a frame for a chart.
063     *
064     * @param title  the frame title.
065     * @param chart  the chart.
066     * @param scrollPane  if {@code true}, put the Chart(Panel) into a
067     *                    JScrollPane.
068     */
069    public ChartFrame(String title, JFreeChart chart, boolean scrollPane) {
070        super(title);
071        setDefaultCloseOperation(WindowConstants.DISPOSE_ON_CLOSE);
072        this.chartPanel = new ChartPanel(chart);
073        if (scrollPane) {
074            setContentPane(new JScrollPane(this.chartPanel));
075        }
076        else {
077            setContentPane(this.chartPanel);
078        }
079    }
080
081    /**
082     * Returns the chart panel for the frame.
083     *
084     * @return The chart panel.
085     */
086    public ChartPanel getChartPanel() {
087        return this.chartPanel;
088    }
089
090}