com.atlassian.confluence.plugins.createcontent.api.contextproviders

Class AbstractBlueprintContextProvider

java.lang.Object

com.atlassian.confluence.plugins.createcontent.api.contextproviders.AbstractBlueprintContextProvider

All Implemented Interfaces:

com.atlassian.plugin.web.ContextProvider

Direct Known Subclasses:

DefaultIndexPageContextProvider

@PublicSpi
public abstract class AbstractBlueprintContextProvider
extends Object
implements com.atlassian.plugin.web.ContextProvider

Provides a BlueprintContext for Blueprint Template renders.

"context-provider" implementations in "content-template" plugin modules should extend this class rather than implementing ContextProvider directly.

Field Summary

Fields

Modifier and Type	Field and Description
protected TemplateRendererHelper	templateRendererHelper

Constructor Summary

Constructors

Constructor and Description
AbstractBlueprintContextProvider() Deprecated. since 2.1.18.
AbstractBlueprintContextProvider(TemplateRendererHelper templateRendererHelper)

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getContextMap(Map<String,Object> context)
void	init(Map<String,String> params)
protected String	renderContentReportTableMacro(String templateLabel, String analyticsKey, String spaceKey, String blankTitle, String blankDescription, String createButtonLabel, String contentBlueprintId, String blueprintModuleCompleteKey)
protected String	renderCreateFromTemplateMacro(String contentBlueprintId, String createButtonLabel, String spaceKey, String blueprintModuleCompleteKey)
void	setTemplateRendererHelper(TemplateRendererHelper templateRendererHelper)
protected abstract BlueprintContext	updateBlueprintContext(BlueprintContext blueprintContext) Updates the given BlueprintContext to include extra context required by a PageTemplate render.

Methods inherited from class java.lang.Object

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

Field Detail

templateRendererHelper

protected TemplateRendererHelper templateRendererHelper

Constructor Detail

AbstractBlueprintContextProvider

public AbstractBlueprintContextProvider()

Deprecated. since 2.1.18.

AbstractBlueprintContextProvider

public AbstractBlueprintContextProvider(TemplateRendererHelper templateRendererHelper)

Method Detail

init

public void init(Map<String,String> params)
          throws com.atlassian.plugin.PluginParseException

Specified by:

init in interface com.atlassian.plugin.web.ContextProvider

Throws:

com.atlassian.plugin.PluginParseException

getContextMap

public final Map<String,Object> getContextMap(Map<String,Object> context)

Specified by:

getContextMap in interface com.atlassian.plugin.web.ContextProvider

updateBlueprintContext

protected abstract BlueprintContext updateBlueprintContext(BlueprintContext blueprintContext)

Updates the given BlueprintContext to include extra context required by a PageTemplate render.

renderCreateFromTemplateMacro

protected String renderCreateFromTemplateMacro(String contentBlueprintId,
                                               String createButtonLabel,
                                               String spaceKey,
                                               String blueprintModuleCompleteKey)

renderContentReportTableMacro

protected String renderContentReportTableMacro(String templateLabel,
                                               String analyticsKey,
                                               String spaceKey,
                                               String blankTitle,
                                               String blankDescription,
                                               String createButtonLabel,
                                               String contentBlueprintId,
                                               String blueprintModuleCompleteKey)

setTemplateRendererHelper

public void setTemplateRendererHelper(TemplateRendererHelper templateRendererHelper)