Frames | No Frames |
1: /* =========================================================== 2: * JFreeChart : a free chart library for the Java(tm) platform 3: * =========================================================== 4: * 5: * (C) Copyright 2000-2007, 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: * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 25: * in the United States and other countries.] 26: * 27: * ------------------------ 28: * XYZToolTipGenerator.java 29: * ------------------------ 30: * (C) Copyright 2003-2007, by Object Refinery Limited. 31: * 32: * Original Author: David Gilbert (for Object Refinery Limited); 33: * Contributor(s): -; 34: * 35: * Changes 36: * ------- 37: * 03-Feb-2003 : Version 1 (DG); 38: * 25-Feb-2004 : Renamed XYZToolTipGenerator --> XYZItemLabelGenerator (DG); 39: * 11-May-2004 : Reverted to XYZToolTipGenerator (DG); 40: * 41: */ 42: 43: package org.jfree.chart.labels; 44: 45: import org.jfree.data.xy.XYZDataset; 46: 47: /** 48: * Interface for a tooltip generator for plots that use data from an 49: * {@link XYZDataset}. 50: */ 51: public interface XYZToolTipGenerator extends XYToolTipGenerator { 52: 53: /** 54: * Generates a tool tip text item for a particular item within a series. 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: */ 62: public String generateToolTip(XYZDataset dataset, int series, int item); 63: 64: }