com.atlassian.confluence.pages.templates
Interface TemplateHandler

All Known Implementing Classes:

WikiTemplateHandler, XhtmlTemplateHandler

public interface TemplateHandler

Processes templates.

Method Summary

java.lang.String	generateEditorFormat(PageTemplate template, java.util.List<? extends Variable> variables, java.lang.String spaceKey)
java.util.List<Variable>	getTemplateVariables(PageTemplate template)
java.lang.String	insertVariables(java.io.Reader templateXml, java.util.List<? extends Variable> variables) Insert specified variables into the template XML before returning it.

Method Detail

getTemplateVariables

java.util.List<Variable> getTemplateVariables(PageTemplate template)
                                              throws XhtmlException

Throws:

XhtmlException

insertVariables

java.lang.String insertVariables(java.io.Reader templateXml,
                                 java.util.List<? extends Variable> variables)

Insert specified variables into the template XML before returning it. If an <at:var> is encountered in the XML that doesn't have a value specified, it will be replaced with empty string.

Parameters:

templateXml - template XML

variables - the template variables

Returns:

the updated template XML with variables replaced with actual values

generateEditorFormat

java.lang.String generateEditorFormat(PageTemplate template,
                                      java.util.List<? extends Variable> variables,
                                      java.lang.String spaceKey)
                                      throws XhtmlException

Throws:

XhtmlException