org.eclipse.jface.text.contentassist.ICompletionProposalExtension2 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) 2000, 2005 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;

import org.eclipse.jface.text.DocumentEvent;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.ITextViewer;


/**
 * Extends {@link org.eclipse.jface.text.contentassist.ICompletionProposal}
 * with the following functions:
 * 
 *	handling of trigger characters with modifiers
 *	visual indication for selection of a proposal
 * 
 *
 * @since 2.1
 */
public interface ICompletionProposalExtension2 {

	/**
	 * Applies the proposed completion to the given document. The insertion
	 * has been triggered by entering the given character with a modifier at the given offset.
	 * This method assumes that {@link #validate(IDocument, int, DocumentEvent)}
	 * returns true if called for offset.
	 *
	 * @param viewer the text viewer into which to insert the proposed completion
	 * @param trigger the trigger to apply the completion
	 * @param stateMask the state mask of the modifiers
	 * @param offset the offset at which the trigger has been activated
	 */
	void apply(ITextViewer viewer, char trigger, int stateMask, int offset);

	/**
	 * Called when the proposal is selected.
	 *
	 * @param viewer the text viewer.
	 * @param smartToggle the smart toggle key was pressed
	 */
	void selected(ITextViewer viewer, boolean smartToggle);

	/**
	 * Called when the proposal is unselected.
	 *
	 * @param viewer the text viewer.
	 */
	void unselected(ITextViewer viewer);

	/**
	 * Requests the proposal to be validated with respect to the document event.
	 * If the proposal cannot be validated, the methods returns false.
	 * If the document event was null, only the caret offset was changed, but not the document.
	 *
	 * This method replaces {@link ICompletionProposalExtension#isValidFor(IDocument, int)}
	 *
	 * @param document the document
	 * @param offset the caret offset
	 * @param event the document event, may be null
	 * @return boolean
	 */
	boolean validate(IDocument document, int offset, DocumentEvent event);

}