Summary: Methods | [Expand All]
@PublicSpi public interface

PluggableTopNavigation

com.atlassian.jira.plugin.navigation.PluggableTopNavigation
Known Indirect Subclasses

@PublicSpi

This interface 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

A plugin to render a top navigation bar in JIRA.

Summary

Public Methods
String getHtml(HttpServletRequest request)
Get the HTML to present on screen.
void init(TopNavigationModuleDescriptor descriptor)
This is called when the controling module descriptor is initialized and enabled.

Public Methods

public String getHtml (HttpServletRequest request)

Get the HTML to present on screen.

Parameters
request the request that is asking for the html.
Returns
  • the html to be rendered.

public void init (TopNavigationModuleDescriptor descriptor)

This is called when the controling module descriptor is initialized and enabled.

Parameters
descriptor is the controling module descriptor.