001    /* ===========================================================
002     * JFreeChart : a free chart library for the Java(tm) platform
003     * ===========================================================
004     *
005     * (C) Copyright 2000-2009, 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     * OverLibToolTipTagFragmentGenerator.java
029     * ---------------------------------------
030     * (C) Copyright 2003-2009, by Richard Atkinson and Contributors.
031     *
032     * Original Author:  Richard Atkinson;
033     * Contributors:     David Gilbert (for Object Refinery Limited);
034     *                   Fawad Halim - bug 2690293;
035     *
036     * Changes
037     * -------
038     * 12-Aug-2003 : Version 1 (RA);
039     * 04-Dec-2007 : Escape tool tip text to fix bug 1400917 (DG);
040     * 19-Mar-2009 : Escape apostrophes - see bug 2690293 with fix by FH (DG);
041     *
042     */
043    
044    package org.jfree.chart.imagemap;
045    
046    /**
047     * Generates tooltips using the OverLIB library
048     * (http://www.bosrup.com/web/overlib/).
049     */
050    public class OverLIBToolTipTagFragmentGenerator
051            implements ToolTipTagFragmentGenerator {
052    
053        /**
054         * Creates a new instance.
055         */
056        public OverLIBToolTipTagFragmentGenerator() {
057            super();
058        }
059    
060        /**
061         * Generates a tooltip string to go in an HTML image map.
062         *
063         * @param toolTipText  the tooltip text.
064         *
065         * @return The formatted HTML area tag attribute(s).
066         */
067        public String generateToolTipFragment(String toolTipText) {
068            return " onMouseOver=\"return overlib('"
069                    + ImageMapUtilities.javascriptEscape(toolTipText)
070                    + "');\" onMouseOut=\"return nd();\"";
071        }
072    
073    }