bundles/org.eclipse.ui/Eclipse JFace Text/org/eclipse/jface/text/contentassist/IContextInformation.java

package org.eclipse.jface.text.contentassist;

/*
 * (c) Copyright IBM Corp. 2000, 2001.
 * All Rights Reserved.
 */


import org.eclipse.swt.graphics.Image;


/**
 * The inferface of context information presented to the user and
 * generated by content assist processors.
 * The interface can be implemented by clients. By default, clients use
 * <code>ContextInformation</code> as the standard implementer of this interface. 
 *
 * @see IContentAssistProcessor
 */
public interface IContextInformation {
	
	/**
	 * Compares the given object with this receiver. Two context informations are 
	 * equal if there information display strings and their context display strings 
	 * are equal.
	 *
	 * @see Object#equals
	 */
	boolean equals(Object object);
	/**
	 * Returns the string to be displayed in the list of contexts.
	 * This method is used to supply a unique presentation for 
	 * situations where the context is ambiguous. These strings are 
	 * used to allow the user to select the specific context.
	 *
	 * @return the string to be displayed for the context
	 */
	String getContextDisplayString();
	/**
	 * Returns the image for this context information.
	 * The image will be shown to the left of the display string.
	 *
	 * @return the image to be shown or <code>null</code> if no image is desired
	 */
	Image getImage();
	/**
	 * Returns the string to be displayed in the tooltip like information popup.
	 *
	 * @return the string to be displayed
	 */
	String getInformationDisplayString();
}