Source for org.jfree.chart.renderer.PaintScale

   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:  * PaintScale.java
  29:  * ---------------
  30:  * (C) Copyright 2006, 2007, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * $Id: PaintScale.java,v 1.1.2.2 2007/01/31 14:31:24 mungady Exp $
  36:  *
  37:  * Changes
  38:  * -------
  39:  * 05-Jul-2006 : Version 1 (DG);
  40:  * 31-Jan-2007 : Added getLowerBound() and getUpperBound() methods (DG);
  41:  * 
  42:  */
  43: 
  44: package org.jfree.chart.renderer;
  45: 
  46: import java.awt.Paint;
  47: 
  48: import org.jfree.chart.renderer.xy.XYBlockRenderer;
  49: 
  50: /**
  51:  * A source for <code>Paint</code> instances, used by the 
  52:  * {@link XYBlockRenderer}.  
  53:  * <br><br>
  54:  * NOTE: Classes that implement this interface should also implement 
  55:  * <code>PublicCloneable</code> and <code>Serializable</code>, so 
  56:  * that any renderer (or other object instance) that references an instance of 
  57:  * this interface can still be cloned or serialized.
  58:  * 
  59:  * @since 1.0.4
  60:  */
  61: public interface PaintScale {
  62:     
  63:     /**
  64:      * Returns the lower bound for the scale.
  65:      * 
  66:      * @return The lower bound.
  67:      * 
  68:      * @see #getUpperBound()
  69:      */
  70:     public double getLowerBound();
  71:     
  72:     /**
  73:      * Returns the upper bound for the scale.
  74:      * 
  75:      * @return The upper bound.
  76:      * 
  77:      * @see #getLowerBound()
  78:      */
  79:     public double getUpperBound();
  80:     
  81:     /**
  82:      * Returns a <code>Paint</code> instance for the specified value.
  83:      * 
  84:      * @param value  the value.
  85:      * 
  86:      * @return A <code>Paint</code> instance (never <code>null</code>).
  87:      */
  88:     public Paint getPaint(double value);
  89:     
  90: }