KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jface > contentassist > ISubjectControlContentAssistProcessor


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.jface.contentassist;
12
13 import org.eclipse.jface.text.contentassist.ICompletionProposal;
14 import org.eclipse.jface.text.contentassist.IContentAssistProcessor;
15 import org.eclipse.jface.text.contentassist.IContextInformation;
16
17
18 /**
19  * Extension interface for {@link org.eclipse.jface.text.contentassist.IContentAssistProcessor}
20  * which provides the context for the
21  * {@linkplain org.eclipse.jface.contentassist.ISubjectControlContentAssistant subject control content assistant}.
22  *
23  * @since 3.0
24  * @deprecated As of 3.2, replaced by Platform UI's field assist support
25  */
26 public interface ISubjectControlContentAssistProcessor extends IContentAssistProcessor {
27
28     /**
29      * Returns a list of completion proposals based on the specified location
30      * within the document that corresponds to the current cursor position
31      * within the text viewer.
32      *
33      * @param contentAssistSubjectControl the content assist subject control whose
34      * document is used to compute the proposals
35      * @param documentOffset an offset within the document for which
36      * completions should be computed
37      * @return an array of completion proposals or <code>null</code> if no
38      * proposals are possible
39      */
40     ICompletionProposal[] computeCompletionProposals(IContentAssistSubjectControl contentAssistSubjectControl, int documentOffset);
41
42     /**
43      * Returns information about possible contexts based on the specified
44      * location within the document that corresponds to the current cursor
45      * position within the content assist subject control.
46      *
47      * @param contentAssistSubjectControl the content assist subject control whose
48      * document is used to compute the possible contexts
49      * @param documentOffset an offset within the document for which context
50      * information should be computed
51      * @return an array of context information objects or <code>null</code>
52      * if no context could be found
53      */
54     IContextInformation[] computeContextInformation(IContentAssistSubjectControl contentAssistSubjectControl, int documentOffset);
55 }
56
Popular Tags