ToolTipTagFragmentGenerator


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 License 
20   * along with this library; if not, write to the Free Software Foundation, 
21   * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
22   *
23   * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
24   * in the United States and other countries.]
25   *
26   * --------------------------------
27   * ToolTipTagFragmentGenerator.java
28   * --------------------------------
29   * (C) Copyright 2003-2005, by Richard Atkinson and Contributors.
30   *
31   * Original Author:  Richard Atkinson;
32   *
33   * $Id: ToolTipTagFragmentGenerator.java,v 1.4 2005/03/07 10:54:49 mungady Exp $
34   *
35   * Changes
36   * -------
37   * 12-Aug-2003 : Version 1 (RA);
38   * 
39   */
40   
41  package org.jfree.chart.imagemap;
42  
43  /**
44   * Interface for generating the tooltip fragment of an HTML image map area tag.
45   * The fragment should be <code>XHTML 1.0</code> compliant.
46   *
47   * @author Richard Atkinson
48   */
49  public interface ToolTipTagFragmentGenerator {
50  
51      /**
52       * Generates a tooltip string to go in an HTML image map.  To allow for
53       * varying standards compliance among browsers, this method is expected
54       * to return an 'alt' attribute IN ADDITION TO whatever it does to create
55       * the tooltip (often a 'title' attribute). 
56       *
57       * @param toolTipText  the tooltip.
58       * 
59       * @return The formatted HTML area tag attribute(s).
60       */
61      public String   generateToolTipFragment(String   toolTipText);
62  
63  }
64
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags