    001    /* ===========================================================
    002     * JFreeChart : a free chart library for the Java(tm) platform
    003     * ===========================================================
    004     *
    005     * (C) Copyright 2000-2007, 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     * DynamicDriveToolTipTagFragmentGenerator.java
    029     * --------------------------------------------
    030     * (C) Copyright 2003-2007, 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
    042    package org.jfree.chart.imagemap;
    043
    044    /**
    045     * Generates tooltips using the Dynamic Drive DHTML Tip Message
    046     * library (http://www.dynamicdrive.com).
    047     */
    048    public class DynamicDriveToolTipTagFragmentGenerator
    049            implements ToolTipTagFragmentGenerator {
    050
    051        /** The title, empty string not to display */
    052        protected String title = "";
    053
    054        /** The style number */
    055        protected int style = 1;
    056
    057        /**
    058         * Blank constructor.
    059         */
    060        public DynamicDriveToolTipTagFragmentGenerator() {
    061            super();
    062        }
    063
    064        /**
    065         * Creates a new generator with specific title and style settings.
    066         *
    067         * @param title  title for use in all tooltips, use empty String not to
    068         *               display a title.
    069         * @param style  style number, see http://www.dynamicdrive.com for more
    070         *               information.
    071         */
    072        public DynamicDriveToolTipTagFragmentGenerator(String title, int style) {
    073            this.title = title;
    074            this.style = style;
    075        }
    076
    077        /**
    078         * Generates a tooltip string to go in an HTML image map.
    079         *
    080         * @param toolTipText  the tooltip.
    081         *
    082         * @return The formatted HTML area tag attribute(s).
    083         */
    084        public String generateToolTipFragment(String toolTipText) {
    085            return " onMouseOver=\"return stm(['"
    086                + ImageMapUtilities.htmlEscape(this.title) + "','"
    087                + ImageMapUtilities.htmlEscape(toolTipText) + "'],Style["
    088                + this.style + "]);\"" + " onMouseOut=\"return htm();\"";
    089        }
    090
    091    }