1. /* ===========================================================

  2.  * JFreeChart : a free chart library for the Java(tm) platform

  3.  * ===========================================================

  4.  *

  5.  * (C) Copyright 2000-2004, 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 under the terms

  10.  * of the GNU Lesser General Public License as published by the Free Software Foundation;

  11.  * either version 2.1 of the License, or (at your option) any later version.

  12.  *

  13.  * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;

  14.  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

  15.  * See the GNU Lesser General Public License for more details.

  16.  *

  17.  * You should have received a copy of the GNU Lesser General Public License along with this

  18.  * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,

  19.  * Boston, MA 02111-1307, USA.

  20.  *

  21.  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 

  22.  * in the United States and other countries.]

  23.  *

  24.  * -----------------------

  25.  * XYToolTipGenerator.java

  26.  * -----------------------

  27.  * (C) Copyright 2001-2004, by Object Refinery Limited.

  28.  *

  29.  * Original Author:  David Gilbert (for Object Refinery Limited);

  30.  * Contributor(s):   -;

  31.  *

  32.  * $Id: XYToolTipGenerator.java,v 1.1 2004/08/31 14:36:24 mungady Exp $

  33.  *

  34.  * Changes

  35.  * -------

  36.  * 15-Apr-2004 : Extracted the generateToolTip() method from the XYItemLabelGenerator interface and

  37.  *               put it into this new interface (DG);

  38.  *

  39.  */

  40. 

  41. package org.jfree.chart.labels;

  42. 

  43. import org.jfree.data.xy.XYDataset;

  44. 

  45. /**

  46.  * Interface for a tooltip generator for plots that use data from an {@link XYDataset}.

  47.  */

  48. public interface XYToolTipGenerator {

  49. 

  50.     /**

  51.      * Generates the tooltip text for the specified item.

  52.      *

  53.      * @param dataset  the dataset (<code>null</code> not permitted).

  54.      * @param series  the series index (zero-based).

  55.      * @param item  the item index (zero-based).

  56.      *

  57.      * @return The tooltip text (possibly <code>null</code>).

  58.      */

  59.     public String generateToolTip(XYDataset dataset, int series, int item);

  60. 

  61. }