Source for org.jfree.chart.imagemap.DynamicDriveToolTipTagFragmentGenerator

   1: /* ===========================================================
   2:  * JFreeChart : a free chart library for the Java(tm) platform
   3:  * ===========================================================
   4:  *
   5:  * (C) Copyright 2000-2007, by Object Refinery Limited and Contributors.
   6:  *
   7:  * Project Info:  http://www.jfree.org/jfreechart/index.html
   8:  *
   9:  * This library is free software; you can redistribute it and/or modify it 
  10:  * under the terms of the GNU Lesser General Public License as published by 
  11:  * the Free Software Foundation; either version 2.1 of the License, or 
  12:  * (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but 
  15:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
  16:  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
  17:  * License for more details.
  18:  *
  19:  * You should have received a copy of the GNU Lesser General Public
  20:  * License along with this library; if not, write to the Free Software
  21:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
  22:  * USA.  
  23:  *
  24:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
  25:  * in the United States and other countries.]
  26:  *
  27:  * --------------------------------------------
  28:  * DynamicDriveToolTipTagFragmentGenerator.java
  29:  * --------------------------------------------
  30:  * (C) Copyright 2003-2007, by Richard Atkinson and Contributors.
  31:  *
  32:  * Original Author:  Richard Atkinson;
  33:  *
  34:  * Changes
  35:  * -------
  36:  * 12-Aug-2003 : Version 1 (RA);
  37:  * 
  38:  */
  39:  
  40: package org.jfree.chart.imagemap;
  41: 
  42: /**
  43:  * Generates tooltips using the Dynamic Drive DHTML Tip Message 
  44:  * library (http://www.dynamicdrive.com).
  45:  */
  46: public class DynamicDriveToolTipTagFragmentGenerator 
  47:     implements ToolTipTagFragmentGenerator {
  48: 
  49:     /** The title, empty string not to display */
  50:     protected String title = "";
  51: 
  52:     /** The style number */
  53:     protected int style = 1;
  54: 
  55:     /**
  56:      * Blank constructor.
  57:      */
  58:     public DynamicDriveToolTipTagFragmentGenerator() {
  59:         super();
  60:     }
  61: 
  62:     /**
  63:      * Creates a new generator with specific title and style settings.
  64:      *
  65:      * @param title  title for use in all tooltips, use empty String not to 
  66:      *               display a title.
  67:      * @param style  style number, see http://www.dynamicdrive.com for more 
  68:      *               information.
  69:      */
  70:     public DynamicDriveToolTipTagFragmentGenerator(String title, int style) {
  71:         this.title = title;
  72:         this.style = style;
  73:     }
  74: 
  75:     /**
  76:      * Generates a tooltip string to go in an HTML image map.
  77:      *
  78:      * @param toolTipText  the tooltip.
  79:      * 
  80:      * @return The formatted HTML area tag attribute(s).
  81:      */
  82:     public String generateToolTipFragment(String toolTipText) {
  83:         return " onMouseOver=\"return stm(['" + this.title + "','" 
  84:             + toolTipText + "'],Style[" + this.style + "]);\"" 
  85:             + " onMouseOut=\"return htm();\"";
  86:     }
  87: 
  88: }