|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.eclipse.jface.text.contentassist.CompletionProposal
The standard implementation of the ICompletionProposal
interface.
Constructor Summary | |
CompletionProposal(String replacementString,
int replacementOffset,
int replacementLength,
int cursorPosition)
Creates a new completion proposal based on the provided information. |
|
CompletionProposal(String replacementString,
int replacementOffset,
int replacementLength,
int cursorPosition,
Image image,
String displayString,
IContextInformation contextInformation,
String additionalProposalInfo)
Creates a new completion proposal. |
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. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public CompletionProposal(String replacementString, int replacementOffset, int replacementLength, int cursorPosition)
null
.
replacementString
- the actual string to be inserted into the documentreplacementOffset
- the offset of the text to be replacedreplacementLength
- the length of the text to be replacedcursorPosition
- the position of the cursor following the insert relative to replacementOffsetpublic CompletionProposal(String replacementString, int replacementOffset, int replacementLength, int cursorPosition, Image image, String displayString, IContextInformation contextInformation, String additionalProposalInfo)
replacementString
- the actual string to be inserted into the documentreplacementOffset
- the offset of the text to be replacedreplacementLength
- the length of the text to be replacedcursorPosition
- the position of the cursor following the insert relative to replacementOffsetimage
- the image to display for this proposaldisplayString
- the string to be displayed for the proposaladditionalProposalInfo
- the additional information associated with this proposalMethod Detail |
public void apply(IDocument document)
ICompletionProposal
apply
in interface ICompletionProposal
document
- the document into which to insert the proposed completionpublic Point getSelection(IDocument document)
ICompletionProposal
null
, no new selection is set.
getSelection
in interface ICompletionProposal
document
- the document into which the proposed completion has been inserted
public IContextInformation getContextInformation()
ICompletionProposal
getContextInformation
in interface ICompletionProposal
null
public Image getImage()
ICompletionProposal
getImage
in interface ICompletionProposal
null
if no image is desiredpublic String getDisplayString()
ICompletionProposal
getDisplayString
in interface ICompletionProposal
public String getAdditionalProposalInfo()
ICompletionProposal
getAdditionalProposalInfo
in interface ICompletionProposal
null
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |