Package org.eclipse.xtext.ide.editor.contentassist

Class AbstractIdeTemplateProposalProvider

java.lang.Object

org.eclipse.xtext.ide.editor.contentassist.AbstractIdeTemplateProposalProvider

public abstract class AbstractIdeTemplateProposalProvider
extends java.lang.Object

Base class for adding template proposals from an IdeContentProposalProvider implementation. Use variable(String) and cursor() to generate edit positions and an exit position into the proposal, e.g.

 StringConcatenationClient template = new StringConcatenationClient() {
      @Override
      protected void appendTo(StringConcatenationClient.TargetStringConcatenation target) {
          target.append("state ");
          target.append(variable("name"));
          target.newLineIfNotEmpty();
          target.append("\t");
          target.append(cursor(), "\t");
          target.newLineIfNotEmpty();
          target.append("end");
          target.newLine();
      }
 };
 acceptProposal("state", "Create a new state", template, context, acceptor);
 

Since:

2.10

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractIdeTemplateProposalProvider.Cursor	Placeholder for the cursor (exit position) in a template.
protected static class	AbstractIdeTemplateProposalProvider.Variable	Placeholder for a variable (edit position) in a template.

Constructor Summary

Constructors

Constructor	Description
AbstractIdeTemplateProposalProvider()

Method Summary

Modifier and Type	Method	Description
protected void	acceptProposal(java.lang.String name, java.lang.String description, org.eclipse.xtend2.lib.StringConcatenationClient template, ContentAssistContext context, IIdeContentProposalAcceptor acceptor)
protected void	acceptProposal(java.lang.String name, java.lang.String description, org.eclipse.xtend2.lib.StringConcatenationClient template, ContentAssistContext context, IIdeContentProposalAcceptor acceptor, boolean adaptIndentation)
protected boolean	canAcceptProposal(ContentAssistEntry entry, ContentAssistContext context)
protected ContentAssistEntry	createProposal(org.eclipse.xtend2.lib.StringConcatenationClient template, ContentAssistContext context, boolean adaptIndentation)
protected AbstractIdeTemplateProposalProvider.Cursor	cursor()
protected java.lang.String	getIndentation(ContentAssistContext context)
protected java.lang.String	getLineDelimiter()
protected AbstractIdeTemplateProposalProvider.Variable	variable(java.lang.String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractIdeTemplateProposalProvider

public AbstractIdeTemplateProposalProvider()

Method Detail

variable

protected AbstractIdeTemplateProposalProvider.Variable variable(java.lang.String name)

cursor

protected AbstractIdeTemplateProposalProvider.Cursor cursor()

acceptProposal

protected void acceptProposal(java.lang.String name,
                              java.lang.String description,
                              org.eclipse.xtend2.lib.StringConcatenationClient template,
                              ContentAssistContext context,
                              IIdeContentProposalAcceptor acceptor)

acceptProposal

protected void acceptProposal(java.lang.String name,
                              java.lang.String description,
                              org.eclipse.xtend2.lib.StringConcatenationClient template,
                              ContentAssistContext context,
                              IIdeContentProposalAcceptor acceptor,
                              boolean adaptIndentation)

canAcceptProposal

protected boolean canAcceptProposal(ContentAssistEntry entry,
                                    ContentAssistContext context)

createProposal

protected ContentAssistEntry createProposal(org.eclipse.xtend2.lib.StringConcatenationClient template,
                                            ContentAssistContext context,
                                            boolean adaptIndentation)

getLineDelimiter

protected java.lang.String getLineDelimiter()

getIndentation

protected java.lang.String getIndentation(ContentAssistContext context)