public interface

IssueLinkRendererModuleDescriptor

implements JiraResourcedModuleDescriptor<T>
com.atlassian.jira.plugin.issuelink.IssueLinkRendererModuleDescriptor
Known Indirect Subclasses

Class Overview

Module descriptor for an issue link renderer that customises the way issue links are rendered.

Summary

Public Methods
String getFinalHtml(RemoteIssueLink remoteIssueLink)
Returns the final HTML to place between the relationship text and the delete icon.
String getInitialHtml(RemoteIssueLink remoteIssueLink)
Returns the initial HTML to place between the relationship text and the delete icon.
boolean handlesApplicationType(String applicationType)
Returns true if the module descriptor can handle the application type.
boolean isDefaultHandler()
Returns true if the module descriptor is the default handler for issue links.
[Expand]
Inherited Methods
From interface com.atlassian.jira.plugin.JiraResourcedModuleDescriptor
From interface com.atlassian.plugin.ModuleDescriptor
From interface com.atlassian.plugin.Resourced

Public Methods

public String getFinalHtml (RemoteIssueLink remoteIssueLink)

Returns the final HTML to place between the relationship text and the delete icon. Remote calls may be made to construct the final HTML.

Parameters
remoteIssueLink remote issue link
Returns
  • final HTML that goes between the relationship text and the delete icon

public String getInitialHtml (RemoteIssueLink remoteIssueLink)

Returns the initial HTML to place between the relationship text and the delete icon. No remote calls should be made to construct the initial HTML.

Parameters
remoteIssueLink remote issue link
Returns
  • initial HTML that goes between the relationship text and the delete icon

public boolean handlesApplicationType (String applicationType)

Returns true if the module descriptor can handle the application type. Only one module descriptor should be capable of handling an application type. If there are more than one modules that can handle an application type, only the first module (in loading order) will be used. If no descriptors handle an application type, then the default issue link renderer module descriptor is used (.

Parameters
applicationType application type to handle
Returns
  • true if the module descriptor can handle the application type

public boolean isDefaultHandler ()

Returns true if the module descriptor is the default handler for issue links.

Returns
  • true if the module descriptor is the default handler for issue links