Open Source Repository

Home /jfreechart/jfreechart-1.0.9 | Repository Home



org/jfree/chart/renderer/PaintScale.java
/* ===========================================================
 * JFreeChart : a free chart library for the Java(tm) platform
 * ===========================================================
 *
 * (C) Copyright 2000-2007, by Object Refinery Limited and Contributors.
 *
 * Project Info:  http://www.jfree.org/jfreechart/index.html
 *
 * This library is free software; you can redistribute it and/or modify it 
 * under the terms of the GNU Lesser General Public License as published by 
 * the Free Software Foundation; either version 2.1 of the License, or 
 * (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but 
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
 * USA.  
 *
 * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
 * in the United States and other countries.]
 *
 * ---------------
 * PaintScale.java
 * ---------------
 * (C) Copyright 2006, 2007, by Object Refinery Limited.
 *
 * Original Author:  David Gilbert (for Object Refinery Limited);
 * Contributor(s):   -;
 *
 * Changes
 * -------
 * 05-Jul-2006 : Version 1 (DG);
 * 31-Jan-2007 : Added getLowerBound() and getUpperBound() methods (DG);
 
 */

package org.jfree.chart.renderer;

import java.awt.Paint;

import org.jfree.chart.renderer.xy.XYBlockRenderer;

/**
 * A source for <code>Paint</code> instances, used by the 
 {@link XYBlockRenderer}.  
 <br><br>
 * NOTE: Classes that implement this interface should also implement 
 <code>PublicCloneable</code> and <code>Serializable</code>, so 
 * that any renderer (or other object instance) that references an instance of 
 * this interface can still be cloned or serialized.
 
 @since 1.0.4
 */
public interface PaintScale {
    
    /**
     * Returns the lower bound for the scale.
     
     @return The lower bound.
     
     @see #getUpperBound()
     */
    public double getLowerBound();
    
    /**
     * Returns the upper bound for the scale.
     
     @return The upper bound.
     
     @see #getLowerBound()
     */
    public double getUpperBound();
    
    /**
     * Returns a <code>Paint</code> instance for the specified value.
     
     @param value  the value.
     
     @return <code>Paint</code> instance (never <code>null</code>).
     */
    public Paint getPaint(double value);
    
}