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

PluggableFooter

com.atlassian.jira.plugin.navigation.PluggableFooter
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 the footer in JIRA.

Summary

Public Methods
String getFullFooterHtml(HttpServletRequest request)
Get the footer HTML to present on a page that utilizes 100% of the page width.
String getSmallFooterHtml(HttpServletRequest request)
Get the footer HTML to present on a page that does not utilize 100% of the page width.
void init(FooterModuleDescriptor descriptor)
This is called when the controling module descriptor is initialized and enabled.

Public Methods

public String getFullFooterHtml (HttpServletRequest request)

Get the footer HTML to present on a page that utilizes 100% of the page width.

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

public String getSmallFooterHtml (HttpServletRequest request)

Get the footer HTML to present on a page that does not utilize 100% of the page width.

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

public void init (FooterModuleDescriptor descriptor)

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

Parameters
descriptor is the controling module descriptor.