Package com.intellij.codeInsight.template.postfix.templates

Class JavaPostfixTemplateProvider

java.lang.Object

com.intellij.codeInsight.template.postfix.templates.JavaPostfixTemplateProvider

All Implemented Interfaces:

PostfixTemplateProvider

public class JavaPostfixTemplateProvider
extends java.lang.Object
implements PostfixTemplateProvider

Constructor Summary

Constructors

Constructor and Description
JavaPostfixTemplateProvider()

Method Summary

Modifier and Type	Method and Description
void	afterExpand(PsiFile file, Editor editor) Invoked after template finished (doesn't matter if it finished successfully or not).
PostfixTemplateEditor	createEditor(PostfixTemplate templateToEdit) Return the editor that it able to represent template in UI and create the template from the settings that users set in UI.
java.lang.String	getId() Identifier of template provider.
java.lang.String	getPresentableName() Presentation name of editable template type.
java.util.Set<PostfixTemplate>	getTemplates() Returns builtin templates registered in the provider in their original state.
boolean	isTerminalSymbol(char currentChar) Check symbol can separate template keys
PsiFile	preCheck(PsiFile copyFile, Editor realEditor, int currentOffset) Prepare file for checking availability of templates.
void	preExpand(PsiFile file, Editor editor) Prepare file for template expanding.
JavaEditablePostfixTemplate	readExternalTemplate(java.lang.String id, java.lang.String name, Element template) Instantiates the template that was serialized by the provider to XML.
void	writeExternalTemplate(PostfixTemplate template, Element parentElement) Serialized to XML the template that was created by the provider.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaPostfixTemplateProvider

public JavaPostfixTemplateProvider()

Method Detail

getTemplates

public java.util.Set<PostfixTemplate> getTemplates()

Description copied from interface: PostfixTemplateProvider

Returns builtin templates registered in the provider in their original state. Consider using PostfixTemplatesUtils.getAvailableTemplates(PostfixTemplateProvider) for actually enabled templates.

Specified by:

getTemplates in interface PostfixTemplateProvider

getId

public java.lang.String getId()

Description copied from interface: PostfixTemplateProvider

Identifier of template provider. Used for storing settings of provider's templates.

Specified by:

getId in interface PostfixTemplateProvider

getPresentableName

public java.lang.String getPresentableName()

Description copied from interface: PostfixTemplateProvider

Presentation name of editable template type. If null, provider doesn't allow to custom templates.

Specified by:

getPresentableName in interface PostfixTemplateProvider

isTerminalSymbol

public boolean isTerminalSymbol(char currentChar)

Description copied from interface: PostfixTemplateProvider

Check symbol can separate template keys

Specified by:

isTerminalSymbol in interface PostfixTemplateProvider

preExpand

public void preExpand(PsiFile file,
                      Editor editor)

Description copied from interface: PostfixTemplateProvider

Prepare file for template expanding. Running on EDT. E.g. java postfix templates adds semicolon after caret in order to simplify context checking.

File content doesn't contain template's key, it is deleted just before this method invocation.

Note that while postfix template is checking its availability the file parameter is a _COPY_ of the real file, so you can do with it anything that you want, but in the same time it doesn't recommended to modify editor state because it's real.

Specified by:

preExpand in interface PostfixTemplateProvider

afterExpand

public void afterExpand(PsiFile file,
                        Editor editor)

Description copied from interface: PostfixTemplateProvider

Invoked after template finished (doesn't matter if it finished successfully or not). E.g. java postfix template use this method for deleting inserted semicolon.

Specified by:

afterExpand in interface PostfixTemplateProvider

preCheck

public PsiFile preCheck(PsiFile copyFile,
                        Editor realEditor,
                        int currentOffset)

Description copied from interface: PostfixTemplateProvider

Prepare file for checking availability of templates. Almost the same as this#preExpand(PsiFile, Editor) with several differences: 1. Processes copy of file. So implementations can modify it without corrupting the real file. 2. Could be invoked from anywhere (EDT, write-action, read-action, completion-thread etc.). So implementations should make additional effort to make changes in file.

Content of file copy doesn't contain template's key, it is deleted just before this method invocation.

NOTE: editor is real (not copy) and it doesn't represents the copyFile. So it's safer to use currentOffset parameter instead of offset from editor. Do not modify text via editor.

Specified by:

preCheck in interface PostfixTemplateProvider

createEditor

public PostfixTemplateEditor createEditor(PostfixTemplate templateToEdit)

Description copied from interface: PostfixTemplateProvider

Return the editor that it able to represent template in UI and create the template from the settings that users set in UI.

If templateToEdit is null, it's considered like an editor for a new template.

Specified by:

createEditor in interface PostfixTemplateProvider

readExternalTemplate

public JavaEditablePostfixTemplate readExternalTemplate(java.lang.String id,
                                                        java.lang.String name,
                                                        Element template)

Description copied from interface: PostfixTemplateProvider

Instantiates the template that was serialized by the provider to XML.

Specified by:

readExternalTemplate in interface PostfixTemplateProvider

writeExternalTemplate

public void writeExternalTemplate(PostfixTemplate template,
                                  Element parentElement)

Description copied from interface: PostfixTemplateProvider

Serialized to XML the template that was created by the provider.

Specified by:

writeExternalTemplate in interface PostfixTemplateProvider