org.eclipse.jface.text.contentassist.ICompletionProposalExtension3 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, 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;

import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.IInformationControlCreator;


/**
 * Extends {@link org.eclipse.jface.text.contentassist.ICompletionProposal}
 * with the following functions:
 * 
 *	provision of a custom information control creator
 *	provide a custom completion text and offset for prefix completion
 * 
 *
 * @since 3.0
 */
public interface ICompletionProposalExtension3 {
	/**
	 * Returns the information control creator of this completion proposal.
	 *
	 * @return the information control creator, or null if no custom control creator is available
	 */
	IInformationControlCreator getInformationControlCreator();

	/**
	 * Returns the string that would be inserted at the position returned from
	 * {@link #getPrefixCompletionStart(IDocument, int)} if this proposal was
	 * applied. If the replacement string cannot be determined,
	 * null may be returned.
	 *
	 * @param document the document that the receiver applies to
	 * @param completionOffset the offset into document where the
	 *        completion takes place
	 * @return the replacement string or null if it cannot be
	 *         determined
	 */
	CharSequence getPrefixCompletionText(IDocument document, int completionOffset);

	/**
	 * Returns the document offset at which the receiver would insert its
	 * proposal.
	 *
	 * @param document the document that the receiver applies to
	 * @param completionOffset the offset into document where the
	 *        completion takes place
	 * @return the offset at which the proposal would insert its proposal
	 */
	int getPrefixCompletionStart(IDocument document, int completionOffset);

}