public interface

ModuleWebComponentFields

com.atlassian.jira.web.component.ModuleWebComponentFields
Known Indirect Subclasses

Class Overview

Utility to extract fields from a com.atlassian.plugin.web.model.WebPanel.
Header links - WebItemModuleDescriptor location = {webPanel.completeKey}/header
Default DropDown items - WebItemModuleDescriptor location = {webPanel.completeKey}/drop/default
DropDown sections - WebSectionModuleDescriptor location - {webPanel.completeKey}/drop
Items in those sections - WebItemModuleDescriptor location = {webpanel.completeKey}/drop/{section.key}

Summary

Nested Classes
class ModuleWebComponentFields.SectionsAndLinks  
Constants
String RENDER_PARAM_CONTAINER_CLASS
String RENDER_PARAM_HEADLESS
String RENDER_PARAM_PREFIX
Public Methods
List<ModuleWebComponentFields.SectionsAndLinks> getDropdownSections(String key, User user, JiraHelper helper)
Returns dropdown sections and links for the given module
List<SimpleLink> getHeaderItems(String key, User user, JiraHelper helper)
Returns header links for the given module
List<WebPanelModuleDescriptor> getPanels(String key, Map<String, Object> params)
Returns panel descriptors for given module

Constants

public static final String RENDER_PARAM_CONTAINER_CLASS

Constant Value: "containerClass"

public static final String RENDER_PARAM_HEADLESS

Constant Value: "headless"

public static final String RENDER_PARAM_PREFIX

Constant Value: "prefix"

Public Methods

public List<ModuleWebComponentFields.SectionsAndLinks> getDropdownSections (String key, User user, JiraHelper helper)

Returns dropdown sections and links for the given module

Parameters
key module descriptor key
user current user
helper The context under which the list is being generated
Returns
  • dropdown sections for the given module

public List<SimpleLink> getHeaderItems (String key, User user, JiraHelper helper)

Returns header links for the given module

Parameters
key module descriptor key
user current user
helper The context under which the list is being generated
Returns
  • header links for the given module

public List<WebPanelModuleDescriptor> getPanels (String key, Map<String, Object> params)

Returns panel descriptors for given module

Parameters
key module descriptor key
params The params to pass to the render
Returns
  • panel descriptors for given module