public class QuickAssistAssistant extends Object implements IQuickAssistAssistant
IQuickAssistAssistant.| Constructor and Description |
|---|
QuickAssistAssistant() |
| Modifier and Type | Method and Description |
|---|---|
void |
addCompletionListener(ICompletionListener listener)
Adds a completion listener that will be informed before proposals are computed.
|
boolean |
canAssist(IQuickAssistInvocationContext invocationContext)
Tells whether this assistant has assists for the given invocation context.
|
boolean |
canFix(Annotation annotation)
Tells whether this assistant has a fix for the given annotation.
|
IQuickAssistProcessor |
getQuickAssistProcessor()
Returns the quick assist processor to be used for the given content type.
|
void |
install(ISourceViewer sourceViewer)
Installs quick assist support on the given source viewer.
|
protected void |
possibleCompletionsClosed()
Callback to signal this quick assist assistant that the presentation of the
possible completions has been stopped.
|
void |
removeCompletionListener(ICompletionListener listener)
Removes a completion listener.
|
void |
setInformationControlCreator(IInformationControlCreator creator)
Sets the information control creator for the additional information control.
|
void |
setProposalSelectorBackground(Color background)
Sets the proposal selector's background color.
|
void |
setProposalSelectorForeground(Color foreground)
Sets the proposal's foreground color.
|
void |
setQuickAssistProcessor(IQuickAssistProcessor processor)
Registers a given quick assist processor for a particular content type.
|
void |
setStatusLineVisible(boolean show)
Enables displaying a status line below the proposal popup.
|
void |
setStatusMessage(String message)
Sets the caption message displayed at the bottom of the completion proposal popup.
|
String |
showPossibleQuickAssists()
Shows all possible quick fixes and quick assists at the viewer's cursor position.
|
void |
uninstall()
Uninstalls quick assist support from the source viewer it has
previously be installed on.
|
public String showPossibleQuickAssists()
IQuickAssistAssistantshowPossibleQuickAssists in interface IQuickAssistAssistantpublic IQuickAssistProcessor getQuickAssistProcessor()
IQuickAssistAssistantgetQuickAssistProcessor in interface IQuickAssistAssistantnull if none existspublic void setQuickAssistProcessor(IQuickAssistProcessor processor)
IQuickAssistAssistantsetQuickAssistProcessor in interface IQuickAssistAssistantprocessor - the quick assist processor to register, or null to remove
an existing onepublic boolean canFix(Annotation annotation)
IQuickAssistAssistant
Note: this test must be fast and optimistic i.e. it is OK to return
true even though there might be no quick fix.
canFix in interface IQuickAssistAssistantannotation - the annotationtrue if the assistant has a fix for the given annotationpublic boolean canAssist(IQuickAssistInvocationContext invocationContext)
IQuickAssistAssistantcanAssist in interface IQuickAssistAssistantinvocationContext - the invocation contexttrue if the assistant has a fix for the given annotationpublic void install(ISourceViewer sourceViewer)
IQuickAssistAssistant
Note: This quick assist assistant will only be able to query the invocation context
if sourceViewer also implements ISourceViewerExtension3.
install in interface IQuickAssistAssistantsourceViewer - the source viewer on which quick assist will workpublic void setInformationControlCreator(IInformationControlCreator creator)
IQuickAssistAssistantsetInformationControlCreator in interface IQuickAssistAssistantcreator - the information control creator for the additional information controlpublic void uninstall()
IQuickAssistAssistantuninstall in interface IQuickAssistAssistantpublic void setProposalSelectorBackground(Color background)
setProposalSelectorBackground in interface IQuickAssistAssistantbackground - the background colorpublic void setProposalSelectorForeground(Color foreground)
IQuickAssistAssistantsetProposalSelectorForeground in interface IQuickAssistAssistantforeground - the foreground colorprotected void possibleCompletionsClosed()
public void addCompletionListener(ICompletionListener listener)
IQuickAssistAssistantaddCompletionListener in interface IQuickAssistAssistantlistener - the listenerpublic void removeCompletionListener(ICompletionListener listener)
IQuickAssistAssistantremoveCompletionListener in interface IQuickAssistAssistantlistener - the listener to removepublic void setStatusLineVisible(boolean show)
IQuickAssistAssistantIQuickAssistAssistant.setStatusMessage(String).setStatusLineVisible in interface IQuickAssistAssistantshow - true to show a message line, false to not show one.public void setStatusMessage(String message)
IQuickAssistAssistantsetStatusMessage in interface IQuickAssistAssistantmessage - the messageGuidelines for using Eclipse APIs. Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.