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: * CategoryToolTipGenerator.java 29: * ----------------------------- 30: * (C) Copyright 2001-2007, 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 : Separated tool tip method from CategoryItemLabelGenerator 38: * interface (DG); 39: * 40: */ 41: 42: package org.jfree.chart.labels; 43: 44: import org.jfree.data.category.CategoryDataset; 45: 46: /** 47: * A <i>category tool tip generator</i> is an object that can be assigned to a 48: * {@link org.jfree.chart.renderer.category.CategoryItemRenderer} and that 49: * assumes responsibility for creating text items to be used as tooltips for the 50: * items in a {@link org.jfree.chart.plot.CategoryPlot}. 51: * <p> 52: * To assist with cloning charts, classes that implement this interface should 53: * also implement the <code>org.jfree.util.PublicCloneable</code> interface (in 54: * JCommon). 55: */ 56: public interface CategoryToolTipGenerator { 57: 58: /** 59: * Generates the tool tip text for an item in a dataset. Note: in the 60: * current dataset implementation, each row is a series, and each column 61: * contains values for a particular category. 62: * 63: * @param dataset the dataset (<code>null</code> not permitted). 64: * @param row the row index (zero-based). 65: * @param column the column index (zero-based). 66: * 67: * @return The tooltip text (possibly <code>null</code>). 68: */ 69: public String generateToolTip(CategoryDataset dataset, int row, int column); 70: 71: }