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: * ToolTipTagFragmentGenerator.java 29: * -------------------------------- 30: * (C) Copyright 2003-2007, by Richard Atkinson and Contributors. 31: * 32: * Original Author: Richard Atkinson; 33: * 34: * Changes 35: * ------- 36: * 12-Aug-2003 : Version 1 (RA); 37: * 05-Dec-2007 : Updated API docs (DG); 38: * 39: */ 40: 41: package org.jfree.chart.imagemap; 42: 43: /** 44: * Interface for generating the tooltip fragment of an HTML image map area tag. 45: * The fragment should be <code>XHTML 1.0</code> compliant. 46: */ 47: public interface ToolTipTagFragmentGenerator { 48: 49: /** 50: * Generates a tooltip string to go in an HTML image map. To allow for 51: * varying standards compliance among browsers, this method is expected 52: * to return an 'alt' attribute IN ADDITION TO whatever it does to create 53: * the tooltip (often a 'title' attribute). 54: * <br><br> 55: * Note that the <code>toolTipText</code> may have been generated from 56: * user-defined data, so care should be taken to filter/escape any 57: * characters that may corrupt the HTML tag. 58: * 59: * @param toolTipText the tooltip. 60: * 61: * @return The formatted HTML area tag attribute(s). 62: */ 63: public String generateToolTipFragment(String toolTipText); 64: 65: }