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