001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-present, by David Gilbert 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 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
025 * Other names may be trademarks of their respective owners.]
026 *
027 * ----------------------------
028 * URLTagFragmentGenerator.java
029 * ----------------------------
030 * (C) Copyright 2003-present, by Richard Atkinson and Contributors.
031 *
032 * Original Author:  Richard Atkinson;
033 *
034 */
035
036package org.jfree.chart.imagemap;
037
038import org.jfree.chart.urls.CategoryURLGenerator;
039import org.jfree.chart.urls.PieURLGenerator;
040import org.jfree.chart.urls.XYURLGenerator;
041import org.jfree.chart.urls.XYZURLGenerator;
042
043/**
044 * Interface for generating the URL fragment of an HTML image map area tag.
045 */
046public interface URLTagFragmentGenerator {
047
048    /**
049     * Generates a URL string to go in an HTML image map.
050     * <br><br>
051     * Note that the {@code urlText} will be created by a URL generator
052     * (such as {@link CategoryURLGenerator}, {@link PieURLGenerator},
053     * {@link XYURLGenerator} or {@link XYZURLGenerator}) and that generator is
054     * responsible for ensuring that the URL text is correctly escaped.
055     *
056     * @param urlText  the URL text (fully escaped).
057     *
058     * @return The formatted HTML area tag attribute(s).
059     */
060    String generateURLFragment(String urlText);
061
062}