Package com.intellij.codeInsight.template.impl

Interface TemplateOptionalProcessor

All Known Implementing Classes:

CodeBlockReformattingProcessor, GroovyShortenFQNamesProcessor, ShortenFQNamesProcessor, ShortenToStaticImportProcessor

public interface TemplateOptionalProcessor

An extension controlling aspects of Live Template insertion, like reformatting, adding imports, etc. getOptionName() allows to show a checkbox to enable/disable specific such aspect in Live Template settings, processText(com.intellij.openapi.project.Project, com.intellij.codeInsight.template.Template, com.intellij.openapi.editor.Document, com.intellij.openapi.editor.RangeMarker, com.intellij.openapi.editor.Editor) does the actual modifications during live template expansion.

During indexing, processText(com.intellij.openapi.project.Project, com.intellij.codeInsight.template.Template, com.intellij.openapi.editor.Document, com.intellij.openapi.editor.RangeMarker, com.intellij.openapi.editor.Editor) is executed only for instances implementing DumbAware.

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<TemplateOptionalProcessor>	EP_NAME

Method Summary

Modifier and Type	Method and Description
java.lang.String	getOptionName()
boolean	isEnabled(Template template)
default boolean	isVisible(Template template) Deprecated. Please override isVisible(Template, TemplateContext)
default boolean	isVisible(Template template, TemplateContext context)
void	processText(Project project, Template template, Document document, RangeMarker templateRange, Editor editor) Invoked inside a write action when a live template is finished.
default void	setEnabled(Template template, boolean value) Change whether this processor is enabled for a given template.

Field Detail

EP_NAME

static final ExtensionPointName<TemplateOptionalProcessor> EP_NAME

Method Detail

processText

void processText(Project project,
                 Template template,
                 Document document,
                 RangeMarker templateRange,
                 Editor editor)

Invoked inside a write action when a live template is finished. Note that this happens even if the corresponding option is disabled, so the implementations should check themselves whether they have to perform any actions.

getOptionName

java.lang.String getOptionName()

Returns:

the text of a checkbox in Live Template settings controlling whether this option is enabled.

isEnabled

boolean isEnabled(Template template)

Returns:

whether this processor is enabled for a given template

setEnabled

default void setEnabled(Template template,
                        boolean value)

Change whether this processor is enabled for a given template. It's invoked, for example, when a user changes the value of the corresponding checkbox in Live template settings.

isVisible

default boolean isVisible(Template template,
                          TemplateContext context)

Returns:

whether a checkbox for this template should be shown in the configuration dialog, with the given template context.

isVisible

@Deprecated
default boolean isVisible(Template template)

Deprecated. Please override isVisible(Template, TemplateContext)