public class

DefaultSimpleLinkFactoryModuleDescriptor

extends AbstractJiraModuleDescriptor<T>
implements SimpleLinkFactoryModuleDescriptor
java.lang.Object
   ↳ com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
     ↳ com.atlassian.jira.plugin.AbstractJiraModuleDescriptor<T>
       ↳ com.atlassian.jira.plugin.webfragment.descriptors.DefaultSimpleLinkFactoryModuleDescriptor

Class Overview

Plugin in Module descriptor that defines a SimpleLinkFactory. This is used by the SimpleLinkManager to display a list of simple links. The special attributes for this are: lazy - whether the section should be loaded lazily, weight - the position to include the generated list, and section - the section that the generated links go into.

Summary

[Expand]
Inherited Fields
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
Public Constructors
DefaultSimpleLinkFactoryModuleDescriptor(JiraAuthenticationContext authenticationContext, ModuleFactory moduleFactory)
Public Methods
String getSection()
The section that this list will be inserted into.
int getWeight()
void init(Plugin plugin, Element element)
boolean shouldBeLazy()
Whether or not this should be lazily loaded.
[Expand]
Inherited Methods
From class com.atlassian.jira.plugin.AbstractJiraModuleDescriptor
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
From class java.lang.Object
From interface com.atlassian.jira.plugin.JiraResourcedModuleDescriptor
From interface com.atlassian.jira.plugin.webfragment.descriptors.SimpleLinkFactoryModuleDescriptor
From interface com.atlassian.plugin.ModuleDescriptor
From interface com.atlassian.plugin.Resourced
From interface com.atlassian.plugin.StateAware
From interface com.atlassian.plugin.web.descriptors.WeightedDescriptor

Public Constructors

public DefaultSimpleLinkFactoryModuleDescriptor (JiraAuthenticationContext authenticationContext, ModuleFactory moduleFactory)

Public Methods

public String getSection ()

The section that this list will be inserted into. This usually refers to a WebSectionModuleDescriptor location + "/" + key. This should never return null.

Returns
  • The section that this list will be inserted into.

public int getWeight ()

public void init (Plugin plugin, Element element)

public boolean shouldBeLazy ()

Whether or not this should be lazily loaded. This should be true if the list is expensive. Note that this can be ignored if the list does not support lazily loaded links.

Returns
  • true if the list is expensive to generate and should be loaded lazily if possible, false otherwise.