@PublicSpi public interface

ViewProfilePanel

com.atlassian.jira.plugin.profile.ViewProfilePanel
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

Defines a "panel" of content that will be displayed on the view profile page, in the center. These panels will be groups by named "tabs".

Summary

Constants
String VIEW_TEMPLATE The default velocity template name that is used to render the view.
Public Methods
String getHtml(ApplicationUser profileUser)
Renders the html to be used in this profile panel.
void init(ViewProfilePanelModuleDescriptor moduleDescriptor)
This method is called on plugin initialization and provides the module with a reference to the parent module descriptor.

Constants

public static final String VIEW_TEMPLATE

The default velocity template name that is used to render the view.

Constant Value: "view"

Public Methods

public String getHtml (ApplicationUser profileUser)

Renders the html to be used in this profile panel.

Parameters
profileUser The user whose profile is being viewed. May be null.
Returns
  • the html content.

public void init (ViewProfilePanelModuleDescriptor moduleDescriptor)

This method is called on plugin initialization and provides the module with a reference to the parent module descriptor.

Parameters
moduleDescriptor the controlling class that doles out this module.