com.atlassian.confluence.plugins.createcontent.template

Class DefaultPluginPageTemplateHelper

java.lang.Object

com.atlassian.confluence.plugins.createcontent.template.DefaultPluginPageTemplateHelper

All Implemented Interfaces:

PluginPageTemplateHelper

public class DefaultPluginPageTemplateHelper
extends Object
implements PluginPageTemplateHelper

Constructor Summary

Constructors

Constructor and Description
DefaultPluginPageTemplateHelper(com.atlassian.confluence.pages.templates.PageTemplateManager pageTemplateManager, com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Summary

Modifier and Type	Method and Description
com.atlassian.confluence.pages.templates.PageTemplate	getPageTemplate(ContentTemplateRef contentTemplateRef)
com.atlassian.confluence.pages.templates.PageTemplate	getPageTemplate(com.atlassian.confluence.pages.templates.PluginTemplateReference pluginTemplateReference)
List<com.atlassian.confluence.pages.templates.PageTemplate>	getPageTemplates(com.atlassian.confluence.spaces.Space space) Retrieves all templates declared inside plugins.
List<I18nPageTemplate>	getSystemPageTemplates() Retrieves all templates declared inside system plugins

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPluginPageTemplateHelper

public DefaultPluginPageTemplateHelper(com.atlassian.confluence.pages.templates.PageTemplateManager pageTemplateManager,
                                       com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Detail

getPageTemplate

public com.atlassian.confluence.pages.templates.PageTemplate getPageTemplate(com.atlassian.confluence.pages.templates.PluginTemplateReference pluginTemplateReference)

Specified by:

getPageTemplate in interface PluginPageTemplateHelper

Parameters:

pluginTemplateReference - a reference identifying the plugin template

Returns:

the customized page template if it exists, else the default template served directly from the plugin

getPageTemplate

public com.atlassian.confluence.pages.templates.PageTemplate getPageTemplate(ContentTemplateRef contentTemplateRef)

Specified by:

getPageTemplate in interface PluginPageTemplateHelper

getPageTemplates

public List<com.atlassian.confluence.pages.templates.PageTemplate> getPageTemplates(com.atlassian.confluence.spaces.Space space)

Description copied from interface: PluginPageTemplateHelper

Retrieves all templates declared inside plugins.

Additionally, this method will load all "customisations" of plugin templates that are stored in the database against:

• a space (if a space is specified)
• globally (if null is passed in for the space)

Any customised templates on the space or global level will be returned "instead of" the original plugin template.

Specified by:

getPageTemplates in interface PluginPageTemplateHelper

Parameters:

space - the space (optional)

Returns:

a list of plugin PageTemplate(s). Any modified templates in the specified will be returned in place of the default template.

getSystemPageTemplates

public List<I18nPageTemplate> getSystemPageTemplates()

Description copied from interface: PluginPageTemplateHelper

Retrieves all templates declared inside system plugins

Additionally, this method will load all "customisations" of system plugin templates that are globally stored in the database

Any customised templates on the space or global level will be returned "instead of" the original plugin template.

Specified by:

getSystemPageTemplates in interface PluginPageTemplateHelper