org.eclipse.xtext.ui.editor.contentassist
Class AbstractContentProposalProvider

java.lang.Object
  extended by org.eclipse.xtext.ui.editor.contentassist.AbstractContentProposalProvider
All Implemented Interfaces:
ICompletionProposalFactory, IContentProposalProvider
Direct Known Subclasses:
AbstractJavaBasedContentProposalProvider

public abstract class AbstractContentProposalProvider
extends java.lang.Object
implements IContentProposalProvider, ICompletionProposalFactory

The default implementation of interface IContentProposalProvider provided with Xtext.

Author:
Michael Clay - Initial contribution and API, Sebastian Zarnekow - Initial contribution and API, Heiko Behrens, Jan Köhnlein

Nested Class Summary
 class AbstractContentProposalProvider.DefaultContentAssistProcessorSwitch
           
static class AbstractContentProposalProvider.NullSafeCompletionProposalAcceptor
           
 
Constructor Summary
AbstractContentProposalProvider()
           
 
Method Summary
abstract  void completeAssignment(Assignment object, ContentAssistContext context, ICompletionProposalAcceptor acceptor)
           
abstract  void completeKeyword(Keyword object, ContentAssistContext context, ICompletionProposalAcceptor acceptor)
           
abstract  void completeRuleCall(RuleCall object, ContentAssistContext context, ICompletionProposalAcceptor acceptor)
           
protected  org.eclipse.jface.text.contentassist.ICompletionProposal createCompletionProposal(java.lang.String proposal, ContentAssistContext contentAssistContext)
           
 org.eclipse.jface.text.contentassist.ICompletionProposal createCompletionProposal(java.lang.String proposal, java.lang.String displayString, org.eclipse.swt.graphics.Image image, ContentAssistContext contentAssistContext)
           
 org.eclipse.jface.text.contentassist.ICompletionProposal createCompletionProposal(java.lang.String proposal, org.eclipse.jface.viewers.StyledString displayString, org.eclipse.swt.graphics.Image image, ContentAssistContext contentAssistContext)
           
protected  org.eclipse.jface.text.contentassist.ICompletionProposal createCompletionProposal(java.lang.String proposal, org.eclipse.jface.viewers.StyledString displayString, org.eclipse.swt.graphics.Image image, int priority, java.lang.String prefix, ContentAssistContext context)
           
 void createProposals(ContentAssistContext context, ICompletionProposalAcceptor acceptor)
           
 IFollowElementAcceptor createSelector(ContentAssistContext context, ICompletionProposalAcceptor acceptor)
           
protected  ConfigurableCompletionProposal doCreateProposal(java.lang.String proposal, org.eclipse.jface.viewers.StyledString displayString, org.eclipse.swt.graphics.Image image, int priority, ContentAssistContext context)
           
protected  ConfigurableCompletionProposal doCreateProposal(java.lang.String proposal, org.eclipse.jface.viewers.StyledString displayString, org.eclipse.swt.graphics.Image image, int replacementOffset, int replacementLength)
           
 IProposalConflictHelper getConflictHelper()
           
protected  java.lang.String getDisplayString(org.eclipse.emf.ecore.EObject element, java.lang.String qualifiedNameAsString, java.lang.String shortName)
           
protected  org.eclipse.swt.graphics.Image getImage(org.eclipse.emf.ecore.EObject eObject)
          Returns the image for the label of the given element.
protected  org.eclipse.jface.viewers.StyledString getKeywordDisplayString(Keyword keyword)
           
 org.eclipse.jface.viewers.ILabelProvider getLabelProvider()
           
 IContentProposalPriorities getPriorityHelper()
           
 IQualifiedNameConverter getQualifiedNameConverter()
           
protected  org.eclipse.jface.viewers.StyledString getStyledDisplayString(org.eclipse.emf.ecore.EObject element, java.lang.String qualifiedName, java.lang.String shortName)
           
protected  org.eclipse.jface.viewers.StyledString getStyledDisplayString(IEObjectDescription description)
           
 IValueConverterService getValueConverter()
           
protected  boolean isValidProposal(java.lang.String proposal, java.lang.String prefix, ContentAssistContext context)
           
 void setConflictHelper(IProposalConflictHelper conflictHelper)
           
 void setLabelProvider(org.eclipse.jface.viewers.ILabelProvider labelProvider)
           
 void setPriorityHelper(IContentProposalPriorities priorities)
           
 void setValueConverter(IValueConverterService valueConverter)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractContentProposalProvider

public AbstractContentProposalProvider()
Method Detail

createProposals

