org.eclipse.xtext.ui.editor.templates
Class XtextTemplateContext

java.lang.Object
  org.eclipse.jface.text.templates.TemplateContext
      org.eclipse.jface.text.templates.DocumentTemplateContext
          org.eclipse.xtext.ui.editor.templates.XtextTemplateContext

public class XtextTemplateContext
extends org.eclipse.jface.text.templates.DocumentTemplateContext

Represents an extended version of class DocumentTemplateContext to provide additional Xtext related information and services for resolving a Template. Furthermore it fixes the indentation of the applied template.

Author:

Michael Clay - Initial contribution and API, Sebastian Zarnekow

Nested Class Summary

static class

XtextTemplateContext.IndentationAwareTemplateTranslator

Constructor Summary

XtextTemplateContext(org.eclipse.jface.text.templates.TemplateContextType type, org.eclipse.jface.text.IDocument document, org.eclipse.jface.text.Position position, ContentAssistContext contentAssistContext, IScopeProvider scopeProvider)

Method Summary

protected org.eclipse.jface.text.templates.TemplateTranslator	createTemplateTranslator()
org.eclipse.jface.text.templates.TemplateBuffer	evaluate(org.eclipse.jface.text.templates.Template template)
org.eclipse.jface.text.templates.TemplateBuffer	evaluateForDisplay(org.eclipse.jface.text.templates.Template template)
ContentAssistContext	getContentAssistContext()
IScopeProvider	getScopeProvider()

Methods inherited from class org.eclipse.jface.text.templates.DocumentTemplateContext

canEvaluate, getCompletionLength, getCompletionOffset, getDocument, getEnd, getKey, getStart, setCompletionLength, setCompletionOffset

Methods inherited from class org.eclipse.jface.text.templates.TemplateContext

getContextType, getVariable, isReadOnly, setReadOnly, setVariable

Methods inherited from class java.lang.Object

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

Constructor Detail

XtextTemplateContext

public XtextTemplateContext(org.eclipse.jface.text.templates.TemplateContextType type,
                            org.eclipse.jface.text.IDocument document,
                            org.eclipse.jface.text.Position position,
                            ContentAssistContext contentAssistContext,
                            IScopeProvider scopeProvider)

Method Detail

getContentAssistContext

public ContentAssistContext getContentAssistContext()

Returns:

the contentAssistContext

getScopeProvider

public IScopeProvider getScopeProvider()

Returns:

the linkingCandidatesService

evaluate

public org.eclipse.jface.text.templates.TemplateBuffer evaluate(org.eclipse.jface.text.templates.Template template)
                                                         throws org.eclipse.jface.text.BadLocationException,
                                                                org.eclipse.jface.text.templates.TemplateException

Overrides:

evaluate in class org.eclipse.jface.text.templates.DocumentTemplateContext

Throws:

org.eclipse.jface.text.BadLocationException

org.eclipse.jface.text.templates.TemplateException

evaluateForDisplay

public org.eclipse.jface.text.templates.TemplateBuffer evaluateForDisplay(org.eclipse.jface.text.templates.Template template)
                                                                   throws org.eclipse.jface.text.BadLocationException,
                                                                          org.eclipse.jface.text.templates.TemplateException

Throws:

org.eclipse.jface.text.BadLocationException

org.eclipse.jface.text.templates.TemplateException

Since:

2.3

createTemplateTranslator

protected org.eclipse.jface.text.templates.TemplateTranslator createTemplateTranslator()