com.atlassian.jira.plugin.componentpanel.fragment.impl
Class ComponentDescriptionFragment

java.lang.Object
  com.atlassian.jira.plugin.projectpanel.fragment.impl.AbstractFragment
      com.atlassian.jira.plugin.componentpanel.fragment.impl.ComponentDescriptionFragment

All Implemented Interfaces:

ComponentTabPanelFragment, ProjectTabPanelFragment

public class ComponentDescriptionFragment
extends AbstractFragment
implements ComponentTabPanelFragment

The fragment which displays the description of a project.

Since:

v4.0

Field Summary

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

applicationProperites, jiraAuthenticationContext, log, velocityManager

Constructor Summary

ComponentDescriptionFragment(com.atlassian.velocity.VelocityManager velocityManager, ApplicationProperties applicationProperites, JiraAuthenticationContext jiraAuthenticationContext, UserFormatManager userFormatManager)

Method Summary

protected java.util.Map<java.lang.String,java.lang.Object>	createVelocityParams(BrowseContext ctx) Creates new map of velocity parameters.
java.lang.String	getId() Returns fragmet's ID.
protected java.lang.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.plugin.projectpanel.fragment.impl.AbstractFragment

getHtml

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.plugin.projectpanel.fragment.ProjectTabPanelFragment

getHtml

Constructor Detail

ComponentDescriptionFragment

public ComponentDescriptionFragment(com.atlassian.velocity.VelocityManager velocityManager,
                                    ApplicationProperties applicationProperites,
                                    JiraAuthenticationContext jiraAuthenticationContext,
                                    UserFormatManager userFormatManager)

Method Detail

getId

public java.lang.String getId()

Description copied from interface: ProjectTabPanelFragment

Returns fragmet's ID.

Specified by:

getId in interface ProjectTabPanelFragment

Returns:

id of the fragment, never null

showFragment

public boolean showFragment(BrowseContext ctx)

Description copied from interface: ProjectTabPanelFragment

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

Specified by:

showFragment in interface ProjectTabPanelFragment

Parameters:

ctx - The context that this fragment is being rendered in.

Returns:

true if the fragment should be shown, false otherwise

getTemplateDirectoryPath

protected java.lang.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 java.util.Map<java.lang.String,java.lang.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