Package com.intellij.codeInsight.template

Interface TemplateBuilder

All Known Implementing Classes:

TemplateBuilderImpl

public interface TemplateBuilder

Shows a live template-like chooser UI over a PSI element and offers the user to replace certain sub-elements of the specified element with values of his/her choice.

See Also:

TemplateBuilderFactory

Method Summary

Modifier and Type	Method and Description
void	replaceElement(PsiElement element, Expression expression) Creates a replacement box for the specified element with the specified expression.
void	replaceElement(PsiElement element, java.lang.String replacementText) Creates a replacement box for the specified element with the specified initial value.
void	replaceElement(PsiElement element, TextRange rangeWithinElement, Expression expression)
void	replaceElement(PsiElement element, TextRange rangeWithinElement, java.lang.String replacementText)
void	replaceRange(TextRange rangeWithinElement, Expression expression) Creates a replacement box for the specified text range within the container element.
void	replaceRange(TextRange rangeWithinElement, java.lang.String replacementText) Creates a replacement box for the specified text range within the container element.
void	run() Deprecated. does not work correctly for files with multiple editors use #run(Editor, boolean) instead
void	run(Editor editor, boolean inline) Shows the live template and initiates editing process.

Method Detail

replaceElement

void replaceElement(PsiElement element,
                    java.lang.String replacementText)

Creates a replacement box for the specified element with the specified initial value.

Parameters:

element - the element to replace.

replacementText - the initial value for the replacement.

replaceElement

void replaceElement(PsiElement element,
                    TextRange rangeWithinElement,
                    java.lang.String replacementText)

replaceElement

void replaceElement(PsiElement element,
                    Expression expression)

Creates a replacement box for the specified element with the specified expression.

Parameters:

element - the element to replace.

expression - the replacement expression.

replaceElement

void replaceElement(PsiElement element,
                    TextRange rangeWithinElement,
                    Expression expression)

replaceRange

void replaceRange(TextRange rangeWithinElement,
                  java.lang.String replacementText)

Creates a replacement box for the specified text range within the container element.

Parameters:

rangeWithinElement - range within the container element.

replacementText - the initial value for the replacement.

replaceRange

void replaceRange(TextRange rangeWithinElement,
                  Expression expression)

Creates a replacement box for the specified text range within the container element.

Parameters:

rangeWithinElement - range within the container element.

expression - the replacement expression.

run

@Deprecated
void run()

Deprecated. does not work correctly for files with multiple editors use #run(Editor, boolean) instead

Shows the live template and initiates editing process.

run

void run(Editor editor,
         boolean inline)

Shows the live template and initiates editing process.

Parameters:

editor - editor to use to start editing process.

inline - if true then inline template will be created, regular otherwise