package com.swtplus.widgets.combo;

import org.eclipse.swt.graphics.Image;


/**
 * IComboLabelProvider maps elements to their visual representation.  
 */
public interface IComboLabelProvider {
	
	/**
	 * Returns the textual representation of the given element.
	 * 
	 * @param element element for which to provide text
	 * @return textual representation for the given element
	 */
	public String getText(Object element);
	
	/**
	 * Returns an image representation for the given element.
	 * 
	 * @param element element for which to provide an image
	 * @return image for given element or null
	 */
	public Image getImage(Object element);
	
	/**
	 * Returns a tooltip for the given element.
	 * 
	 * @param element element for which to provide a tooltip
	 * 
	 * @return tooltip for the given element
	 */
	public String getToolTip(Object element);
	
	/**
	 * Disposes of any resources used by this IComboLabelProvider.
	 */
	public void dispose();

}