| /******************************************************************************* |
| * Copyright (c) 2000, 2008 IBM Corporation and others. |
| * |
| * This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License 2.0 |
| * which accompanies this distribution, and is available at |
| * https://www.eclipse.org/legal/epl-2.0/ |
| * |
| * SPDX-License-Identifier: EPL-2.0 |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.jface.text.contentassist; |
| |
| import org.eclipse.swt.graphics.Image; |
| |
| |
| /** |
| * The interface of context information presented to the user and generated by content assist |
| * processors. |
| * <p> |
| * In order to provide backward compatibility for clients of <code>IContextInformation</code>, |
| * extension interfaces are used to provide a means of evolution. The following extension interfaces |
| * exist: |
| * </p> |
| * <ul> |
| * <li>{@link org.eclipse.jface.text.contentassist.IContextInformationExtension} since version 2.0 |
| * introducing the ability to freely position the context information.</li> |
| * </ul> |
| * <p> |
| * The interface can be implemented by clients. By default, clients use |
| * {@link org.eclipse.jface.text.contentassist.ContextInformation} as the standard implementer of |
| * this interface. |
| * </p> |
| * |
| * @see IContentAssistProcessor |
| */ |
| public interface IContextInformation { |
| |
| /** |
| * 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 tool tip like information popup. |
| * |
| * @return the string to be displayed |
| */ |
| String getInformationDisplayString(); |
| |
| /** |
| * Compares the given object with this receiver. Two context informations are equal if there |
| * information display strings and their context display strings are equal. |
| * <p> |
| * <strong>Note:</strong> As specified in {@link Object#equals(Object)} clients will most likely |
| * also have to implement {@link Object#hashCode()}. |
| * </p> |
| * |
| * @see Object#equals(Object) |
| */ |
| @Override |
| boolean equals(Object object); |
| } |
| |
| |