com.atlassian.confluence.pages.templates

Class DefaultPageTemplateManager

java.lang.Object

com.atlassian.confluence.pages.templates.DefaultPageTemplateManager

All Implemented Interfaces:

PageTemplateManager

public class DefaultPageTemplateManager
extends Object
implements PageTemplateManager

Constructor Summary

Constructors

Constructor and Description
DefaultPageTemplateManager()

Method Summary

Modifier and Type	Method and Description
boolean	canCreate(PageTemplate template, PageTemplate foundTemplate) Returns if a template can be created.
PageTemplate	getGlobalPageTemplate(String name)
List	getGlobalPageTemplates()
PageTemplate	getPageTemplate(long id)
PageTemplate	getPageTemplate(PluginTemplateReference pluginTemplateReference)
PageTemplate	getPageTemplate(String name, Space space)
List	getPageTemplates(Space space)
List	getTemplateVariables(PageTemplate template)
String	insertVariables(PageTemplate template, List variables) Insert the provided variables into the provided template content, and returns it.
String	mergeVariables(PageTemplate template, List variables)
String	mergeVariables(PageTemplate template, List variables, String spaceKey)
void	refreshPageTemplate(PageTemplate pageTemplate)
void	removeAllPageTemplates(Space space)
void	removePageTemplate(PageTemplate page)
void	savePageTemplate(PageTemplate pageTemplate, PageTemplate originalTemplate)
void	setEventManager(com.atlassian.event.EventManager eventManager)
void	setPageTemplateDao(PageTemplateDao pageTemplateDao)
void	setTemplateHandlers(Map<BodyType,TemplateHandler> templateHandlers)
void	setWikiToXhtmlMigrator(WikiToXhtmlMigrator wikiToXhtmlMigrator)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPageTemplateManager

public DefaultPageTemplateManager()

Method Detail

setPageTemplateDao

public void setPageTemplateDao(PageTemplateDao pageTemplateDao)

setWikiToXhtmlMigrator

public void setWikiToXhtmlMigrator(WikiToXhtmlMigrator wikiToXhtmlMigrator)

setTemplateHandlers

public void setTemplateHandlers(Map<BodyType,TemplateHandler> templateHandlers)

savePageTemplate

public void savePageTemplate(PageTemplate pageTemplate,
                             PageTemplate originalTemplate)

Specified by:

savePageTemplate in interface PageTemplateManager

refreshPageTemplate

public void refreshPageTemplate(PageTemplate pageTemplate)

Specified by:

refreshPageTemplate in interface PageTemplateManager

removePageTemplate

public void removePageTemplate(PageTemplate page)

Specified by:

removePageTemplate in interface PageTemplateManager

getPageTemplate

public PageTemplate getPageTemplate(long id)

Specified by:

getPageTemplate in interface PageTemplateManager

getPageTemplate

public PageTemplate getPageTemplate(PluginTemplateReference pluginTemplateReference)

Specified by:

getPageTemplate in interface PageTemplateManager

getPageTemplate

public PageTemplate getPageTemplate(String name,
                                    Space space)

Specified by:

getPageTemplate in interface PageTemplateManager

getPageTemplates

public List getPageTemplates(Space space)

Specified by:

getPageTemplates in interface PageTemplateManager

Returns:

the list of all templates of the space

getGlobalPageTemplates

public List getGlobalPageTemplates()

Specified by:

getGlobalPageTemplates in interface PageTemplateManager

getGlobalPageTemplate

public PageTemplate getGlobalPageTemplate(String name)

Specified by:

getGlobalPageTemplate in interface PageTemplateManager

setEventManager

public void setEventManager(com.atlassian.event.EventManager eventManager)

Specified by:

setEventManager in interface PageTemplateManager

removeAllPageTemplates

public void removeAllPageTemplates(Space space)

Specified by:

removeAllPageTemplates in interface PageTemplateManager

getTemplateVariables

public List getTemplateVariables(PageTemplate template)
                          throws XhtmlException

Specified by:

getTemplateVariables in interface PageTemplateManager

Throws:

XhtmlException

mergeVariables

public String mergeVariables(PageTemplate template,
                             List variables)
                      throws XhtmlException

Specified by:

mergeVariables in interface PageTemplateManager

Throws:

XhtmlException

mergeVariables

public String mergeVariables(PageTemplate template,
                             List variables,
                             String spaceKey)
                      throws XhtmlException

Specified by:

mergeVariables in interface PageTemplateManager

Throws:

XhtmlException

insertVariables

public String insertVariables(PageTemplate template,
                              List variables)

Insert the provided variables into the provided template content, and returns it. Any variable not found will be replaced by an empty string

Specified by:

insertVariables in interface PageTemplateManager

canCreate

public boolean canCreate(PageTemplate template,
                         PageTemplate foundTemplate)

Description copied from interface: PageTemplateManager

Returns if a template can be created.

Specified by:

canCreate in interface PageTemplateManager

Parameters:

template - to be created, null if it's a new template

foundTemplate - template found in DB, null if not found

Returns:

true if the template can be created, otherwise false