com.atlassian.jira.plugin.issuelink
Interface IssueLinkRendererModuleDescriptor

All Superinterfaces:
JiraResourcedModuleDescriptor<IssueLinkRenderer>, com.atlassian.plugin.ModuleDescriptor<IssueLinkRenderer>, com.atlassian.plugin.Resourced
All Known Implementing Classes:
IssueLinkRendererModuleDescriptorImpl

public interface IssueLinkRendererModuleDescriptor
extends JiraResourcedModuleDescriptor<IssueLinkRenderer>

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

Since:
v5.0

Method Summary
 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.
 
Methods inherited from interface com.atlassian.jira.plugin.JiraResourcedModuleDescriptor
getHtml, getHtml, getI18nBean, writeHtml
 
Methods inherited from interface com.atlassian.plugin.ModuleDescriptor
destroy, destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, init, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion
 
Methods inherited from interface com.atlassian.plugin.Resourced
getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation
 

Method Detail

isDefaultHandler

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

handlesApplicationType

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 (isDefaultHandler().

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

getInitialHtml

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

getFinalHtml

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


Copyright © 2002-2013 Atlassian. All Rights Reserved.