Package com.intellij.codeInsight.template.impl

Class TemplateImpl

java.lang.Object

com.intellij.codeInsight.template.Template

com.intellij.codeInsight.template.impl.TemplateImpl

All Implemented Interfaces:

PresentableLookupValue, SchemeElement

public class TemplateImpl
extends Template
implements SchemeElement

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.codeInsight.template.Template

Template.Property

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARG
static java.lang.String	END
static java.util.Set<java.lang.String>	INTERNAL_VARS_SET
static java.lang.String	SELECTION

Constructor Summary

Constructors

Constructor and Description
TemplateImpl(java.lang.String key, java.lang.String group)
TemplateImpl(java.lang.String key, java.lang.String string, java.lang.String group)

Method Summary

Modifier and Type	Method and Description
void	addEndVariable()
void	addSelectionEndVariable()
void	addSelectionStartVariable()
void	addTextSegment(java.lang.String text)
Variable	addVariable(Expression expression, boolean isAlwaysStopAt)
Variable	addVariable(java.lang.String name, Expression expression, Expression defaultValueExpression, boolean isAlwaysStopAt, boolean skipOnStart)
Variable	addVariable(java.lang.String name, java.lang.String expression, java.lang.String defaultValue, boolean isAlwaysStopAt)
void	addVariableSegment(java.lang.String name)
void	applyContext(TemplateContext context)
void	applyOptions(java.util.Map<TemplateOptionalProcessor,java.lang.Boolean> context)
TemplateImpl	copy()
TemplateContext	createContext()
java.util.Map<TemplateOptionalProcessor,java.lang.Boolean>	createOptions()
boolean	equals(java.lang.Object o)
java.lang.String	getDefaultValueStringAt(int i)
java.lang.String	getDescription()
int	getEndSegmentNumber()
java.lang.String	getExpressionStringAt(int i)
java.lang.String	getGroupName()
java.lang.String	getId()
java.lang.String	getKey()
java.lang.String	getSegmentName(int i)
int	getSegmentOffset(int i)
int	getSegmentsCount()
char	getShortcutChar()
java.lang.String	getString()
TemplateContext	getTemplateContext()
java.lang.String	getTemplateText()
int	getVariableCount()
java.lang.String	getVariableNameAt(int i)
java.util.ArrayList<Variable>	getVariables()
boolean	hasArgument()
int	hashCode()
boolean	isAlwaysStopAt(int i)
boolean	isDeactivated()
boolean	isInline()
boolean	isSelectionTemplate()
boolean	isToIndent()
boolean	isToReformat()
boolean	isToShortenLongNames()
void	parseSegments()
void	removeAllParsed()
void	removeVariable(int i)
void	resetFrom(TemplateImpl another)
void	setDeactivated(boolean isDeactivated)
void	setDescription(java.lang.String value)
void	setGroupName(java.lang.String groupName)
void	setId(java.lang.String id)
void	setInline(boolean isInline) Inline templates do not insert text.
void	setKey(java.lang.String key)
void	setPrimarySegment(int segmentNumber)
void	setShortcutChar(char shortcutChar)
void	setString(java.lang.String string) Set template text as it appears in Live Template settings, including variables surrounded with '$'.
void	setToIndent(boolean toIndent)
void	setToReformat(boolean toReformat)
void	setToShortenLongNames(boolean toShortenLongNames)
java.lang.String	toString()

Methods inherited from class com.intellij.codeInsight.template.Template

addVariable, addVariable, getDefaultValue, getPresentation, getValue, setValue

Methods inherited from class java.lang.Object

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

Field Detail

END

public static final java.lang.String END

See Also:

Constant Field Values

SELECTION

public static final java.lang.String SELECTION

See Also:

Constant Field Values

ARG

public static final java.lang.String ARG

See Also:

Constant Field Values

INTERNAL_VARS_SET

public static final java.util.Set<java.lang.String> INTERNAL_VARS_SET

Constructor Detail

TemplateImpl

public TemplateImpl(java.lang.String key,
                    java.lang.String group)

TemplateImpl

public TemplateImpl(java.lang.String key,
                    java.lang.String string,
                    java.lang.String group)

Method Detail

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

isInline

public boolean isInline()

setInline

public void setInline(boolean isInline)

Description copied from class: Template

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.

Specified by:

