Package com.intellij.ide.fileTemplates

Class FileTemplateManager

java.lang.Object

com.intellij.ide.fileTemplates.FileTemplateManager

Direct Known Subclasses:

FileTemplateManagerImpl

public abstract class FileTemplateManager
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CODE_TEMPLATES_CATEGORY
static Key<java.util.Properties>	DEFAULT_TEMPLATE_PROPERTIES
static java.lang.String	DEFAULT_TEMPLATES_CATEGORY
static java.lang.String	FILE_HEADER_TEMPLATE_NAME
static java.lang.String	INCLUDES_TEMPLATES_CATEGORY
static java.lang.String	INTERNAL_HTML_TEMPLATE_NAME
static java.lang.String	INTERNAL_HTML5_TEMPLATE_NAME
static java.lang.String	INTERNAL_TEMPLATES_CATEGORY
static java.lang.String	INTERNAL_XHTML_TEMPLATE_NAME
static java.lang.String	J2EE_TEMPLATES_CATEGORY
static java.lang.String	PROJECT_NAME_VARIABLE
static int	RECENT_TEMPLATES_SIZE

Constructor Summary

Constructors

Constructor and Description
FileTemplateManager()

Method Summary

Modifier and Type	Method and Description
abstract void	addRecentName(java.lang.String name)
abstract 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()
abstract FileTemplate	findInternalTemplate(java.lang.String templateName)
abstract FileTemplate []	getAllCodeTemplates()
abstract FileTemplate []	getAllJ2eeTemplates()
abstract FileTemplate []	getAllPatterns()
abstract FileTemplate []	getAllTemplates() Returns all templates from "Default" category.
abstract FileTemplate	getCodeTemplate(java.lang.String templateName)
abstract FileTemplatesScheme	getCurrentScheme()
static FileTemplateManager	getDefaultInstance()
abstract java.util.Properties	getDefaultProperties()
java.util.Properties	getDefaultProperties(Project project) Deprecated. use getDefaultProperties() instead
abstract FileTemplate	getDefaultTemplate(java.lang.String name) Returns template with default (bundled) text.
static FileTemplateManager	getInstance() Deprecated. Use getInstance(Project) instead
static FileTemplateManager	getInstance(Project project)
abstract FileTemplate	getInternalTemplate(java.lang.String templateName)
abstract FileTemplate []	getInternalTemplates()
abstract FileTemplate	getJ2eeTemplate(java.lang.String templateName)
abstract FileTemplate	getPattern(java.lang.String name)
abstract FileTemplatesScheme	getProjectScheme()
abstract java.util.Collection<java.lang.String>	getRecentNames()
abstract FileTemplate	getTemplate(java.lang.String templateName)
abstract FileTemplate []	getTemplates(java.lang.String category)
abstract java.lang.String	internalTemplateToSubject(java.lang.String templateName)
abstract void	removeTemplate(FileTemplate template)
abstract void	saveAllTemplates()
abstract void	setCurrentScheme(FileTemplatesScheme scheme)
abstract void	setTemplates(java.lang.String templatesCategory, java.util.Collection<? extends FileTemplate> templates)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TEMPLATE_PROPERTIES

public static final Key<java.util.Properties> DEFAULT_TEMPLATE_PROPERTIES

RECENT_TEMPLATES_SIZE

public static final int RECENT_TEMPLATES_SIZE

See Also:

Constant Field Values

INTERNAL_HTML_TEMPLATE_NAME

public static final java.lang.String INTERNAL_HTML_TEMPLATE_NAME

See Also:

Constant Field Values

INTERNAL_HTML5_TEMPLATE_NAME

public static final java.lang.String INTERNAL_HTML5_TEMPLATE_NAME

See Also:

Constant Field Values

INTERNAL_XHTML_TEMPLATE_NAME

public static final java.lang.String INTERNAL_XHTML_TEMPLATE_NAME

See Also:

Constant Field Values

FILE_HEADER_TEMPLATE_NAME

public static final java.lang.String FILE_HEADER_TEMPLATE_NAME

See Also:

Constant Field Values

DEFAULT_TEMPLATES_CATEGORY

public static final java.lang.String DEFAULT_TEMPLATES_CATEGORY

See Also:

Constant Field Values

INTERNAL_TEMPLATES_CATEGORY

public static final java.lang.String INTERNAL_TEMPLATES_CATEGORY

See Also:

Constant Field Values

INCLUDES_TEMPLATES_CATEGORY

public static final java.lang.String INCLUDES_TEMPLATES_CATEGORY

See Also:

Constant Field Values

CODE_TEMPLATES_CATEGORY

public static final java.lang.String CODE_TEMPLATES_CATEGORY

See Also:

Constant Field Values

J2EE_TEMPLATES_CATEGORY

public static final java.lang.String J2EE_TEMPLATES_CATEGORY

See Also:

Constant Field Values

PROJECT_NAME_VARIABLE

public static final java.lang.String PROJECT_NAME_VARIABLE

See Also:

Constant Field Values

Constructor Detail

FileTemplateManager

public FileTemplateManager()

Method Detail

getInstance

public static FileTemplateManager getInstance(Project project)

checkInitialized

protected FileTemplateManager checkInitialized()

getInstance

@Deprecated
public static FileTemplateManager getInstance()

Deprecated. Use getInstance(Project) instead

getDefaultInstance

public static FileTemplateManager getDefaultInstance()

getCurrentScheme

public abstract FileTemplatesScheme getCurrentScheme()

setCurrentScheme

public abstract void setCurrentScheme(FileTemplatesScheme scheme)

getProjectScheme

public abstract FileTemplatesScheme getProjectScheme()

Returns:

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

getTemplates

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

getAllTemplates

public abstract FileTemplate [] getAllTemplates()

Returns all templates from "Default" category.

getTemplate

public abstract FileTemplate getTemplate(java.lang.String templateName)

getDefaultProperties

public abstract java.util.Properties getDefaultProperties()

Returns:

a new Properties object filled with predefined properties.

getDefaultProperties

@Deprecated
public java.util.Properties getDefaultProperties(Project project)

Deprecated. use getDefaultProperties() instead

addTemplate

public abstract 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.

Returns:

created template

removeTemplate

public abstract void removeTemplate(FileTemplate template)

getRecentNames

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

addRecentName

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

getInternalTemplate

public abstract FileTemplate getInternalTemplate(java.lang.String templateName)

findInternalTemplate

public abstract FileTemplate findInternalTemplate(java.lang.String templateName)

getInternalTemplates

public abstract FileTemplate [] getInternalTemplates()

getJ2eeTemplate

public abstract FileTemplate getJ2eeTemplate(java.lang.String templateName)

Parameters:

templateName - template name

Returns:

a template by name

Throws:

java.lang.IllegalStateException - if template is not found

getCodeTemplate

public abstract FileTemplate getCodeTemplate(java.lang.String templateName)

Parameters:

templateName - template name

Returns:

a template by name

Throws:

java.lang.IllegalStateException - if template is not found

getAllPatterns

public abstract FileTemplate [] getAllPatterns()

getAllCodeTemplates

public abstract FileTemplate [] getAllCodeTemplates()

getAllJ2eeTemplates

public abstract FileTemplate [] getAllJ2eeTemplates()

internalTemplateToSubject

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

getPattern

public abstract FileTemplate getPattern(java.lang.String name)

getDefaultTemplate

public abstract FileTemplate getDefaultTemplate(java.lang.String name)

Returns template with default (bundled) text.

setTemplates

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

saveAllTemplates

public abstract void saveAllTemplates()