Package com.intellij.ide.fileTemplates.impl

Class FileTemplateManagerImpl

java.lang.Object

com.intellij.ide.fileTemplates.FileTemplateManager

com.intellij.ide.fileTemplates.impl.FileTemplateManagerImpl

All Implemented Interfaces:

PersistentStateComponent<FileTemplateManagerImpl.State>

public final class FileTemplateManagerImpl
extends FileTemplateManager
implements PersistentStateComponent<FileTemplateManagerImpl.State>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileTemplateManagerImpl.State

Field Summary

Fields inherited from class com.intellij.ide.fileTemplates.FileTemplateManager

CODE_TEMPLATES_CATEGORY, DEFAULT_TEMPLATE_PROPERTIES, DEFAULT_TEMPLATES_CATEGORY, FILE_HEADER_TEMPLATE_NAME, INCLUDES_TEMPLATES_CATEGORY, INTERNAL_HTML_TEMPLATE_NAME, INTERNAL_HTML5_TEMPLATE_NAME, INTERNAL_TEMPLATES_CATEGORY, INTERNAL_XHTML_TEMPLATE_NAME, J2EE_TEMPLATES_CATEGORY, PROJECT_NAME_VARIABLE, RECENT_TEMPLATES_SIZE

Method Summary

Modifier and Type	Method and Description
void	addRecentName(java.lang.String name)
FileTemplate	addTemplate(java.lang.String name, java.lang.String extension) Creates a new template with specified name, and adds it to the list of default templates.
protected FileTemplateManager	checkInitialized()
FileTemplate	findInternalTemplate(java.lang.String templateName)
FileTemplate []	getAllCodeTemplates()
FileTemplate []	getAllJ2eeTemplates()
FileTemplate []	getAllPatterns()
FileTemplate []	getAllTemplates() Returns all templates from "Default" category.
FileTemplate	getCodeTemplate(java.lang.String templateName)
FileTemplatesScheme	getCurrentScheme()
java.util.Properties	getDefaultProperties()
FileTemplate	getDefaultTemplate(java.lang.String name) Returns template with default (bundled) text.
java.net.URL	getDefaultTemplateDescription()
static FileTemplateManagerImpl	getInstanceImpl(Project project)
FileTemplate	getInternalTemplate(java.lang.String templateName)
FileTemplate []	getInternalTemplates()
FileTemplate	getJ2eeTemplate(java.lang.String templateName)
FileTemplate	getPattern(java.lang.String name)
FileTemplatesScheme	getProjectScheme()
java.util.Collection<java.lang.String>	getRecentNames()
FileTemplateManagerImpl.State	getState()
FileTemplate	getTemplate(java.lang.String templateName)
FileTemplate []	getTemplates(java.lang.String category)
java.lang.String	internalTemplateToSubject(java.lang.String templateName)
void	loadState(FileTemplateManagerImpl.State state) This method is called when new component state is loaded.
void	removeTemplate(FileTemplate template)
void	saveAllTemplates()
void	setCurrentScheme(FileTemplatesScheme scheme)
void	setDefaultFileIncludeTemplateTextTemporarilyForTest(java.lang.String simpleName, java.lang.String text, Disposable parentDisposable)
void	setTemplates(java.lang.String templatesCategory, java.util.Collection<? extends FileTemplate> templates)
void	setTestDate(java.util.Date testDate)

Methods inherited from class com.intellij.ide.fileTemplates.FileTemplateManager

getDefaultInstance, getDefaultProperties, getInstance, getInstance

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

Method Detail

getInstanceImpl

public static FileTemplateManagerImpl getInstanceImpl(Project project)

getCurrentScheme

public FileTemplatesScheme getCurrentScheme()

Specified by:

getCurrentScheme in class FileTemplateManager

setCurrentScheme

public void setCurrentScheme(FileTemplatesScheme scheme)

Specified by:

setCurrentScheme in class FileTemplateManager

checkInitialized

protected FileTemplateManager checkInitialized()

Overrides:

checkInitialized in class FileTemplateManager

getProjectScheme

public FileTemplatesScheme getProjectScheme()

Specified by:

getProjectScheme in class FileTemplateManager

Returns:

