1 /* =========================================================== 2 * JFreeChart : a free chart library for the Java(tm) platform 3 * =========================================================== 4 * 5 * (C) Copyright 2000-2013, 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 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 25 * Other names may be trademarks of their respective owners.] 26 * 27 * ----------------------- 28 * XYToolTipGenerator.java 29 * ----------------------- 30 * (C) Copyright 2001-2008, by Object Refinery Limited. 31 * 32 * Original Author: David Gilbert (for Object Refinery Limited); 33 * Contributor(s): -; 34 * 35 * Changes 36 * ------- 37 * 15-Apr-2004 : Extracted the generateToolTip() method from the 38 * XYItemLabelGenerator interface and put it into this new 39 * interface (DG); 40 * 41 */ 42 43 package org.jfree.chart.labels; 44 45 import org.jfree.data.xy.XYDataset; 46 47 /** 48 * Interface for a tooltip generator for plots that use data from an 49 * {@link XYDataset}. 50 */ 51 public interface XYToolTipGenerator { 52 53 /** 54 * Generates the tooltip text for the specified item. 55 * 56 * @param dataset the dataset (<code>null</code> not permitted). 57 * @param series the series index (zero-based). 58 * @param item the item index (zero-based). 59 * 60 * @return The tooltip text (possibly <code>null</code>). 61 */ generateToolTip(XYDataset dataset, int series, int item)62 public String generateToolTip(XYDataset dataset, int series, int item); 63 64 } 65