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 License 

  20.  * along with this library; if not, write to the Free Software Foundation, 

  21.  * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

  22.  *

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

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

  25.  *

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

  27.  * XYZToolTipGenerator.java

  28.  * ------------------------

  29.  * (C) Copyright 2003-2005, by Object Refinery Limited.

  30.  *

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

  32.  * Contributor(s):   -;

  33.  *

  34.  * $Id: XYZToolTipGenerator.java,v 1.2 2005/03/04 11:52:34 mungady Exp $

  35.  *

  36.  * Changes

  37.  * -------

  38.  * 03-Feb-2003 : Version 1 (DG);

  39.  * 25-Feb-2004 : Renamed XYZToolTipGenerator --> XYZItemLabelGenerator (DG);

  40.  * 11-May-2004 : Reverted to XYZToolTipGenerator (DG);

  41.  *

  42.  */

  43. 

  44. package org.jfree.chart.labels;

  45. 

  46. import org.jfree.data.xy.XYZDataset;

  47. 

  48. /**

  49.  * Interface for a tooltip generator for plots that use data from an 

  50.  * {@link XYZDataset}.

  51.  */

  52. public interface XYZToolTipGenerator extends XYToolTipGenerator {

  53. 

  54.     /**

  55.      * Generates a tool tip text item for a particular item within a series.

  56.      *

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

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

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

  60.      *

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

  62.      */

  63.     public String generateToolTip(XYZDataset dataset, int series, int item);

  64. 

  65. }