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: * StandardXYToolTipGenerator.java 29: * ------------------------------- 30: * (C) Copyright 2004-2007, by Object Refinery Limited. 31: * 32: * Original Author: David Gilbert (for Object Refinery Limited); 33: * Contributor(s): -; 34: * 35: * Changes 36: * ------- 37: * 12-May-2004 : Version 1 (DG); 38: * ------------- JFREECHART 1.0.x --------------------------------------------- 39: * 25-Jan-2007 : Added new constructor - see bug 1624067 (DG); 40: * 41: */ 42: 43: package org.jfree.chart.labels; 44: 45: import java.io.Serializable; 46: import java.text.DateFormat; 47: import java.text.NumberFormat; 48: 49: import org.jfree.data.xy.XYDataset; 50: import org.jfree.util.PublicCloneable; 51: 52: /** 53: * A standard tool tip generator for use with an 54: * {@link org.jfree.chart.renderer.xy.XYItemRenderer}. 55: */ 56: public class StandardXYToolTipGenerator extends AbstractXYItemLabelGenerator 57: implements XYToolTipGenerator, 58: Cloneable, 59: PublicCloneable, 60: Serializable { 61: 62: /** For serialization. */ 63: private static final long serialVersionUID = -3564164459039540784L; 64: 65: /** The default tooltip format. */ 66: public static final String DEFAULT_TOOL_TIP_FORMAT = "{0}: ({1}, {2})"; 67: 68: /** 69: * Returns a tool tip generator that formats the x-values as dates and the 70: * y-values as numbers. 71: * 72: * @return A tool tip generator (never <code>null</code>). 73: */ 74: public static StandardXYToolTipGenerator getTimeSeriesInstance() { 75: return new StandardXYToolTipGenerator(DEFAULT_TOOL_TIP_FORMAT, 76: DateFormat.getInstance(), NumberFormat.getInstance()); 77: } 78: 79: /** 80: * Creates a tool tip generator using default number formatters. 81: */ 82: public StandardXYToolTipGenerator() { 83: this(DEFAULT_TOOL_TIP_FORMAT, NumberFormat.getNumberInstance(), 84: NumberFormat.getNumberInstance()); 85: } 86: 87: /** 88: * Creates a tool tip generator using the specified number formatters. 89: * 90: * @param formatString the item label format string (<code>null</code> not 91: * permitted). 92: * @param xFormat the format object for the x values (<code>null</code> 93: * not permitted). 94: * @param yFormat the format object for the y values (<code>null</code> 95: * not permitted). 96: */ 97: public StandardXYToolTipGenerator(String formatString, 98: NumberFormat xFormat, NumberFormat yFormat) { 99: 100: super(formatString, xFormat, yFormat); 101: 102: } 103: 104: /** 105: * Creates a tool tip generator using the specified number formatters. 106: * 107: * @param formatString the label format string (<code>null</code> not 108: * permitted). 109: * @param xFormat the format object for the x values (<code>null</code> 110: * not permitted). 111: * @param yFormat the format object for the y values (<code>null</code> 112: * not permitted). 113: */ 114: public StandardXYToolTipGenerator(String formatString, DateFormat xFormat, 115: NumberFormat yFormat) { 116: 117: super(formatString, xFormat, yFormat); 118: 119: } 120: 121: /** 122: * Creates a tool tip generator using the specified formatters (a 123: * number formatter for the x-values and a date formatter for the 124: * y-values). 125: * 126: * @param formatString the item label format string (<code>null</code> 127: * not permitted). 128: * @param xFormat the format object for the x values (<code>null</code> 129: * permitted). 130: * @param yFormat the format object for the y values (<code>null</code> 131: * not permitted). 132: * 133: * @since 1.0.4 134: */ 135: public StandardXYToolTipGenerator(String formatString, 136: NumberFormat xFormat, DateFormat yFormat) { 137: 138: super(formatString, xFormat, yFormat); 139: } 140: /** 141: * Creates a tool tip generator using the specified date formatters. 142: * 143: * @param formatString the label format string (<code>null</code> not 144: * permitted). 145: * @param xFormat the format object for the x values (<code>null</code> 146: * not permitted). 147: * @param yFormat the format object for the y values (<code>null</code> 148: * not permitted). 149: */ 150: public StandardXYToolTipGenerator(String formatString, 151: DateFormat xFormat, DateFormat yFormat) { 152: 153: super(formatString, xFormat, yFormat); 154: 155: } 156: 157: /** 158: * Generates the tool tip text for an item in a dataset. 159: * 160: * @param dataset the dataset (<code>null</code> not permitted). 161: * @param series the series index (zero-based). 162: * @param item the item index (zero-based). 163: * 164: * @return The tooltip text (possibly <code>null</code>). 165: */ 166: public String generateToolTip(XYDataset dataset, int series, int item) { 167: return generateLabelString(dataset, series, item); 168: } 169: 170: /** 171: * Tests this object for equality with an arbitrary object. 172: * 173: * @param obj the other object (<code>null</code> permitted). 174: * 175: * @return A boolean. 176: */ 177: public boolean equals(Object obj) { 178: if (obj == this) { 179: return true; 180: } 181: if (!(obj instanceof StandardXYToolTipGenerator)) { 182: return false; 183: } 184: return super.equals(obj); 185: } 186: 187: /** 188: * Returns an independent copy of the generator. 189: * 190: * @return A clone. 191: * 192: * @throws CloneNotSupportedException if cloning is not supported. 193: */ 194: public Object clone() throws CloneNotSupportedException { 195: return super.clone(); 196: } 197: 198: }