Package com.intellij.codeInsight.template

Class Template

java.lang.Object

com.intellij.codeInsight.template.Template

All Implemented Interfaces:

PresentableLookupValue

Direct Known Subclasses:

TemplateImpl

public abstract class Template
extends java.lang.Object
implements PresentableLookupValue

Used to build and run a live template.

See Also:

TemplateManager

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Template.Property

Constructor Summary

Constructors

Constructor and Description
Template()

Method Summary

Modifier and Type	Method and Description
abstract void	addEndVariable()
abstract void	addSelectionEndVariable()
abstract void	addSelectionStartVariable()
abstract void	addTextSegment(java.lang.String text)
abstract Variable	addVariable(Expression expression, boolean isAlwaysStopAt)
Variable	addVariable(java.lang.String name, Expression defaultValueExpression, boolean isAlwaysStopAt)
Variable	addVariable(java.lang.String name, Expression expression, Expression defaultValueExpression, boolean isAlwaysStopAt)
abstract Variable	addVariable(java.lang.String name, Expression expression, Expression defaultValueExpression, boolean isAlwaysStopAt, boolean skipOnStart)
abstract Variable	addVariable(java.lang.String name, java.lang.String expression, java.lang.String defaultValueExpression, boolean isAlwaysStopAt)
abstract void	addVariableSegment(java.lang.String name)
static boolean	getDefaultValue(Template.Property key)
abstract java.lang.String	getDescription()
abstract java.lang.String	getId()
abstract java.lang.String	getKey()
java.lang.String	getPresentation()
abstract java.lang.String	getSegmentName(int segmentIndex)
abstract int	getSegmentOffset(int segmentIndex)
abstract int	getSegmentsCount()
abstract java.lang.String	getString()
abstract java.lang.String	getTemplateText()
boolean	getValue(Template.Property key)
abstract boolean	isToReformat()
abstract boolean	isToShortenLongNames()
abstract void	setInline(boolean isInline) Inline templates do not insert text.
abstract void	setToIndent(boolean toIndent)
abstract void	setToReformat(boolean toReformat)
abstract void	setToShortenLongNames(boolean toShortenLongNames)
void	setValue(Template.Property key, boolean value)

Methods inherited from class java.lang.Object

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

Constructor Detail

Template

public Template()

Method Detail

addTextSegment

public abstract void addTextSegment(java.lang.String text)

addVariableSegment

public abstract void addVariableSegment(java.lang.String name)

addVariable

public Variable addVariable(java.lang.String name,
                            Expression defaultValueExpression,
                            boolean isAlwaysStopAt)

addVariable

public abstract Variable addVariable(Expression expression,
                                     boolean isAlwaysStopAt)

addVariable

public Variable addVariable(java.lang.String name,
                            Expression expression,
                            Expression defaultValueExpression,
                            boolean isAlwaysStopAt)

addVariable

public abstract Variable addVariable(java.lang.String name,
                                     Expression expression,
                                     Expression defaultValueExpression,
                                     boolean isAlwaysStopAt,
                                     boolean skipOnStart)

addVariable

public abstract Variable addVariable(java.lang.String name,
                                     java.lang.String expression,
                                     java.lang.String defaultValueExpression,
                                     boolean isAlwaysStopAt)

addEndVariable

public abstract void addEndVariable()

addSelectionStartVariable

public abstract void addSelectionStartVariable()

addSelectionEndVariable

public abstract void addSelectionEndVariable()

getId

public abstract java.lang.String getId()

getKey

public abstract java.lang.String getKey()

getDescription

public abstract java.lang.String getDescription()

isToReformat

public abstract boolean isToReformat()

setToReformat

public abstract void setToReformat(boolean toReformat)

setToIndent

public abstract void setToIndent(boolean toIndent)

setInline

public abstract void setInline(boolean isInline)

Inline templates do not insert text. They install editing segments (red rectangles) in existing text in document: from the `caret offset` to `caret offset + templateString length`. E.g. they might be useful for inplace rename.

See Also:

TemplateState.start(TemplateImpl, PairProcessor, Map)

getSegmentsCount

public abstract int getSegmentsCount()

getSegmentName

public abstract java.lang.String getSegmentName(int segmentIndex)

getSegmentOffset

public abstract int getSegmentOffset(int segmentIndex)

getString

public abstract java.lang.String getString()

Returns:

template text as it appears in Live Template settings, including variables surrounded with '$'

See Also:

getTemplateText()

getTemplateText

public abstract java.lang.String getTemplateText()

Returns:

template text without any variables and with '$' character escapes removed.

See Also:

getString()

isToShortenLongNames

public abstract boolean isToShortenLongNames()

setToShortenLongNames

public abstract void setToShortenLongNames(boolean toShortenLongNames)

getValue

public boolean getValue(Template.Property key)

setValue

public void setValue(Template.Property key,
                     boolean value)

getDefaultValue

public static boolean getDefaultValue(Template.Property key)

getPresentation

public java.lang.String getPresentation()

Specified by:

getPresentation in interface PresentableLookupValue