001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-present, by David Gilbert 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 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
025 * Other names may be trademarks of their respective owners.]
026 *
027 * --------------------------------------------
028 * DynamicDriveToolTipTagFragmentGenerator.java
029 * --------------------------------------------
030 * (C) Copyright 2003-present, by Richard Atkinson and Contributors.
031 *
032 * Original Author:  Richard Atkinson;
033 * Contributors:     David Gilbert;
034 *                   Fawad Halim - bug 2690293;
035 *
036 */
037
038package org.jfree.chart.imagemap;
039
040/**
041 * Generates tooltips using the Dynamic Drive DHTML Tip Message
042 * library (http://www.dynamicdrive.com).
043 */
044public class DynamicDriveToolTipTagFragmentGenerator
045        implements ToolTipTagFragmentGenerator {
046
047    /** The title, empty string not to display */
048    protected String title = "";
049
050    /** The style number */
051    protected int style = 1;
052
053    /**
054     * Blank constructor.
055     */
056    public DynamicDriveToolTipTagFragmentGenerator() {
057        super();
058    }
059
060    /**
061     * Creates a new generator with specific title and style settings.
062     *
063     * @param title  title for use in all tooltips, use empty String not to
064     *               display a title.
065     * @param style  style number, see http://www.dynamicdrive.com for more
066     *               information.
067     */
068    public DynamicDriveToolTipTagFragmentGenerator(String title, int style) {
069        this.title = title;
070        this.style = style;
071    }
072
073    /**
074     * Generates a tooltip string to go in an HTML image map.
075     *
076     * @param toolTipText  the tooltip.
077     *
078     * @return The formatted HTML area tag attribute(s).
079     */
080    @Override
081    public String generateToolTipFragment(String toolTipText) {
082        return " onMouseOver=\"return stm(['"
083            + ImageMapUtils.javascriptEscape(this.title) + "','"
084            + ImageMapUtils.javascriptEscape(toolTipText) + "'],Style["
085            + this.style + "]);\"" + " onMouseOut=\"return htm();\"";
086    }
087
088}