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

java.lang.Object
  com.atlassian.jira.plugin.projectpanel.fragment.impl.AbstractFragment
      com.atlassian.jira.plugin.projectpanel.fragment.impl.AbstractMultiFragment
          com.atlassian.jira.plugin.projectpanel.fragment.impl.AbstractIssuesFragment

All Implemented Interfaces:

ComponentTabPanelFragment, ProjectTabPanelFragment, VersionTabPanelFragment

Direct Known Subclasses:

DueIssuesFragment, RecentIssuesFragment

public abstract class AbstractIssuesFragment
extends AbstractMultiFragment

A common base class for fragments which display issues on project tab panels.

Since:

v4.0

Field Summary

protected SearchProvider	searchProvider
protected static String	TEMPLATE_DIRECTORY_PATH

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

applicationProperites, jiraAuthenticationContext, velocityManager

Constructor Summary

AbstractIssuesFragment(JiraAuthenticationContext jiraAuthenticationContext, com.atlassian.velocity.VelocityManager velocityManager, SearchProvider searchProvider, ApplicationProperties applicationProperites, DateTimeFormatterFactory dateTimeFormatterFactory)

Method Summary

protected Map<String,Object>	createVelocityParams(BrowseContext ctx) Creates new map of velocity parameters.
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

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

getHtml, getId

Field Detail

TEMPLATE_DIRECTORY_PATH

protected static final String TEMPLATE_DIRECTORY_PATH

See Also:

Constant Field Values

searchProvider

protected final SearchProvider searchProvider

Constructor Detail

AbstractIssuesFragment

public AbstractIssuesFragment(JiraAuthenticationContext jiraAuthenticationContext,
                              com.atlassian.velocity.VelocityManager velocityManager,
                              SearchProvider searchProvider,
                              ApplicationProperties applicationProperites,
                              DateTimeFormatterFactory dateTimeFormatterFactory)

Method Detail

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

Parameters:

ctx - the browse context

Returns:

True if the display issue count is greater than zero, and there are issues returned by the search request.