Source for org.jfree.chart.plot.DrawingSupplier

   1: /* ===========================================================
   2:  * JFreeChart : a free chart library for the Java(tm) platform
   3:  * ===========================================================
   4:  *
   5:  * (C) Copyright 2000-2007, 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:  * DrawingSupplier.java
  29:  * --------------------
  30:  * (C) Copyright 2003-2007, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * Changes
  36:  * -------
  37:  * 16-Jan-2003 : Version 1 (DG);
  38:  * 17-Jan-2003 : Renamed PaintSupplier --> DrawingSupplier (DG);
  39:  * ------------- JFREECHART 1.0.x ---------------------------------------------
  40:  * 13-Jun-2007 : Added getNextOutlinePaint() method.
  41:  * 
  42:  */
  43: 
  44: package org.jfree.chart.plot;
  45: 
  46: import java.awt.Paint;
  47: import java.awt.Shape;
  48: import java.awt.Stroke;
  49: 
  50: /**
  51:  * A supplier of <code>Paint</code>, <code>Stroke</code> and <code>Shape</code>
  52:  * objects for use by plots and renderers.  By providing a central place for
  53:  * obtaining these items, we can ensure that duplication is avoided.
  54:  * <p>
  55:  * To support the cloning of charts, classes that implement this interface 
  56:  * should also implement <code>PublicCloneable</code>.
  57:  */
  58: public interface DrawingSupplier {
  59: 
  60:     /**
  61:      * Returns the next paint in a sequence maintained by the supplier.
  62:      *
  63:      * @return The paint.
  64:      */
  65:     public Paint getNextPaint();
  66: 
  67:     /**
  68:      * Returns the next outline paint in a sequence maintained by the supplier.
  69:      *
  70:      * @return The paint.
  71:      */
  72:     public Paint getNextOutlinePaint();
  73: 
  74:     /**
  75:      * Returns the next fill paint in a sequence maintained by the supplier.
  76:      *
  77:      * @return The paint.
  78:      * 
  79:      * @since 1.0.6
  80:      */
  81:     public Paint getNextFillPaint();
  82: 
  83:     /**
  84:      * Returns the next <code>Stroke</code> object in a sequence maintained by
  85:      * the supplier.
  86:      *
  87:      * @return The stroke.
  88:      */
  89:     public Stroke getNextStroke();
  90: 
  91:     /**
  92:      * Returns the next <code>Stroke</code> object in a sequence maintained by
  93:      * the supplier.
  94:      *
  95:      * @return The stroke.
  96:      */
  97:     public Stroke getNextOutlineStroke();
  98: 
  99:     /**
 100:      * Returns the next <code>Shape</code> object in a sequence maintained by
 101:      * the supplier.
 102:      *
 103:      * @return The shape.
 104:      */
 105:     public Shape getNextShape();
 106: 
 107: }