Source for org.jfree.chart.labels.PieToolTipGenerator

   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:  * PieToolTipGenerator.java
  29:  * ------------------------
  30:  * (C) Copyright 2001-2004, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * $Id: PieToolTipGenerator.java,v 1.2.2.1 2005/10/25 20:49:02 mungady Exp $
  36:  *
  37:  * Changes
  38:  * -------
  39:  * 15-Apr-2004 : Version 1, split from PieItemLabelGenerator (DG);
  40:  *
  41:  */
  42: 
  43: package org.jfree.chart.labels;
  44: 
  45: import org.jfree.data.general.PieDataset;
  46: 
  47: /**
  48:  * A tool tip generator that is used by the 
  49:  * {@link org.jfree.chart.plot.PiePlot} class.
  50:  */
  51: public interface PieToolTipGenerator {
  52:     
  53:     /**
  54:      * Generates a tool tip text item for the specified item in the dataset.  
  55:      * This method can return <code>null</code> to indicate that no tool tip 
  56:      * should be displayed for an item.
  57:      *
  58:      * @param dataset  the dataset (<code>null</code> not permitted).
  59:      * @param key  the section key (<code>null</code> not permitted).
  60:      *
  61:      * @return The tool tip text (possibly <code>null</code>).
  62:      */
  63:     public String generateToolTip(PieDataset dataset, Comparable key);
  64:         
  65: }