edu.uci.ics.jung.visualization.renderers.VertexLabelRenderer Maven / Gradle / Ivy

/*
 * Copyright (c) 2005, the JUNG Project and the Regents of the University of
 * California All rights reserved.
 *
 * This software is open-source under the BSD license; see either "license.txt"
 * or http://jung.sourceforge.net/license.txt for a description.
 *
 * Created on Apr 14, 2005
 */

package edu.uci.ics.jung.visualization.renderers;

import java.awt.Component;
import java.awt.Font;

import javax.swing.JComponent;

/**
 * @author Tom Nelson 
 *
 * 
 */
public interface VertexLabelRenderer {
    /**
     *  Returns the component used for drawing the label.  This method is
     *  used to configure the renderer appropriately before drawing.
     *
     * @param	vv  the JComponent that is asking the 
     *				renderer to draw; can be null
     * @param	value		the value of the cell to be rendered.  It is
     *				up to the specific renderer to interpret
     *				and draw the value.  For example, if
     *				value
     *				is the string "true", it could be rendered as a
     *				string or it could be rendered as a check
     *				box that is checked.  null is a
     *				valid value
     * @param	vertex  the vertex for the label being drawn.
     */
     Component getVertexLabelRendererComponent(JComponent vv, Object value,
					   Font font, boolean isSelected, T vertex);
}