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-2005, 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-2005, by Richard Atkinson and Contributors.
  31:  *
  32:  * Original Author:  Richard Atkinson;
  33:  *
  34:  * $Id: DynamicDriveToolTipTagFragmentGenerator.java,v 1.3.2.1 2005/10/25 20:42:39 mungady Exp $
  35:  *
  36:  * Changes
  37:  * -------
  38:  * 12-Aug-2003 : Version 1 (RA);
  39:  * 
  40:  */
  41:  
  42: package org.jfree.chart.imagemap;
  43: 
  44: /**
  45:  * Generates tooltips using the Dynamic Drive DHTML Tip Message 
  46:  * library (http://www.dynamicdrive.com).
  47:  *
  48:  * @author Richard Atkinson
  49:  */
  50: public class DynamicDriveToolTipTagFragmentGenerator 
  51:     implements ToolTipTagFragmentGenerator {
  52: 
  53:     /** The title, empty string not to display */
  54:     protected String title = "";
  55: 
  56:     /** The style number */
  57:     protected int style = 1;
  58: 
  59:     /**
  60:      * Blank constructor.
  61:      */
  62:     public DynamicDriveToolTipTagFragmentGenerator() {
  63:         super();
  64:     }
  65: 
  66:     /**
  67:      * Creates a new generator with specific title and style settings.
  68:      *
  69:      * @param title  title for use in all tooltips, use empty String not to 
  70:      *               display a title.
  71:      * @param style  style number, see http://www.dynamicdrive.com for more 
  72:      *               information.
  73:      */
  74:     public DynamicDriveToolTipTagFragmentGenerator(String title, int style) {
  75:         this.title = title;
  76:         this.style = style;
  77:     }
  78: 
  79:     /**
  80:      * Generates a tooltip string to go in an HTML image map.
  81:      *
  82:      * @param toolTipText  the tooltip.
  83:      * 
  84:      * @return The formatted HTML area tag attribute(s).
  85:      */
  86:     public String generateToolTipFragment(String toolTipText) {
  87:         return " onMouseOver=\"return stm(['" + this.title + "','" 
  88:             + toolTipText + "'],Style[" + this.style + "]);\"" 
  89:             + " onMouseOut=\"return htm();\"";
  90:     }
  91: 
  92: }