org.eclipse.jface.text.quickassist.IQuickAssistAssistantExtension 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) 2007, 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.quickassist;

import org.eclipse.core.commands.IHandler;

import org.eclipse.jface.text.contentassist.ICompletionProposalExtension6;


/**
 * Extends {@link IQuickAssistAssistant} with the following function:
 * 
 * 	allows to get a handler for the given command identifier
 * 	allows to enable support for colored labels in the proposal popup
 * 
 *
 * @since 3.4
 */
public interface IQuickAssistAssistantExtension {

	/**
	 * Returns the handler for the given command identifier.
	 * 
	 * The same handler instance will be returned when called a more than once
	 * with the same command identifier.
	 * 
	 *
	 * @param commandId the command identifier
	 * @return the handler for the given command identifier
	 * @throws IllegalArgumentException if the command is not supported by this
	 *             content assistant
	 * @throws IllegalStateException if called when this content assistant is
	 *             uninstalled
	 */
	IHandler getHandler(String commandId);

	/**
	 * Enables the support for colored labels in the proposal popup.
	 * Completion proposals can implement {@link ICompletionProposalExtension6}
	 * to provide colored proposal labels.
	 *
	 * @param isEnabled if true the support for colored labels is enabled in the proposal popup
	 * @since 3.4
	 */
	void enableColoredLabels(boolean isEnabled);

}