| /******************************************************************************* |
| * Copyright (c) 2006, 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.core.runtime.IProgressMonitor; |
| |
| /** |
| * Extends {@link org.eclipse.jface.text.contentassist.ICompletionProposal} with the following |
| * function: |
| * <ul> |
| * <li>Allow background computation of the additional info.</li> |
| * </ul> |
| * |
| * @since 3.2 |
| */ |
| public interface ICompletionProposalExtension5 { |
| /** |
| * Returns additional information about the proposal. The additional information will be |
| * presented to assist the user in deciding if the selected proposal is the desired choice. |
| * <p> |
| * This method may be called on a non-UI thread. |
| * </p> |
| * <p> |
| * By default, the returned information is converted to a string and displayed as text; if |
| * {@link ICompletionProposalExtension3#getInformationControlCreator()} is implemented, the |
| * information will be passed to a custom information control for display. |
| * </p> |
| * |
| * @param monitor a monitor to report progress and to watch for |
| * {@link IProgressMonitor#isCanceled() cancelation}. |
| * @return the additional information, <code>null</code> for no information |
| */ |
| Object getAdditionalProposalInfo(IProgressMonitor monitor); |
| } |