Project scheme, or null if manager is created for default project.

getTemplates

public FileTemplate [] getTemplates(java.lang.String category)

Specified by:

getTemplates in class FileTemplateManager

getAllTemplates

public FileTemplate [] getAllTemplates()

Description copied from class: FileTemplateManager

Returns all templates from "Default" category.

Specified by:

getAllTemplates in class FileTemplateManager

getTemplate

public FileTemplate getTemplate(java.lang.String templateName)

Specified by:

getTemplate in class FileTemplateManager

addTemplate

public FileTemplate addTemplate(java.lang.String name,
                                java.lang.String extension)

Description copied from class: FileTemplateManager

Creates a new template with specified name, and adds it to the list of default templates.

Specified by:

addTemplate in class FileTemplateManager

Returns:

created template

removeTemplate

public void removeTemplate(FileTemplate template)

Specified by:

removeTemplate in class FileTemplateManager

getDefaultProperties

public java.util.Properties getDefaultProperties()

Specified by:

getDefaultProperties in class FileTemplateManager

Returns:

a new Properties object filled with predefined properties.

getRecentNames

public java.util.Collection<java.lang.String> getRecentNames()

Specified by:

getRecentNames in class FileTemplateManager

addRecentName

public void addRecentName(java.lang.String name)

Specified by:

addRecentName in class FileTemplateManager

getInternalTemplates

public FileTemplate [] getInternalTemplates()

Specified by:

getInternalTemplates in class FileTemplateManager

getInternalTemplate

public FileTemplate getInternalTemplate(java.lang.String templateName)

Specified by:

getInternalTemplate in class FileTemplateManager

findInternalTemplate

public FileTemplate findInternalTemplate(java.lang.String templateName)

Specified by:

findInternalTemplate in class FileTemplateManager

internalTemplateToSubject

public java.lang.String internalTemplateToSubject(java.lang.String templateName)

Specified by:

internalTemplateToSubject in class FileTemplateManager

getCodeTemplate

public FileTemplate getCodeTemplate(java.lang.String templateName)

Specified by:

getCodeTemplate in class FileTemplateManager

Parameters:

templateName - template name

Returns:

a template by name

getJ2eeTemplate

public FileTemplate getJ2eeTemplate(java.lang.String templateName)

Specified by:

getJ2eeTemplate in class FileTemplateManager

Parameters:

templateName - template name

Returns:

a template by name

getDefaultTemplate

public FileTemplate getDefaultTemplate(java.lang.String name)

Description copied from class: FileTemplateManager

Returns template with default (bundled) text.

Specified by:

getDefaultTemplate in class FileTemplateManager

getAllPatterns

public FileTemplate [] getAllPatterns()

Specified by:

getAllPatterns in class FileTemplateManager

getPattern

public FileTemplate getPattern(java.lang.String name)

Specified by:

getPattern in class FileTemplateManager

getAllCodeTemplates

public FileTemplate [] getAllCodeTemplates()

Specified by:

getAllCodeTemplates in class FileTemplateManager

getAllJ2eeTemplates

public FileTemplate [] getAllJ2eeTemplates()

Specified by:

getAllJ2eeTemplates in class FileTemplateManager

setTemplates

public void setTemplates(java.lang.String templatesCategory,
                         java.util.Collection<? extends FileTemplate> templates)

Specified by:

setTemplates in class FileTemplateManager

saveAllTemplates

public void saveAllTemplates()

Specified by:

saveAllTemplates in class FileTemplateManager

getDefaultTemplateDescription

public java.net.URL getDefaultTemplateDescription()

setTestDate

public void setTestDate(java.util.Date testDate)

getState

public FileTemplateManagerImpl.State getState()

Specified by:

getState in interface PersistentStateComponent<FileTemplateManagerImpl.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(FileTemplateManagerImpl.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<FileTemplateManagerImpl.State>

Parameters:

state - loaded component state

See Also:

XmlSerializerUtil.copyBean(Object, Object)

setDefaultFileIncludeTemplateTextTemporarilyForTest

public void setDefaultFileIncludeTemplateTextTemporarilyForTest(java.lang.String simpleName,
                                                                java.lang.String text,
                                                                Disposable parentDisposable)