org.eclipse.xtext.ui.editor.templates

Class AbstractTemplateProposalProvider

java.lang.Object

org.eclipse.xtext.ui.editor.templates.AbstractTemplateProposalProvider

All Implemented Interfaces:

ITemplateProposalProvider

Direct Known Subclasses:

DefaultTemplateProposalProvider

public abstract class AbstractTemplateProposalProvider
extends Object
implements ITemplateProposalProvider

Provides an abstract implementation of interface ITemplateProposalProvider.

Author:

Michael Clay - Initial contribution and API, Sebastian Zarnekow - Initial contribution and API

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractTemplateProposalProvider.NullSafeTemplateAcceptor

Constructor Summary

Constructors

Constructor and Description
AbstractTemplateProposalProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.eclipse.jface.text.Position	createPosition(ContentAssistContext context) Positions created for template contexts have to be added to the document so they are updated when the document is modified.
protected org.eclipse.jface.text.templates.TemplateProposal	createProposal(org.eclipse.jface.text.templates.Template template, org.eclipse.jface.text.templates.TemplateContext templateContext, ContentAssistContext context, org.eclipse.swt.graphics.Image image, int relevance)
protected org.eclipse.jface.text.templates.TemplateContext[]	createTemplateContexts(ContentAssistContext context)
void	createTemplates(ContentAssistContext context, ITemplateAcceptor acceptor)
protected abstract void	createTemplates(org.eclipse.jface.text.templates.TemplateContext templateContext, ContentAssistContext context, ITemplateAcceptor acceptor)
protected org.eclipse.jface.text.templates.TemplateProposal	doCreateProposal(org.eclipse.jface.text.templates.Template template, org.eclipse.jface.text.templates.TemplateContext templateContext, ContentAssistContext context, org.eclipse.swt.graphics.Image image, int relevance)
protected org.eclipse.jface.text.templates.TemplateContext	doCreateTemplateContext(org.eclipse.jface.text.templates.TemplateContextType contextType, ContentAssistContext context)
protected abstract org.eclipse.jface.text.templates.TemplateContextType[]	getContextTypes(ContentAssistContext context)
protected IScopeProvider	getScopeProvider()
void	setScopeProvider(IScopeProvider scopeProvider)
protected boolean	validate(org.eclipse.jface.text.templates.Template template, ContentAssistContext context)
protected boolean	validate(org.eclipse.jface.text.templates.Template template, org.eclipse.jface.text.templates.TemplateContext context)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractTemplateProposalProvider

public AbstractTemplateProposalProvider()

Method Detail

setScopeProvider

@Inject
public void setScopeProvider(IScopeProvider scopeProvider)

getScopeProvider

protected IScopeProvider getScopeProvider()

Since:

2.7

createTemplates

public void createTemplates(ContentAssistContext context,
                   ITemplateAcceptor acceptor)

Specified by:

createTemplates in interface ITemplateProposalProvider

createTemplates

protected abstract void createTemplates(org.eclipse.jface.text.templates.TemplateContext templateContext,
                   ContentAssistContext context,
                   ITemplateAcceptor acceptor)

createProposal

protected org.eclipse.jface.text.templates.TemplateProposal createProposal(org.eclipse.jface.text.templates.Template template,
                                                               org.eclipse.jface.text.templates.TemplateContext templateContext,
                                                               ContentAssistContext context,
                                                               org.eclipse.swt.graphics.Image image,
                                                               int relevance)

doCreateProposal

protected org.eclipse.jface.text.templates.TemplateProposal doCreateProposal(org.eclipse.jface.text.templates.Template template,
                                                                 org.eclipse.jface.text.templates.TemplateContext templateContext,
                                                                 ContentAssistContext context,
                                                                 org.eclipse.swt.graphics.Image image,
                                                                 int relevance)

validate

protected boolean validate(org.eclipse.jface.text.templates.Template template,
               ContentAssistContext context)

validate

protected boolean validate(org.eclipse.jface.text.templates.Template template,
               org.eclipse.jface.text.templates.TemplateContext context)

createTemplateContexts

protected org.eclipse.jface.text.templates.TemplateContext[] createTemplateContexts(ContentAssistContext context)

doCreateTemplateContext

protected org.eclipse.jface.text.templates.TemplateContext doCreateTemplateContext(org.eclipse.jface.text.templates.TemplateContextType contextType,
                                                                       ContentAssistContext context)

createPosition

protected org.eclipse.jface.text.Position createPosition(ContentAssistContext context)

Positions created for template contexts have to be added to the document so they are updated when the document is modified.

Since:

2.8

getContextTypes

protected abstract org.eclipse.jface.text.templates.TemplateContextType[] getContextTypes(ContentAssistContext context)