public abstract class

AbstractIssuesFragment

extends AbstractMultiFragment
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
Known Direct Subclasses

Class Overview

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

Summary

Constants
String TEMPLATE_DIRECTORY_PATH
Fields
protected final SearchProvider searchProvider
[Expand]
Inherited Fields
From class com.atlassian.jira.plugin.projectpanel.fragment.impl.AbstractFragment
Public Constructors
AbstractIssuesFragment(JiraAuthenticationContext jiraAuthenticationContext, VelocityTemplatingEngine templatingEngine, SearchProvider searchProvider, ApplicationProperties applicationProperties, DateTimeFormatterFactory dateTimeFormatterFactory)
Public Methods
boolean showFragment(BrowseContext ctx)
Protected Methods
Map<StringObject> createVelocityParams(BrowseContext ctx)
Creates new map of velocity parameters.
String getTemplateDirectoryPath()
Returns the path to the template directory
[Expand]
Inherited Methods
From class com.atlassian.jira.plugin.projectpanel.fragment.impl.AbstractFragment
From class java.lang.Object
From interface com.atlassian.jira.plugin.projectpanel.fragment.ProjectTabPanelFragment

Constants

protected static final String TEMPLATE_DIRECTORY_PATH

Constant Value: "templates/plugins/jira/projectpanels/fragments/summary/"

Fields

protected final SearchProvider searchProvider

Public Constructors

public AbstractIssuesFragment (JiraAuthenticationContext jiraAuthenticationContext, VelocityTemplatingEngine templatingEngine, SearchProvider searchProvider, ApplicationProperties applicationProperties, DateTimeFormatterFactory dateTimeFormatterFactory)

Public Methods

public boolean showFragment (BrowseContext ctx)

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.

Protected Methods

protected Map<StringObject> createVelocityParams (BrowseContext ctx)

Creates new map of velocity parameters.

This map contains:

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

Parameters
ctx browse context
Returns
  • new velocity parameters map

protected String getTemplateDirectoryPath ()

Returns the path to the template directory

Returns
  • the path to the template directory