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
static class ModuleWebComponentFields.SectionsAndLinks
           
 
Field Summary
static String RENDER_PARAM_CONTAINER_CLASS
           
static String RENDER_PARAM_HEADLESS
           
static String RENDER_PARAM_PREFIX
           
 
Method Summary
 List<ModuleWebComponentFields.SectionsAndLinks> getDropdownSections(String key, com.atlassian.crowd.embedded.api.User user, JiraHelper helper)
          Returns dropdown sections and links for the given module
 List<SimpleLink> getHeaderItems(String key, com.atlassian.crowd.embedded.api.User user, JiraHelper helper)
          Returns header links for the given module
 List<com.atlassian.plugin.web.descriptors.WebPanelModuleDescriptor> getPanels(String key, Map<String,Object> params)
          Returns panel descriptors for given module
 

Field Detail

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 Detail

getHeaderItems

List<SimpleLink> getHeaderItems(@NotNull
                                String key,
                                com.atlassian.crowd.embedded.api.User user,
                                @NotNull
                                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(@NotNull
                                                                    String key,
                                                                    com.atlassian.crowd.embedded.api.User user,
                                                                    @NotNull
                                                                    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<com.atlassian.plugin.web.descriptors.WebPanelModuleDescriptor> getPanels(@NotNull
                                                                              String key,
                                                                              @NotNull
                                                                              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


Copyright © 2002-2013 Atlassian. All Rights Reserved.