blob: debadf2edc95d93a8a5f97ce3609591411f0c9ce (
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
|
/*******************************************************************************
* Copyright (c) 2000, 2004 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:
* <ul>
* <li>provision of a custom information control creator</li>
* <li>provide a custom completion text and offset for prefix completion</li>
* </ul>
*
* @since 3.0
*/
public interface ICompletionProposalExtension3 {
/**
* Returns the information control creator of this completion proposal.
*
* @return the information control creator, or <code>null</code> 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,
* <code>null</code> may be returned.
* <p>
* If this interface is not implemented,
* {@link ICompletionProposal#getDisplayString()} will be used instead.
* </p>
*
* @param document the document that the receiver applies to
* @param completionOffset the offset into <code>document</code> where the
* completion takes place
* @return the replacement string or <code>null</code> if it cannot be
* determined
*/
CharSequence getPrefixCompletionText(IDocument document, int completionOffset);
/**
* Returns the document offset at which the receiver would insert its
* proposal.
* <p>
* If this interface is not implemented, <code>completionOffset</code> will
* be used instead.
* </p>
*
* @param document the document that the receiver applies to
* @param completionOffset the offset into <code>document</code> where the
* completion takes place
* @return the offset at which the proposal would insert its proposal
*/
int getPrefixCompletionStart(IDocument document, int completionOffset);
}
|
