Source for org.jfree.chart.editor.ChartEditorManager

   1: /* ===========================================================
   2:  * JFreeChart : a free chart library for the Java(tm) platform
   3:  * ===========================================================
   4:  *
   5:  * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
   6:  *
   7:  * Project Info:  http://www.jfree.org/jfreechart/index.html
   8:  *
   9:  * This library is free software; you can redistribute it and/or modify it 
  10:  * under the terms of the GNU Lesser General Public License as published by 
  11:  * the Free Software Foundation; either version 2.1 of the License, or 
  12:  * (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but 
  15:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
  16:  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
  17:  * License for more details.
  18:  *
  19:  * You should have received a copy of the GNU Lesser General Public
  20:  * License along with this library; if not, write to the Free Software
  21:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
  22:  * USA.  
  23:  *
  24:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
  25:  * in the United States and other countries.]
  26:  *
  27:  * -----------------------
  28:  * ChartEditorManager.java
  29:  * -----------------------
  30:  * (C) Copyright 2005, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   ;
  34:  *
  35:  * $Id: ChartEditorManager.java,v 1.1.2.2 2005/11/28 15:19:32 mungady Exp $
  36:  *
  37:  * Changes
  38:  * -------
  39:  * 24-Nov-2005 : Version 1 (DG);
  40:  *
  41:  */
  42: 
  43: package org.jfree.chart.editor;
  44: 
  45: import org.jfree.chart.JFreeChart;
  46: 
  47: /**
  48:  * The central point for obtaining {@link ChartEditor} instances for editing
  49:  * charts.  Right now, the API is minimal - the plan is to extend this class 
  50:  * to provide customisation options for chart editors (for example, make some 
  51:  * editor items read-only).  
  52:  */
  53: public class ChartEditorManager {
  54: 
  55:     /** This factory creates new {@link ChartEditor} instances as required. */
  56:     static ChartEditorFactory factory = new DefaultChartEditorFactory();
  57:     
  58:     /**
  59:      * Private constructor prevents instantiation.
  60:      */
  61:     private ChartEditorManager() {
  62:         // nothing to do   
  63:     }
  64:     
  65:     /**
  66:      * Returns the current factory.
  67:      * 
  68:      * @return The current factory (never <code>null</code>).
  69:      */
  70:     public static ChartEditorFactory getChartEditorFactory() {
  71:         return factory;
  72:     }
  73:     
  74:     /**
  75:      * Sets the chart editor factory.
  76:      * 
  77:      * @param f  the new factory (<code>null</code> not permitted).
  78:      */
  79:     public static void setChartEditorFactory(ChartEditorFactory f) {
  80:         if (f == null) {
  81:             throw new IllegalArgumentException("Null 'f' argument.");
  82:         }
  83:         factory = f;
  84:     }
  85:     
  86:     /**
  87:      * Returns a component that can be used to edit the given chart.
  88:      * 
  89:      * @param chart  the chart.
  90:      * 
  91:      * @return The chart editor.
  92:      */    
  93:     public static ChartEditor getChartEditor(JFreeChart chart) {
  94:         return factory.createEditor(chart);
  95:     }
  96: }