01: /* ===========================================================
02: * JFreeChart : a free chart library for the Java(tm) platform
03: * ===========================================================
04: *
05: * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
06: *
07: * Project Info: http://www.jfree.org/jfreechart/index.html
08: *
09: * 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: * XYToolTipGenerator.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: XYToolTipGenerator.java,v 1.2.2.1 2005/10/25 20:49:02 mungady Exp $
36: *
37: * Changes
38: * -------
39: * 15-Apr-2004 : Extracted the generateToolTip() method from the
40: * XYItemLabelGenerator interface and put it into this new
41: * interface (DG);
42: *
43: */
44:
45: package org.jfree.chart.labels;
46:
47: import org.jfree.data.xy.XYDataset;
48:
49: /**
50: * Interface for a tooltip generator for plots that use data from an
51: * {@link XYDataset}.
52: */
53: public interface XYToolTipGenerator {
54:
55: /**
56: * Generates the tooltip text for the specified item.
57: *
58: * @param dataset the dataset (<code>null</code> not permitted).
59: * @param series the series index (zero-based).
60: * @param item the item index (zero-based).
61: *
62: * @return The tooltip text (possibly <code>null</code>).
63: */
64: public String generateToolTip(XYDataset dataset, int series,
65: int item);
66:
67: }
|