org.eclipse.jface.text.contentassist.IContentAssistantExtension2 Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.jface.text Show documentation

This is org.eclipse.jface.text jar used by Scout SDK

The newest version!

/*******************************************************************************
 * Copyright (c) 2006, 2008 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jface.text.contentassist;

/**
 * Extends {@link org.eclipse.jface.text.contentassist.IContentAssistant} with the following
 * functions:
 * 
 * completion listeners
 * repeated invocation mode
 * a local status line for the completion popup
 * control over the behavior when no proposals are available
 * 
 *
 * @since 3.2
 */
public interface IContentAssistantExtension2 {

	/**
	 * Adds a completion listener that will be informed before proposals are computed.
	 *
	 * @param listener the listener
	 */
	public void addCompletionListener(ICompletionListener listener);

	/**
	 * Removes a completion listener.
	 *
	 * @param listener the listener to remove
	 */
	public void removeCompletionListener(ICompletionListener listener);

	/**
	 * Enables repeated invocation mode, which will trigger re-computation of the proposals when
	 * code assist is executed repeatedly. The default is no false.
	 *
	 * @param cycling true to enable repetition mode, false to disable
	 */
	public void setRepeatedInvocationMode(boolean cycling);

	/**
	 * Enables displaying an empty completion proposal pop-up. The default is not to show an empty
	 * list.
	 *
	 * @param showEmpty true to show empty lists
	 */
	public void setShowEmptyList(boolean showEmpty);

	/**
	 * Enables displaying a status line below the proposal popup. The default is not to show the
	 * status line. The contents of the status line may be set via {@link #setStatusMessage(String)}.
	 *
	 * @param show true to show a message line, false to not show one.
	 */
	public void setStatusLineVisible(boolean show);

	/**
	 * Sets the caption message displayed at the bottom of the completion proposal popup.
	 *
	 * @param message the message
	 */
	public void setStatusMessage(String message);

	/**
	 * Sets the text to be shown if no proposals are available and
	 * {@link #setShowEmptyList(boolean) empty lists} are displayed.
	 *
	 * @param message the text for the empty list
	 */
	public void setEmptyMessage(String message);
}