org.biojava.bio.gui.sequence.ImageMapRenderer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gui Show documentation

BioJava gui module

There is a newer version: 1.9.7

/*
 *                    BioJava development code
 *
 * This code may be freely distributed and modified under the
 * terms of the GNU Lesser General Public Licence.  This should
 * be distributed with the code.  If you do not have a copy,
 * see:
 *
 *      http://www.gnu.org/copyleft/lesser.html
 *
 * Copyright for this code is held jointly by the individual
 * authors.  These should be listed in @author doc comments.
 *
 * For more information on the BioJava project and its aims,
 * or to join the biojava-l mailing list, visit the home page
 * at:
 *
 *      http://www.biojava.org/
 *
 */

package org.biojava.bio.gui.sequence;

import java.awt.Graphics2D;

import org.biojava.bio.seq.Feature;

/**
 * ImageMapRenderers create strings representing
 * Features suitable for use in HTML image
 * maps. Typically an ImageMapRenderer will be used as a
 * decorator on a FeatureRenderer which will draw the
 * corresponding image area(s).
 *
 * @author Keith James
 * @since 1.3
 */
public interface ImageMapRenderer extends FeatureRenderer
{
    /**
     * renderImageMap renders the Feature as
     * set of image map hotspots.
     *
     * @param g2 a Graphics2D.
     * @param f a Feature.
     * @param context a SequenceRenderContext.
     */
    public void renderImageMap(Graphics2D                 g2,
                               Feature                     f,
                               SequenceRenderContext context);
}