| Frames | No Frames |
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: * StandardPieToolTipGenerator.java 29: * -------------------------------- 30: * (C) Copyright 2001-2006, by Object Refinery Limited. 31: * 32: * Original Author: David Gilbert (for Object Refinery Limited); 33: * Contributor(s): Richard Atkinson; 34: * Andreas Schroeder; 35: * 36: * $Id: StandardPieToolTipGenerator.java,v 1.1.2.3 2006/05/03 10:46:36 mungady Exp $ 37: * 38: * Changes 39: * ------- 40: * 13-Dec-2001 : Version 1 (DG); 41: * 16-Jan-2002 : Completed Javadocs (DG); 42: * 29-Aug-2002 : Changed to format numbers using default locale (RA); 43: * 26-Sep-2002 : Fixed errors reported by Checkstyle (DG); 44: * 30-Oct-2002 : Changed PieToolTipGenerator interface (DG); 45: * 21-Mar-2003 : Implemented Serializable (DG); 46: * 13-Aug-2003 : Implemented Cloneable (DG); 47: * 19-Aug-2003 : Renamed StandardPieToolTipGenerator --> 48: * StandardPieItemLabelGenerator (DG); 49: * 10-Mar-2004 : Modified to use MessageFormat class (DG); 50: * 31-Mar-2004 : Added javadocs for the MessageFormat usage (AS); 51: * 15-Apr-2004 : Split PieItemLabelGenerator interface into 52: * PieSectionLabelGenerator and PieToolTipGenerator (DG); 53: * 25-Nov-2004 : Moved some code into abstract super class (DG); 54: * 29-Jul-2005 : Removed implementation of PieSectionLabelGenerator 55: * interface (DG); 56: * 57: */ 58: 59: package org.jfree.chart.labels; 60: 61: import java.io.Serializable; 62: import java.text.NumberFormat; 63: 64: import org.jfree.data.general.PieDataset; 65: import org.jfree.util.PublicCloneable; 66: 67: /** 68: * A standard item label generator for plots that use data from a 69: * {@link PieDataset}. 70: * <p> 71: * For the label format, use {0} where the pie section key should be inserted, 72: * {1} for the absolute section value and {2} for the percent amount of the pie 73: * section, e.g. <code>"{0} = {1} ({2})"</code> will display as 74: * <code>apple = 120 (5%)</code>. 75: */ 76: public class StandardPieToolTipGenerator extends AbstractPieItemLabelGenerator 77: implements PieToolTipGenerator, 78: Cloneable, 79: PublicCloneable, 80: Serializable { 81: 82: /** For serialization. */ 83: private static final long serialVersionUID = 2995304200445733779L; 84: 85: /** The default tooltip format. */ 86: public static final String DEFAULT_TOOLTIP_FORMAT = "{0}: ({1}, {2})"; 87: 88: /** The default section label format. */ 89: public static final String DEFAULT_SECTION_LABEL_FORMAT = "{0} = {1}"; 90: 91: /** 92: * Creates an item label generator using default number formatters. 93: */ 94: public StandardPieToolTipGenerator() { 95: this(DEFAULT_SECTION_LABEL_FORMAT, NumberFormat.getNumberInstance(), 96: NumberFormat.getPercentInstance()); 97: } 98: 99: /** 100: * Creates an item label generator. 101: * 102: * @param labelFormat the label format. 103: */ 104: public StandardPieToolTipGenerator(String labelFormat) { 105: this(labelFormat, NumberFormat.getNumberInstance(), 106: NumberFormat.getPercentInstance()); 107: } 108: 109: /** 110: * Creates an item label generator using the specified number formatters. 111: * 112: * @param labelFormat the label format string (<code>null</code> not 113: * permitted). 114: * @param numberFormat the format object for the values (<code>null</code> 115: * not permitted). 116: * @param percentFormat the format object for the percentages 117: * (<code>null</code> not permitted). 118: */ 119: public StandardPieToolTipGenerator(String labelFormat, 120: NumberFormat numberFormat, NumberFormat percentFormat) { 121: super(labelFormat, numberFormat, percentFormat); 122: } 123: 124: /** 125: * Generates a tool tip text item for one section in a pie chart. 126: * 127: * @param dataset the dataset (<code>null</code> not permitted). 128: * @param key the section key (<code>null</code> not permitted). 129: * 130: * @return The tool tip text (possibly <code>null</code>). 131: */ 132: public String generateToolTip(PieDataset dataset, Comparable key) { 133: return generateSectionLabel(dataset, key); 134: } 135: 136: /** 137: * Returns an independent copy of the generator. 138: * 139: * @return A clone. 140: * 141: * @throws CloneNotSupportedException should not happen. 142: */ 143: public Object clone() throws CloneNotSupportedException { 144: return super.clone(); 145: } 146: 147: }