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     * ToolTipTagFragmentGenerator.java
029     * --------------------------------
030     * (C) Copyright 2003-2005, by Richard Atkinson and Contributors.
031     *
032     * Original Author:  Richard Atkinson;
033     *
034     * $Id: ToolTipTagFragmentGenerator.java,v 1.4.2.1 2005/10/25 20:42:39 mungady Exp $
035     *
036     * Changes
037     * -------
038     * 12-Aug-2003 : Version 1 (RA);
039     * 
040     */
041     
042    package org.jfree.chart.imagemap;
043    
044    /**
045     * Interface for generating the tooltip fragment of an HTML image map area tag.
046     * The fragment should be <code>XHTML 1.0</code> compliant.
047     *
048     * @author Richard Atkinson
049     */
050    public interface ToolTipTagFragmentGenerator {
051    
052        /**
053         * Generates a tooltip string to go in an HTML image map.  To allow for
054         * varying standards compliance among browsers, this method is expected
055         * to return an 'alt' attribute IN ADDITION TO whatever it does to create
056         * the tooltip (often a 'title' attribute). 
057         *
058         * @param toolTipText  the tooltip.
059         * 
060         * @return The formatted HTML area tag attribute(s).
061         */
062        public String generateToolTipFragment(String toolTipText);
063    
064    }