com.atlassian.confluence.plugins.createcontent.api.services

Interface CreateButtonService

All Known Implementing Classes:

DefaultCreateButtonService

@PublicApi
public interface CreateButtonService

Provides buttons that launch the Create dialog.

Method Summary

Modifier and Type	Method and Description
String	renderBlueprintButton(com.atlassian.confluence.spaces.Space space, String contentBlueprintId, String blueprintModuleCompleteKey, String buttonLabelKey, String newPageTitle) Render a button that launches the Create dialog for a Blueprint.
String	renderTemplateButton(com.atlassian.confluence.spaces.Space space, long templateId, String buttonLabelKey, String newPageTitle) Render a button that launches the Create dialog for a Template.

Method Detail

renderBlueprintButton

String renderBlueprintButton(com.atlassian.confluence.spaces.Space space,
                             String contentBlueprintId,
                             String blueprintModuleCompleteKey,
                             @Nullable
                             String buttonLabelKey,
                             @Nullable
                             String newPageTitle)

Render a button that launches the Create dialog for a Blueprint.

Depending on the Blueprint used, the contentBlueprintId or the blueprintModuleCompleteKey may be blank.

Parameters:

space - the space the new page will be created in

contentBlueprintId - the id of the Blueprint the new page will be created from

blueprintModuleCompleteKey - the plugin module key of the Blueprint the new page will be created from

buttonLabelKey - (optional) the i18n key of the label for the Create button

newPageTitle - (optional) the i18ned title of the new page that will be created

Returns:

rendered HTML for the button

renderTemplateButton

String renderTemplateButton(com.atlassian.confluence.spaces.Space space,
                            long templateId,
                            @Nullable
                            String buttonLabelKey,
                            @Nullable
                            String newPageTitle)

Render a button that launches the Create dialog for a Template.

Parameters:

space - the space the new page will be created in

templateId - the id of the PageTemplate the new page will be created from

buttonLabelKey - (optional) the i18n key of the label for the Create button

newPageTitle - (optional) the i18ned title of the new page that will be created

Returns:

rendered HTML for the button