com.atlassian.jira.project.renderer
Interface ProjectDescriptionRenderer

All Known Implementing Classes:

FullHtmlProjectDescriptionRenderer, ProjectDescriptionRendererImpl, WikiMarkupProjectDescriptionRenderer

public interface ProjectDescriptionRenderer

Renderes the project's description depending on the current security settings.

Since:

5.0.5

Method Summary

String	getDescriptionI18nKey() Returns the i18n key containing the description of the edit field.
String	getEditHtml(Project project) Returns the rendered html to edit the project description.
String	getEditHtml(String description) Returns the rendered html to edit the project description.
String	getViewHtml(Project project) Returns the rendered html to view the project description.
String	getViewHtml(String description) Returns the rendered html to view the project description.
boolean	isUseWikiMarkup() Indicates whether the renderer uses wiki markup or not.

Method Detail

getViewHtml

@Nonnull
String getViewHtml(@Nonnull
                           Project project)

Returns the rendered html to view the project description.

Parameters:

project - the project for which the description should be returned; not null

Returns:

the project description, escaping may be already applied (depending on the security settings).

getEditHtml

@Nonnull
String getEditHtml(@Nonnull
                           Project project)

Returns the rendered html to edit the project description.

Parameters:

project - the project which is going to be edited; not null

Returns:

the rendered html to edit the project description

getViewHtml

@Nonnull
String getViewHtml(@Nonnull
                           String description)

Returns the rendered html to view the project description.

Parameters:

description - the raw project description

Returns:

the project description, escaping may be already applied (depending on the security settings).

getEditHtml

@Nonnull
String getEditHtml(@Nonnull
                           String description)

Returns the rendered html to edit the project description.

Parameters:

description - the raw project description

Returns:

the rendered html to edit the project description

getDescriptionI18nKey

@Nonnull
String getDescriptionI18nKey()

Returns the i18n key containing the description of the edit field.

Returns:

the i18n key containing the description of the edit field

isUseWikiMarkup

boolean isUseWikiMarkup()

Indicates whether the renderer uses wiki markup or not.

Returns:

true if the renderer uses wiki markup, false if otherwise