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 * StandardToolTipTagFragmentGenerator.java
029 * ----------------------------------------
030 * (C) Copyright 2003-2008, by Richard Atkinson and Contributors.
031 *
032 * Original Author:  Richard Atkinson;
033 * Contributors:     David Gilbert (for Object Refinery Limited);
034 *
035 * Changes
036 * -------
037 * 12-Aug-2003 : Version 1 (RA);
038 * 04-Dec-2007 : Escape tool tip text to fix bug 1400917 (DG);
039 *
040 */
041
042package org.jfree.chart.imagemap;
043
044/**
045 * Generates tooltips using the HTML title attribute for image map area tags.
046 */
047public class StandardToolTipTagFragmentGenerator
048        implements ToolTipTagFragmentGenerator {
049
050    /**
051     * Creates a new instance.
052     */
053    public StandardToolTipTagFragmentGenerator() {
054        super();
055    }
056
057    /**
058     * Generates a tooltip string to go in an HTML image map.
059     *
060     * @param toolTipText  the tooltip.
061     *
062     * @return The formatted HTML area tag attribute(s).
063     */
064    public String generateToolTipFragment(String toolTipText) {
065        return " title=\"" + ImageMapUtilities.htmlEscape(toolTipText)
066            + "\" alt=\"\"";
067    }
068
069}