    001    /* ===========================================================
    002     * JFreeChart : a free chart library for the Java(tm) platform
    003     * ===========================================================
    004     *
    005     * (C) Copyright 2000-2008, 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-2008, by Richard Atkinson and Contributors.
    031     *
    032     * Original Author:  Richard Atkinson;
    033     *
    034     * Changes
    035     * -------
    036     * 12-Aug-2003 : Version 1 (RA);
    037     * 05-Dec-2007 : Updated API docs (DG);
    038     *
    039     */
    040
    041    package org.jfree.chart.imagemap;
    042
    043    /**
    044     * Interface for generating the tooltip fragment of an HTML image map area tag.
    045     * The fragment should be <code>XHTML 1.0</code> compliant.
    046     */
    047    public interface ToolTipTagFragmentGenerator {
    048
    049        /**
    050         * Generates a tooltip string to go in an HTML image map.  To allow for
    051         * varying standards compliance among browsers, this method is expected
    052         * to return an 'alt' attribute IN ADDITION TO whatever it does to create
    053         * the tooltip (often a 'title' attribute).
    054         * <br><br>
    055         * Note that the <code>toolTipText</code> may have been generated from
    056         * user-defined data, so care should be taken to filter/escape any
    057         * characters that may corrupt the HTML tag.
    058         *
    059         * @param toolTipText  the tooltip.
    060         *
    061         * @return The formatted HTML area tag attribute(s).
    062         */
    063        public String generateToolTipFragment(String toolTipText);
    064
    065    }