@PublicSpi public abstract class

AbstractProjectTabPanel

extends Object
implements ProjectTabPanel
java.lang.Object
   ↳ com.atlassian.jira.plugin.projectpanel.impl.AbstractProjectTabPanel
Known Direct Subclasses
Known Indirect Subclasses

@PublicSpi

This class is designed for plugins to implement.

Clients of @PublicSpi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicSpi as per each product's API policy (clients should refer to each product's API policy for the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).

Note: @PublicSpi interfaces and classes are specifically designed to be implemented/extended by clients. Hence, the guarantee of binary compatibility is different to that of @PublicApi elements (if an element is both @PublicApi and @PublicSpi, both guarantees apply).

Class Overview

Abstract tab panel for browse project.

Summary

Fields
protected final JiraAuthenticationContext authenticationContext
protected ProjectTabPanelModuleDescriptor descriptor
Protected Constructors
AbstractProjectTabPanel(JiraAuthenticationContext jiraAuthenticationContext)
AbstractProjectTabPanel()
This constructor is for the benefit of plugins which may be expecting there to be a no-arg constructor for this and sub classes.
Public Methods
String getHtml(BrowseContext ctx)
void init(ProjectTabPanelModuleDescriptor descriptor)
Protected Methods
Map<String, Object> createVelocityParams(BrowseContext ctx)
Creates new map of velocity parameters.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.plugin.browsepanel.TabPanel

Fields

protected final JiraAuthenticationContext authenticationContext

protected ProjectTabPanelModuleDescriptor descriptor

Protected Constructors

protected AbstractProjectTabPanel (JiraAuthenticationContext jiraAuthenticationContext)

protected AbstractProjectTabPanel ()

This constructor is for the benefit of plugins which may be expecting there to be a no-arg constructor for this and sub classes.

Public Methods

public String getHtml (BrowseContext ctx)

public void init (ProjectTabPanelModuleDescriptor descriptor)

Protected Methods

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

Creates new map of velocity parameters. By default this map contains the context params from BrowseContext. Note that it does not explicitly add the default velocity params or the i18n bean, since these are added in getHtml(String, java.util.Map). Extenders of AbstractProjectTabPanel should override this method to specify precise parameters required for their velocity template.

Parameters
ctx browse context
Returns
  • new velocity parameters map