|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The interface of completion proposals generated by content assist processors. A completion proposal contains information used to present the proposed completion to the user, to insert the completion should the user select it, and to present context information for the chosen completion once it has been inserted.
In order to provide backward compatibility for clients of ICompletionProposal
, extension
interfaces are used to provide a means of evolution. The following extension interfaces exist:
ICompletionProposalExtension
since version 2.0 introducing
the following functions:
ICompletionProposalExtension2
since version 2.1 introducing
the following functions:
ICompletionProposalExtension3
since version 3.0 introducing
the following functions:
This interface can be implemented by clients. By default, clients use
CompletionProposal
as the
standard implementer of this interface.
IContentAssistProcessor
Method Summary | |
void |
apply(IDocument document)
Inserts the proposed completion into the given document. |
String |
getAdditionalProposalInfo()
Returns optional additional information about the proposal. |
IContextInformation |
getContextInformation()
Returns optional context information associated with this proposal. |
String |
getDisplayString()
Returns the string to be displayed in the list of completion proposals. |
Image |
getImage()
Returns the image to be displayed in the list of completion proposals. |
Point |
getSelection(IDocument document)
Returns the new selection after the proposal has been applied to the given document in absolute document coordinates. |
Method Detail |
public void apply(IDocument document)
document
- the document into which to insert the proposed completionpublic Point getSelection(IDocument document)
null
, no new selection is set.
A document change can trigger other document changes, which have
to be taken into account when calculating the new selection. Typically,
this would be done by installing a document listener or by using a
document position during apply(IDocument)
.
document
- the document into which the proposed completion has been inserted
public String getAdditionalProposalInfo()
null
public String getDisplayString()
public Image getImage()
null
if no image is desiredpublic IContextInformation getContextInformation()
null
|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.