Source for org.jfree.chart.labels.CategoryToolTipGenerator

   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
  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-2004, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * $Id: CategoryToolTipGenerator.java,v 1.3.2.1 2005/10/25 20:49:02 mungady Exp $
  36:  *
  37:  * Changes
  38:  * -------
  39:  * 15-Apr-2004 : Separated tool tip method from CategoryItemLabelGenerator 
  40:  *               interface (DG);
  41:  *
  42:  */
  43: 
  44: package org.jfree.chart.labels;
  45: 
  46: import org.jfree.data.category.CategoryDataset;
  47: 
  48: /**
  49:  * A <i>category tool tip generator</i> is an object that can be assigned to a 
  50:  * {@link org.jfree.chart.renderer.category.CategoryItemRenderer} and that 
  51:  * assumes responsibility for creating text items to be used as tooltips for the
  52:  * items in a {@link org.jfree.chart.plot.CategoryPlot}. 
  53:  * <p>
  54:  * To assist with cloning charts, classes that implement this interface should 
  55:  * also implement the <code>org.jfree.util.PublicCloneable</code> interface (in
  56:  * JCommon).
  57:  */
  58: public interface CategoryToolTipGenerator {
  59: 
  60:     /**
  61:      * Generates the tool tip text for an item in a dataset.  Note: in the 
  62:      * current dataset implementation, each row is a series, and each column 
  63:      * contains values for a particular category.
  64:      *
  65:      * @param dataset  the dataset (<code>null</code> not permitted).
  66:      * @param row  the row index (zero-based).
  67:      * @param column  the column index (zero-based).
  68:      *
  69:      * @return The tooltip text (possibly <code>null</code>).
  70:      */
  71:     public String generateToolTip(CategoryDataset dataset, int row, int column);
  72:     
  73: }