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 * StandardPieToolTipGenerator.java
029 * --------------------------------
030 * (C) Copyright 2001-2006, by Object Refinery Limited.
031 *
032 * Original Author: David Gilbert (for Object Refinery Limited);
033 * Contributor(s): Richard Atkinson;
034 * Andreas Schroeder;
035 *
036 * $Id: StandardPieToolTipGenerator.java,v 1.1.2.3 2006/05/03 10:46:36 mungady Exp $
037 *
038 * Changes
039 * -------
040 * 13-Dec-2001 : Version 1 (DG);
041 * 16-Jan-2002 : Completed Javadocs (DG);
042 * 29-Aug-2002 : Changed to format numbers using default locale (RA);
043 * 26-Sep-2002 : Fixed errors reported by Checkstyle (DG);
044 * 30-Oct-2002 : Changed PieToolTipGenerator interface (DG);
045 * 21-Mar-2003 : Implemented Serializable (DG);
046 * 13-Aug-2003 : Implemented Cloneable (DG);
047 * 19-Aug-2003 : Renamed StandardPieToolTipGenerator -->
048 * StandardPieItemLabelGenerator (DG);
049 * 10-Mar-2004 : Modified to use MessageFormat class (DG);
050 * 31-Mar-2004 : Added javadocs for the MessageFormat usage (AS);
051 * 15-Apr-2004 : Split PieItemLabelGenerator interface into
052 * PieSectionLabelGenerator and PieToolTipGenerator (DG);
053 * 25-Nov-2004 : Moved some code into abstract super class (DG);
054 * 29-Jul-2005 : Removed implementation of PieSectionLabelGenerator
055 * interface (DG);
056 *
057 */
058
059 package org.jfree.chart.labels;
060
061 import java.io.Serializable;
062 import java.text.NumberFormat;
063
064 import org.jfree.data.general.PieDataset;
065 import org.jfree.util.PublicCloneable;
066
067 /**
068 * A standard item label generator for plots that use data from a
069 * {@link PieDataset}.
070 * <p>
071 * For the label format, use {0} where the pie section key should be inserted,
072 * {1} for the absolute section value and {2} for the percent amount of the pie
073 * section, e.g. <code>"{0} = {1} ({2})"</code> will display as
074 * <code>apple = 120 (5%)</code>.
075 */
076 public class StandardPieToolTipGenerator extends AbstractPieItemLabelGenerator
077 implements PieToolTipGenerator,
078 Cloneable,
079 PublicCloneable,
080 Serializable {
081
082 /** For serialization. */
083 private static final long serialVersionUID = 2995304200445733779L;
084
085 /** The default tooltip format. */
086 public static final String DEFAULT_TOOLTIP_FORMAT = "{0}: ({1}, {2})";
087
088 /** The default section label format. */
089 public static final String DEFAULT_SECTION_LABEL_FORMAT = "{0} = {1}";
090
091 /**
092 * Creates an item label generator using default number formatters.
093 */
094 public StandardPieToolTipGenerator() {
095 this(DEFAULT_SECTION_LABEL_FORMAT, NumberFormat.getNumberInstance(),
096 NumberFormat.getPercentInstance());
097 }
098
099 /**
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 }