KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jfree > chart > labels > ContourToolTipGenerator


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  * ContourToolTipGenerator.java
28  * ----------------------------
29  * (C) Copyright 2002, 2003, by David M. O'Donnell and Contributors.
30  *
31  * Original Author: David M. O'Donnell;
32  * Contributor(s): David Gilbert (for Object Refinery Limited);
33  *
34  * $Id: ContourToolTipGenerator.java,v 1.2 2005/03/29 12:54:54 mungady Exp $
35  *
36  * Changes
37  * -------
38  * 23-Jan-2003 : Added standard header (DG);
39  *
40  */
41
42 package org.jfree.chart.labels;
43
44 import org.jfree.data.contour.ContourDataset;
45
46 /**
47  * Interface for a tooltip generator for plots that use data from a
48  * {@link ContourDataset}.
49  *
50  * @author David M. O'Donnell
51  */
52 public interface ContourToolTipGenerator {
53
54     /**
55      * Generates a tooltip text item for a particular item within a series.
56      *
57      * @param dataset the dataset.
58      * @param item the item index (zero-based).
59      *
60      * @return The tooltip text.
61      */
62     public String JavaDoc generateToolTip(ContourDataset dataset, int item);
63
64 }
65
Popular Tags