public interface

SimpleLinkFactoryModuleDescriptor

implements ModuleDescriptor<T> WeightedDescriptor
com.atlassian.jira.plugin.webfragment.descriptors.SimpleLinkFactoryModuleDescriptor
Known Indirect Subclasses

This interface is deprecated.
since v6.3 - use com.atlassian.plugin.web.descriptors.WebItemProviderModuleDescriptor

Class Overview

Plugin in Module descriptor that defines a SimpleLinkFactory. This is used by the SimpleLinkManager to display a list of simple links.

Summary

Public Methods
String getSection()
The section that this list will be inserted into.
boolean shouldBeLazy()
Whether or not this should be lazily loaded.
[Expand]
Inherited Methods
From interface com.atlassian.plugin.ModuleDescriptor
From interface com.atlassian.plugin.Resourced
From interface com.atlassian.plugin.web.descriptors.WeightedDescriptor

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 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.