com.atlassian.jira.plugin.projectpanel.fragment.impl
Class ProjectDescriptionFragment

java.lang.Object
  extended by com.atlassian.jira.plugin.projectpanel.fragment.impl.AbstractFragment
      extended by com.atlassian.jira.plugin.projectpanel.fragment.impl.ProjectDescriptionFragment
All Implemented Interfaces:
ProjectTabPanelFragment

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.plugin.projectpanel.fragment.impl.AbstractFragment
applicationProperites, jiraAuthenticationContext, log, velocityManager
 
Constructor Summary
ProjectDescriptionFragment(com.atlassian.velocity.VelocityManager velocityManager, ApplicationProperties applicationProperites, JiraAuthenticationContext jiraAuthenticationContext, UserFormatManager userFormatManager)
           
 
Method Summary
protected  Map<String,Object> createVelocityParams(BrowseContext ctx)
          Creates new map of velocity parameters.
 String getId()
          Returns fragmet's 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.plugin.projectpanel.fragment.impl.AbstractFragment
getHtml
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProjectDescriptionFragment

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

getId

public String getId()
Description copied from interface: ProjectTabPanelFragment
Returns fragmet's ID.

Returns:
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:

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 permissios or if there is no contnent to render

Parameters:
ctx - The context that this fragment is being rendered in.
Returns:
true if the fragment should be shown, false otherwise


Copyright © 2002-2009 Atlassian. All Rights Reserved.