001 /* =========================================================== 002 * JFreeChart : a free chart library for the Java(tm) platform 003 * =========================================================== 004 * 005 * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors. 006 * 007 * Project Info: http://www.jfree.org/jfreechart/index.html 008 * 009 * This library is free software; you can redistribute it and/or modify it 010 * under the terms of the GNU Lesser General Public License as published by 011 * the Free Software Foundation; either version 2.1 of the License, or 012 * (at your option) any later version. 013 * 014 * This library is distributed in the hope that it will be useful, but 015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 017 * License for more details. 018 * 019 * You should have received a copy of the GNU Lesser General Public 020 * License along with this library; if not, write to the Free Software 021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 022 * USA. 023 * 024 * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 025 * in the United States and other countries.] 026 * 027 * ------------------------ 028 * PieToolTipGenerator.java 029 * ------------------------ 030 * (C) Copyright 2001-2004, by Object Refinery Limited. 031 * 032 * Original Author: David Gilbert (for Object Refinery Limited); 033 * Contributor(s): -; 034 * 035 * $Id: PieToolTipGenerator.java,v 1.2.2.1 2005/10/25 20:49:02 mungady Exp $ 036 * 037 * Changes 038 * ------- 039 * 15-Apr-2004 : Version 1, split from PieItemLabelGenerator (DG); 040 * 041 */ 042 043 package org.jfree.chart.labels; 044 045 import org.jfree.data.general.PieDataset; 046 047 /** 048 * A tool tip generator that is used by the 049 * {@link org.jfree.chart.plot.PiePlot} class. 050 */ 051 public interface PieToolTipGenerator { 052 053 /** 054 * Generates a tool tip text item for the specified item in the dataset. 055 * This method can return <code>null</code> to indicate that no tool tip 056 * should be displayed for an item. 057 * 058 * @param dataset the dataset (<code>null</code> not permitted). 059 * @param key the section key (<code>null</code> not permitted). 060 * 061 * @return The tool tip text (possibly <code>null</code>). 062 */ 063 public String generateToolTip(PieDataset dataset, Comparable key); 064 065 }