001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2013, 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 * ChartEditorManager.java
029 * -----------------------
030 * (C) Copyright 2005-2013, by Object Refinery Limited.
031 *
032 * Original Author:  David Gilbert (for Object Refinery Limited);
033 * Contributor(s):   ;
034 *
035 * Changes
036 * -------
037 * 24-Nov-2005 : Version 1 (DG);
038 * 03-Jul-2013 : Use ParamChecks (DG);
039 * 
040 */
041
042package org.jfree.chart.editor;
043
044import org.jfree.chart.JFreeChart;
045import org.jfree.chart.util.ParamChecks;
046
047/**
048 * The central point for obtaining {@link ChartEditor} instances for editing
049 * charts.  Right now, the API is minimal - the plan is to extend this class
050 * to provide customisation options for chart editors (for example, make some
051 * editor items read-only).
052 */
053public class ChartEditorManager {
054
055    /** This factory creates new {@link ChartEditor} instances as required. */
056    static ChartEditorFactory factory = new DefaultChartEditorFactory();
057
058    /**
059     * Private constructor prevents instantiation.
060     */
061    private ChartEditorManager() {
062        // nothing to do
063    }
064
065    /**
066     * Returns the current factory.
067     *
068     * @return The current factory (never <code>null</code>).
069     */
070    public static ChartEditorFactory getChartEditorFactory() {
071        return factory;
072    }
073
074    /**
075     * Sets the chart editor factory.
076     *
077     * @param f  the new factory (<code>null</code> not permitted).
078     */
079    public static void setChartEditorFactory(ChartEditorFactory f) {
080        ParamChecks.nullNotPermitted(f, "f");
081        factory = f;
082    }
083
084    /**
085     * Returns a component that can be used to edit the given chart.
086     *
087     * @param chart  the chart.
088     *
089     * @return The chart editor.
090     */
091    public static ChartEditor getChartEditor(JFreeChart chart) {
092        return factory.createEditor(chart);
093    }
094}