com.atlassian.jira.project.renderer

Class ProjectDescriptionRendererImpl

java.lang.Object

com.atlassian.jira.project.renderer.ProjectDescriptionRendererImpl

All Implemented Interfaces:

ProjectDescriptionRenderer

public class ProjectDescriptionRendererImpl
extends Object
implements ProjectDescriptionRenderer

Renders the project description either as wiki markup or returns the plain value (in case HTML is allowed).

Since:

5.0.5

Constructor Summary

Constructors

Constructor and Description
ProjectDescriptionRendererImpl(RendererManager rendererManager, ApplicationProperties applicationProperties)

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectDescriptionRendererImpl

public ProjectDescriptionRendererImpl(@Nonnull
                                      RendererManager rendererManager,
                                      @Nonnull
                                      ApplicationProperties applicationProperties)

Method Detail

getViewHtml

@Nonnull
public String getViewHtml(@Nonnull
                                   Project project)

Description copied from interface: ProjectDescriptionRenderer

Returns the rendered html to view the project description.

Specified by:

getViewHtml in interface ProjectDescriptionRenderer

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

Description copied from interface: ProjectDescriptionRenderer

Returns the rendered html to edit the project description.

Specified by:

getEditHtml in interface ProjectDescriptionRenderer

Parameters:

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

Returns:

the rendered html to edit the project description

getViewHtml

@Nonnull
public String getViewHtml(@Nonnull
                                   String description)

Description copied from interface: ProjectDescriptionRenderer

Returns the rendered html to view the project description.

Specified by:

getViewHtml in interface ProjectDescriptionRenderer

Parameters:

description - the raw project description

Returns:

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

getEditHtml

@Nonnull
public String getEditHtml(@Nonnull
                                   String description)

Description copied from interface: ProjectDescriptionRenderer

Returns the rendered html to edit the project description.

Specified by:

getEditHtml in interface ProjectDescriptionRenderer

Parameters:

description - the raw project description

Returns:

the rendered html to edit the project description

getDescriptionI18nKey

@Nonnull
public String getDescriptionI18nKey()

Description copied from interface: ProjectDescriptionRenderer

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

Specified by:

getDescriptionI18nKey in interface ProjectDescriptionRenderer

Returns:

the i18n key containing the description of the edit field

isUseWikiMarkup

public boolean isUseWikiMarkup()

Description copied from interface: ProjectDescriptionRenderer

Indicates whether the renderer uses wiki markup or not.

Specified by:

isUseWikiMarkup in interface ProjectDescriptionRenderer

Returns:

true if we should use wiki markup in the project description field