Summary: Methods | [Expand All]
public interface

ProjectDescriptionRenderer

com.atlassian.jira.project.renderer.ProjectDescriptionRenderer
Known Indirect Subclasses

Class Overview

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

Summary

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

Public Methods

@Nonnull public String getDescriptionI18nKey ()

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

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

@Nonnull public String getEditHtml (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

@Nonnull public String getEditHtml (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

@Nonnull public String getViewHtml (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).

@Nonnull public String getViewHtml (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).

public boolean isUseWikiMarkup ()

Indicates whether the renderer uses wiki markup or not.

Returns
  • true if the renderer uses wiki markup, false if otherwise