Package com.atlassian.jira.web.component

Interface ModuleWebComponentFields

All Known Implementing Classes:

ModuleWebComponentFieldsImpl

public interface ModuleWebComponentFields

Utility to extract fields from a 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}

Since:

v5.2

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ModuleWebComponentFields.SectionsAndLinks

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RENDER_PARAM_CONTAINER_CLASS
static final String	RENDER_PARAM_HEADLESS
static final String	RENDER_PARAM_PREFIX

Method Summary

Modifier and Type	Method	Description
List<ModuleWebComponentFields.SectionsAndLinks>	getDropdownSections(String key, ApplicationUser user, JiraHelper helper)	Returns dropdown sections and links for the given module
List<SimpleLink>	getHeaderItems(String key, ApplicationUser user, JiraHelper helper)	Returns header links for the given module
List<? extends com.atlassian.plugin.web.api.descriptors.WebPanelModuleDescriptor<? extends com.atlassian.plugin.web.api.model.WebPanel>>	getPanels(String key, Map<String,Object> params)	Returns panel descriptors for given module

Field Details

RENDER_PARAM_HEADLESS

static final String RENDER_PARAM_HEADLESS

See Also:

• Constant Field Values

RENDER_PARAM_CONTAINER_CLASS

static final String RENDER_PARAM_CONTAINER_CLASS

See Also:

• Constant Field Values

RENDER_PARAM_PREFIX

static final String RENDER_PARAM_PREFIX

See Also:

• Constant Field Values

Method Details

getHeaderItems

List<SimpleLink> getHeaderItems(@Nonnull
 String key,
 ApplicationUser user,
 @Nonnull
 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

getDropdownSections

List<ModuleWebComponentFields.SectionsAndLinks> getDropdownSections(@Nonnull
 String key,
 ApplicationUser user,
 @Nonnull
 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

getPanels

List<? extends com.atlassian.plugin.web.api.descriptors.WebPanelModuleDescriptor<? extends com.atlassian.plugin.web.api.model.WebPanel>> getPanels(@Nonnull
 String key,
 @Nonnull
 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