public void createProposals(ContentAssistContext context,
                            ICompletionProposalAcceptor acceptor)
Specified by:
createProposals in interface IContentProposalProvider

completeKeyword

public abstract void completeKeyword(Keyword object,
                                     ContentAssistContext context,
                                     ICompletionProposalAcceptor acceptor)

completeRuleCall

public abstract void completeRuleCall(RuleCall object,
                                      ContentAssistContext context,
                                      ICompletionProposalAcceptor acceptor)

completeAssignment

public abstract void completeAssignment(Assignment object,
                                        ContentAssistContext context,
                                        ICompletionProposalAcceptor acceptor)

createSelector

public IFollowElementAcceptor createSelector(ContentAssistContext context,
                                             ICompletionProposalAcceptor acceptor)

createCompletionProposal

public org.eclipse.jface.text.contentassist.ICompletionProposal createCompletionProposal(java.lang.String proposal,
                                                                                         java.lang.String displayString,
                                                                                         org.eclipse.swt.graphics.Image image,
                                                                                         ContentAssistContext contentAssistContext)

createCompletionProposal

protected org.eclipse.jface.text.contentassist.ICompletionProposal createCompletionProposal(java.lang.String proposal,
                                                                                            ContentAssistContext contentAssistContext)

createCompletionProposal

public org.eclipse.jface.text.contentassist.ICompletionProposal createCompletionProposal(java.lang.String proposal,
                                                                                         org.eclipse.jface.viewers.StyledString displayString,
                                                                                         org.eclipse.swt.graphics.Image image,
                                                                                         ContentAssistContext contentAssistContext)
Specified by:
createCompletionProposal in interface ICompletionProposalFactory

createCompletionProposal

protected org.eclipse.jface.text.contentassist.ICompletionProposal createCompletionProposal(java.lang.String proposal,
                                                                                            org.eclipse.jface.viewers.StyledString displayString,
                                                                                            org.eclipse.swt.graphics.Image image,
                                                                                            int priority,
                                                                                            java.lang.String prefix,
                                                                                            ContentAssistContext context)
See Also:
isValidProposal(String, String, ContentAssistContext), #doCreateProposal(String, String, Image, int, ContentAssistContext)

isValidProposal

protected boolean isValidProposal(java.lang.String proposal,
                                  java.lang.String prefix,
                                  ContentAssistContext context)

doCreateProposal

protected ConfigurableCompletionProposal doCreateProposal(java.lang.String proposal,
                                                          org.eclipse.jface.viewers.StyledString displayString,
                                                          org.eclipse.swt.graphics.Image image,
                                                          int priority,
                                                          ContentAssistContext context)

doCreateProposal

protected ConfigurableCompletionProposal doCreateProposal(java.lang.String proposal,
                                                          org.eclipse.jface.viewers.StyledString displayString,
                                                          org.eclipse.swt.graphics.Image image,
                                                          int replacementOffset,
                                                          int replacementLength)

getKeywordDisplayString

protected org.eclipse.jface.viewers.StyledString getKeywordDisplayString(Keyword keyword)

getStyledDisplayString

protected org.eclipse.jface.viewers.StyledString getStyledDisplayString(IEObjectDescription description)

getStyledDisplayString

protected org.eclipse.jface.viewers.StyledString getStyledDisplayString(org.eclipse.emf.ecore.EObject element,
                                                                        java.lang.String qualifiedName,
                                                                        java.lang.String shortName)

getDisplayString

protected java.lang.String getDisplayString(org.eclipse.emf.ecore.EObject element,
                                            java.lang.String qualifiedNameAsString,
                                            java.lang.String shortName)

setValueConverter

public void setValueConverter(IValueConverterService valueConverter)

getValueConverter

public IValueConverterService getValueConverter()

getImage

protected org.eclipse.swt.graphics.Image getImage(org.eclipse.emf.ecore.EObject eObject)
Returns the image for the label of the given element.

Parameters:
element - the element for which to provide the label image
Returns:
the image used to label the element, or null if there is no image for the given object

setConflictHelper

public void setConflictHelper(IProposalConflictHelper conflictHelper)

getConflictHelper

public IProposalConflictHelper getConflictHelper()

setPriorityHelper

public void setPriorityHelper(IContentProposalPriorities priorities)

getPriorityHelper

public IContentProposalPriorities getPriorityHelper()

getQualifiedNameConverter

public IQualifiedNameConverter getQualifiedNameConverter()

setLabelProvider

public void setLabelProvider(org.eclipse.jface.viewers.ILabelProvider labelProvider)

getLabelProvider

public org.eclipse.jface.viewers.ILabelProvider getLabelProvider()