Package com.intellij.codeInsight.template.impl

Class TemplateSettings

java.lang.Object

com.intellij.codeInsight.template.impl.TemplateSettings

All Implemented Interfaces:

PersistentStateComponent<com.intellij.codeInsight.template.impl.TemplateSettings.State>

public final class TemplateSettings
extends java.lang.Object
implements PersistentStateComponent<com.intellij.codeInsight.template.impl.TemplateSettings.State>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TemplateSettings.TemplateKey

Field Summary

Fields

Modifier and Type	Field and Description
static char	CUSTOM_CHAR
static char	DEFAULT_CHAR
static char	ENTER_CHAR
static char	NONE_CHAR
static char	SPACE_CHAR
static char	TAB_CHAR
static java.lang.String	TEMPLATE
static java.lang.String	USER_GROUP_NAME

Constructor Summary

Constructors

Constructor and Description
TemplateSettings()
TemplateSettings(SchemeManagerFactory factory)

Method Summary

Modifier and Type	Method and Description
void	addTemplate(Template template)
java.util.List<TemplateImpl>	collectMatchingCandidates(java.lang.String key, java.lang.Character shortcutChar, boolean hasArgument)
PluginInfo	findPluginForPredefinedTemplate(TemplateImpl template)
char	getDefaultShortcutChar()
TemplateImpl	getDefaultTemplate(TemplateImpl t)
java.util.List<TemplateSettings.TemplateKey>	getDeletedTemplates()
static TemplateSettings	getInstance()
java.lang.String	getLastSelectedTemplateGroup()
java.lang.String	getLastSelectedTemplateKey()
int	getMaxKeyLength()
char	getShortcutChar(TemplateImpl template)
com.intellij.codeInsight.template.impl.TemplateSettings.State	getState()
TemplateImpl	getTemplate(java.lang.String key, java.lang.String group)
Template	getTemplateById(java.lang.String id)
java.util.List<TemplateGroup>	getTemplateGroups()
TemplateImpl[]	getTemplates()
java.util.Collection<TemplateImpl>	getTemplates(java.lang.String key)
java.util.Collection<? extends TemplateImpl>	getTemplatesAsList()
void	loadState(com.intellij.codeInsight.template.impl.TemplateSettings.State state) This method is called when new component state is loaded.
static TemplateImpl	readTemplateFromElement(java.lang.String groupName, Element element, java.lang.ClassLoader classLoader)
void	removeTemplate(Template template)
void	reset()
static Element	serializeTemplate(TemplateImpl template, TemplateImpl defaultTemplate, <any> idToType)
void	setDefaultShortcutChar(char defaultShortcutChar)
void	setLastSelectedTemplate(java.lang.String group, java.lang.String key)
void	setTemplates(java.util.List<? extends TemplateGroup> newGroups)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.components.PersistentStateComponent

initializeComponent, noStateLoaded

Field Detail

USER_GROUP_NAME

public static final java.lang.String USER_GROUP_NAME

See Also:

Constant Field Values

TEMPLATE

public static final java.lang.String TEMPLATE

See Also:

Constant Field Values

SPACE_CHAR

public static final char SPACE_CHAR

See Also:

Constant Field Values

TAB_CHAR

public static final char TAB_CHAR

See Also:

Constant Field Values

ENTER_CHAR

public static final char ENTER_CHAR

See Also:

Constant Field Values

DEFAULT_CHAR

public static final char DEFAULT_CHAR

See Also:

Constant Field Values

CUSTOM_CHAR

public static final char CUSTOM_CHAR

See Also:

Constant Field Values

NONE_CHAR

public static final char NONE_CHAR

See Also:

Constant Field Values

Constructor Detail

TemplateSettings

public TemplateSettings()

TemplateSettings

public TemplateSettings(SchemeManagerFactory factory)

Method Detail

getInstance

public static TemplateSettings getInstance()

getDefaultTemplate

public TemplateImpl getDefaultTemplate(TemplateImpl t)

getState

public com.intellij.codeInsight.template.impl.TemplateSettings.State getState()

Specified by:

getState in interface PersistentStateComponent<com.intellij.codeInsight.template.impl.TemplateSettings.State>

Returns:

a component state. All properties, public and annotated fields are serialized. Only values, which differ from the default (i.e., the value of newly instantiated class) are serialized. null value indicates that the returned state won't be stored, as a result previously stored state will be used.

See Also:

XmlSerializer

loadState

public void loadState(com.intellij.codeInsight.template.impl.TemplateSettings.State state)

Description copied from interface: PersistentStateComponent

This method is called when new component state is loaded. The method can and will be called several times, if config files were externally changed while IDE was running.

State object should be used directly, defensive copying is not required.

Specified by:

loadState in interface PersistentStateComponent<com.intellij.codeInsight.template.impl.TemplateSettings.State>

Parameters:

state - loaded component state

See Also:

XmlSerializerUtil.copyBean(Object, Object)

getLastSelectedTemplateKey

public java.lang.String getLastSelectedTemplateKey()

getLastSelectedTemplateGroup

public java.lang.String getLastSelectedTemplateGroup()

setLastSelectedTemplate

public void setLastSelectedTemplate(java.lang.String group,
                                    java.lang.String key)

getTemplatesAsList

public java.util.Collection<? extends TemplateImpl> getTemplatesAsList()

getTemplates

public TemplateImpl[] getTemplates()

getDefaultShortcutChar

public char getDefaultShortcutChar()

setDefaultShortcutChar

public void setDefaultShortcutChar(char defaultShortcutChar)

getTemplates

public java.util.Collection<TemplateImpl> getTemplates(java.lang.String key)

getTemplate

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

getTemplateById

public Template getTemplateById(java.lang.String id)

getMaxKeyLength

public int getMaxKeyLength()

addTemplate

public void addTemplate(Template template)

removeTemplate

public void removeTemplate(Template template)

findPluginForPredefinedTemplate

public PluginInfo findPluginForPredefinedTemplate(TemplateImpl template)

readTemplateFromElement

public static TemplateImpl readTemplateFromElement(java.lang.String groupName,
                                                   Element element,
                                                   java.lang.ClassLoader classLoader)

serializeTemplate

public static Element serializeTemplate(TemplateImpl template,
                                        TemplateImpl defaultTemplate,
                                        <any> idToType)

setTemplates

public void setTemplates(java.util.List<? extends TemplateGroup> newGroups)

getTemplateGroups

public java.util.List<TemplateGroup> getTemplateGroups()

collectMatchingCandidates

public java.util.List<TemplateImpl> collectMatchingCandidates(java.lang.String key,
                                                              java.lang.Character shortcutChar,
                                                              boolean hasArgument)

getShortcutChar

public char getShortcutChar(TemplateImpl template)

getDeletedTemplates

public java.util.List<TemplateSettings.TemplateKey> getDeletedTemplates()

reset

public void reset()