blob: 3a0783f808d90a7c44714393d2b122817abda1d2 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
package org.eclipse.jface.text.contentassist;
/*
* (c) Copyright IBM Corp. 2000, 2001.
* All Rights Reserved.
*/
import org.eclipse.jface.text.ITextViewer;
/**
* A content assist processor proposes completions and
* computes context information for a particular content type.
* A content assist processor is an <code>IContentAssistant</code>-plug-ins.
* This interface must be implemented by clients. Implementers should be
* registered with a content assistant in order to get involved in the
* assisting process.
*/
public interface IContentAssistProcessor {
/**
* Returns a list of completion proposals based on the
* specified location within the document that corresponds
* to the current cursor position within the text viewer.
*
* @param viewer the viewer whose document is used to compute the proposals
* @param documentPosition an offset within the document for which completions should be computed
* @return an array of completion proposals or <code>null</code> if no proposals are possible
*/
ICompletionProposal[] computeCompletionProposals(ITextViewer viewer, int documentOffset);
/**
* Returns information about possible contexts based on the
* specified location within the document that corresponds
* to the current cursor position within the text viewer.
*
* @param viewer the viewer whose document is used to compute the possible contexts
* @param documentPosition an offset within the document for which context information should be computed
* @return an array of context information objects or <code>null</code> if no context could be found
*/
IContextInformation[] computeContextInformation(ITextViewer viewer, int documentOffset);
/**
* Returns the characters which when entered by the user should
* automatically trigger the presentation of possible completions.
*
* @return the auto activation characters for completion proposal or <code>null</code>
* if no auto activation is desired
*/
char[] getCompletionProposalAutoActivationCharacters();
/**
* Returns the characters which when entered by the user should
* automatically trigger the presentation of context information.
*
* @return the auto activation characters for presenting context information
* or <code>null</code> if no auto activation is desired
*/
char[] getContextInformationAutoActivationCharacters();
/**
* Returns the reason why this content assist processor
* was unable to produce any completion proposals or context information.
*
* @return an error message or <code>null</code> if no error occurred
*/
String getErrorMessage();
/**
* Returns a validator used to determine when displayed context information
* should be dismissed. May only return <code>null</code> if the processor is
* incapable of computing context information. <p>
*
* Because of http://dev.eclipse.org/bugs/show_bug.cgi?id=13926 the object returned
* by this method should also implement <code>IContextInformationPresenter</code>.
* @see IContextInformationPresenter
*
* @return a context information validator, or <code>null</code> if the processor
* is incapable of computing context information
*/
IContextInformationValidator getContextInformationValidator();
}
|