setInline in class Template

See Also:

TemplateState.start(TemplateImpl, PairProcessor, Map)

addTextSegment

public void addTextSegment(java.lang.String text)

Specified by:

addTextSegment in class Template

addVariableSegment

public void addVariableSegment(java.lang.String name)

Specified by:

addVariableSegment in class Template

addVariable

public Variable addVariable(Expression expression,
                            boolean isAlwaysStopAt)

Specified by:

addVariable in class Template

addVariable

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

Specified by:

addVariable in class Template

addVariable

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

Specified by:

addVariable in class Template

addEndVariable

public void addEndVariable()

Specified by:

addEndVariable in class Template

addSelectionStartVariable

public void addSelectionStartVariable()

Specified by:

addSelectionStartVariable in class Template

addSelectionEndVariable

public void addSelectionEndVariable()

Specified by:

addSelectionEndVariable in class Template

getId

public java.lang.String getId()

Specified by:

getId in class Template

copy

public TemplateImpl copy()

Specified by:

copy in interface SchemeElement

resetFrom

public void resetFrom(TemplateImpl another)

isToReformat

public boolean isToReformat()

Specified by:

isToReformat in class Template

setToReformat

public void setToReformat(boolean toReformat)

Specified by:

setToReformat in class Template

setToIndent

public void setToIndent(boolean toIndent)

Specified by:

setToIndent in class Template

isToIndent

public boolean isToIndent()

isToShortenLongNames

public boolean isToShortenLongNames()

Specified by:

isToShortenLongNames in class Template

setToShortenLongNames

public void setToShortenLongNames(boolean toShortenLongNames)

Specified by:

setToShortenLongNames in class Template

setDeactivated

public void setDeactivated(boolean isDeactivated)

isDeactivated

public boolean isDeactivated()

getTemplateContext

public TemplateContext getTemplateContext()

getEndSegmentNumber

public int getEndSegmentNumber()

getTemplateText

public java.lang.String getTemplateText()

Specified by:

getTemplateText in class Template

Returns:

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

See Also:

Template.getString()

getSegmentName

public java.lang.String getSegmentName(int i)

Specified by:

getSegmentName in class Template

getSegmentOffset

public int getSegmentOffset(int i)

Specified by:

getSegmentOffset in class Template

getSegmentsCount

public int getSegmentsCount()

Specified by:

getSegmentsCount in class Template

parseSegments

public void parseSegments()

removeAllParsed

public void removeAllParsed()

removeVariable

public void removeVariable(int i)

getVariableCount

public int getVariableCount()

getVariableNameAt

public java.lang.String getVariableNameAt(int i)

getExpressionStringAt

public java.lang.String getExpressionStringAt(int i)

getDefaultValueStringAt

public java.lang.String getDefaultValueStringAt(int i)

isAlwaysStopAt

public boolean isAlwaysStopAt(int i)

getKey

public java.lang.String getKey()

Specified by:

getKey in interface SchemeElement

Specified by:

getKey in class Template

setKey

public void setKey(java.lang.String key)

getString

public java.lang.String getString()

Specified by:

getString in class Template

Returns:

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

See Also:

Template.getTemplateText()

setString

public void setString(java.lang.String string)

Set template text as it appears in Live Template settings, including variables surrounded with '$'. The text will be reparsed when needed.

Parameters:

string - template string text

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in class Template

setDescription

public void setDescription(java.lang.String value)

getShortcutChar

public char getShortcutChar()

setShortcutChar

public void setShortcutChar(char shortcutChar)

getGroupName

public java.lang.String getGroupName()

setGroupName

public void setGroupName(java.lang.String groupName)

Specified by:

setGroupName in interface SchemeElement

isSelectionTemplate

public boolean isSelectionTemplate()

hasArgument

public boolean hasArgument()

setId

public void setId(java.lang.String id)

createOptions

public java.util.Map<TemplateOptionalProcessor,java.lang.Boolean> createOptions()

createContext

public TemplateContext createContext()

applyOptions

public void applyOptions(java.util.Map<TemplateOptionalProcessor,java.lang.Boolean> context)

applyContext

public void applyContext(TemplateContext context)

getVariables

public java.util.ArrayList<Variable> getVariables()

setPrimarySegment

public void setPrimarySegment(int segmentNumber)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object