Package com.atlassian.jira.projects.legacy.projectpanel.fragment.impl

Class ProjectDescriptionFragment

java.lang.Object

com.atlassian.jira.projects.legacy.projectpanel.fragment.impl.AbstractFragment

com.atlassian.jira.projects.legacy.projectpanel.fragment.impl.ProjectDescriptionFragment

All Implemented Interfaces:

ProjectTabPanelFragment

@Named
public class ProjectDescriptionFragment
extends AbstractFragment

The fragment which displays the description of a project.

Since:

v4.0

Field Summary

Fields inherited from class com.atlassian.jira.projects.legacy.projectpanel.fragment.impl.AbstractFragment

authenticationContext, log, velocityManager

Constructor Summary

Constructors

Constructor	Description
ProjectDescriptionFragment(ProjectPermissions projectPermissions, VelocityTemplatingEngine templatingEngine, JiraAuthenticationContext jiraAuthenticationContext, UserFormatManager userFormatManager, ProjectDescriptionRenderer projectDescriptionRenderer)

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	createVelocityParams(BrowseContext ctx)	Creates new map of velocity parameters.
String	getId()	Returns the fragment's unique HTML ID.
protected String	getTemplateDirectoryPath()	Returns the path to the template directory
boolean	showFragment(BrowseContext ctx)	Whether or not to include a fragment.

Methods inherited from class com.atlassian.jira.projects.legacy.projectpanel.fragment.impl.AbstractFragment

getHtml, getIssueCountInSearch

Methods inherited from class java.lang.Object

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

Constructor Details

ProjectDescriptionFragment

@Inject
public ProjectDescriptionFragment(ProjectPermissions projectPermissions,
 VelocityTemplatingEngine templatingEngine,
 JiraAuthenticationContext jiraAuthenticationContext,
 UserFormatManager userFormatManager,
 ProjectDescriptionRenderer projectDescriptionRenderer)

Method Details

getId

public String getId()

Description copied from interface: ProjectTabPanelFragment

Returns the fragment's unique HTML ID.

Returns:

the id of the fragment, never null

getTemplateDirectoryPath

protected String getTemplateDirectoryPath()

Description copied from class: AbstractFragment

Returns the path to the template directory

Specified by:

getTemplateDirectoryPath in class AbstractFragment

Returns:

the path to the template directory

createVelocityParams

protected Map<String,Object> createVelocityParams(BrowseContext ctx)

Description copied from class: AbstractFragment

Creates new map of velocity parameters. This map contains:

• fragid - value returned by ProjectTabPanelFragment.getId()
• project - project got from the context passed in
• i18n - i18n bean from the authentication context

Overrides:

createVelocityParams in class AbstractFragment

Parameters:

ctx - browse context

Returns:

new velocity parameters map

showFragment

public boolean showFragment(BrowseContext ctx)

Description copied from interface: ProjectTabPanelFragment

Whether or not to include a fragment. E.g. check permissions or if there is no content to render

Parameters:

ctx - the context in which this fragment is being rendered

Returns:

true if the fragment should be shown, false otherwise