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: * CategoryItemLabelGenerator.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: * 13-Dec-2001 : Version 1 (DG); 38: * 16-Jan-2002 : Completed Javadocs (DG); 39: * 26-Sep-2002 : Fixed errors reported by Checkstyle (DG); 40: * 24-Oct-2002 : Method now specifies category index (DG); 41: * 05-Nov-2002 : Replaced reference to CategoryDataset with TableDataset (DG); 42: * 21-Jan-2003 : TableDataset merged with CategoryDataset (DG); 43: * 10-Apr-2003 : Changed CategoryDataset --> KeyedValues2DDataset (DG); 44: * 01-May-2003 : Added generateValueLabel() method (with a plan to renaming 45: * this interface to reflect its more general use) (DG); 46: * 09-Jun-2003 : Renamed CategoryToolTipGenerator 47: * --> CategoryItemLabelGenerator (DG); 48: * 13-Aug-2003 : Added clone() method (DG); 49: * 12-Feb-2004 : Removed clone() method (DG); 50: * 15-Apr-2004 : Moved generateToolTip() method into CategoryToolTipGenerator 51: * interface (DG); 52: * 11-May-2004 : Renamed CategoryItemLabelGenerator 53: * --> CategoryLabelGenerator (DG); 54: * 31-Jan-2005 : Added generateRowLabel() and generateColumnLabel() 55: * methods (DG); 56: * 20-Apr-2005 : Reverted name change of 11-May-2004 (DG); 57: * 58: */ 59: 60: package org.jfree.chart.labels; 61: 62: import org.jfree.data.category.CategoryDataset; 63: 64: /** 65: * A <i>category item label generator</i> is an object that can be assigned to a 66: * {@link org.jfree.chart.renderer.category.CategoryItemRenderer} and that 67: * assumes responsibility for creating text items to be used as labels for the 68: * items in a {@link org.jfree.chart.plot.CategoryPlot}. 69: * <p> 70: * To assist with cloning charts, classes that implement this interface should 71: * also implement the {@link org.jfree.util.PublicCloneable} interface. 72: */ 73: public interface CategoryItemLabelGenerator { 74: 75: /** 76: * Generates a label for the specified row. 77: * 78: * @param dataset the dataset (<code>null</code> not permitted). 79: * @param row the row index (zero-based). 80: * 81: * @return The label. 82: */ 83: public String generateRowLabel(CategoryDataset dataset, int row); 84: 85: /** 86: * Generates a label for the specified row. 87: * 88: * @param dataset the dataset (<code>null</code> not permitted). 89: * @param column the column index (zero-based). 90: * 91: * @return The label. 92: */ 93: public String generateColumnLabel(CategoryDataset dataset, int column); 94: 95: /** 96: * Generates a label for the specified item. The label is typically a 97: * formatted version of the data value, but any text can be used. 98: * 99: * @param dataset the dataset (<code>null</code> not permitted). 100: * @param row the row index (zero-based). 101: * @param column the column index (zero-based). 102: * 103: * @return The label (possibly <code>null</code>). 104: */ 105: public String generateLabel(CategoryDataset dataset, int row, int column); 106: 107: }