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

Class PostfixTemplate

java.lang.Object

com.intellij.codeInsight.template.postfix.templates.PostfixTemplate

Direct Known Subclasses:

EditablePostfixTemplate, InstanceofExpressionPostfixTemplate, PostfixTemplateWithExpressionSelector, PostfixTemplateWrapper, TryStatementPostfixTemplate, TryWithResourcesPostfixTemplate

public abstract class PostfixTemplate
extends java.lang.Object

Represents a postfix template.

EDITABLE TEMPLATES ================== Editable postfix template MUST know the provider that created it.

Editable postfix templates MUST provide proper equals/hashCode implementation. Equal postfix templates produces by the very same provider will overwrite each other.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PostfixTemplate(java.lang.String name, java.lang.String example) Deprecated. use PostfixTemplate(String, String, String, PostfixTemplateProvider)
protected	PostfixTemplate(java.lang.String name, java.lang.String key, java.lang.String example) Deprecated. use PostfixTemplate(String, String, String, String, PostfixTemplateProvider)
protected	PostfixTemplate(java.lang.String id, java.lang.String name, java.lang.String example, PostfixTemplateProvider provider)
protected	PostfixTemplate(java.lang.String id, java.lang.String name, java.lang.String key, java.lang.String example, PostfixTemplateProvider provider)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	calcDescription()
boolean	equals(java.lang.Object o)
abstract void	expand(PsiElement context, Editor editor)
java.lang.String	getDescription()
java.lang.String	getExample()
java.lang.String	getId() Template's identifier.
java.lang.String	getKey() Template's key.
java.lang.String	getPresentableName()
PostfixTemplateProvider	getProvider()
int	hashCode()
abstract boolean	isApplicable(PsiElement context, Document copyDocument, int newOffset)
boolean	isBuiltin() Builtin templates cannot be removed.
boolean	isEditable() Template can be edit.
boolean	isEnabled(PostfixTemplateProvider provider)
boolean	startInWriteAction()

Methods inherited from class java.lang.Object

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

Constructor Detail

PostfixTemplate

@Deprecated
protected PostfixTemplate(java.lang.String name,
                          java.lang.String example)

Deprecated. use PostfixTemplate(String, String, String, PostfixTemplateProvider)

PostfixTemplate

protected PostfixTemplate(java.lang.String id,
                          java.lang.String name,
                          java.lang.String example,
                          PostfixTemplateProvider provider)

PostfixTemplate

@Deprecated
protected PostfixTemplate(java.lang.String name,
                          java.lang.String key,
                          java.lang.String example)

Deprecated. use PostfixTemplate(String, String, String, String, PostfixTemplateProvider)

PostfixTemplate

protected PostfixTemplate(java.lang.String id,
                          java.lang.String name,
                          java.lang.String key,
                          java.lang.String example,
                          PostfixTemplateProvider provider)

Method Detail

calcDescription

protected java.lang.String calcDescription()

getId

public java.lang.String getId()

Template's identifier. Used for saving the settings related to this templates.

getKey

public final java.lang.String getKey()

Template's key. Used while expanding template in editor.

Returns:

getPresentableName

public java.lang.String getPresentableName()

getDescription

public java.lang.String getDescription()

getExample

public java.lang.String getExample()

startInWriteAction

public boolean startInWriteAction()

isEnabled

public boolean isEnabled(PostfixTemplateProvider provider)

isApplicable

public abstract boolean isApplicable(PsiElement context,
                                     Document copyDocument,
                                     int newOffset)

expand

public abstract void expand(PsiElement context,
                            Editor editor)

getProvider

public PostfixTemplateProvider getProvider()

isBuiltin

public boolean isBuiltin()

Builtin templates cannot be removed. If they are editable, they can be restored to default.

isEditable

public boolean isEditable()

Template can be edit. Template can be editable if its provider is not null and its key starts with . can be edited.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object