com.atlassian.jira.web.component
Interface ModuleWebComponent

All Known Implementing Classes:
ModuleWebComponentImpl

public interface ModuleWebComponent

A ui utility to wrap a WebPanel with the common JIRA module structure. It also makes the header links and dropdown links.
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:
v4.4

Method Summary
 String renderModule(com.atlassian.crowd.embedded.api.User user, javax.servlet.http.HttpServletRequest request, com.atlassian.plugin.web.descriptors.WebPanelModuleDescriptor webPanelModuleDescriptor, Map<String,Object> params)
           
 String renderModules(com.atlassian.crowd.embedded.api.User user, javax.servlet.http.HttpServletRequest request, List<com.atlassian.plugin.web.descriptors.WebPanelModuleDescriptor> webPanelModuleDescriptors, Map<String,Object> params)
          A convienence method that iterates over of the list of WebPanels and renders each.
 

Method Detail

renderModules

String renderModules(com.atlassian.crowd.embedded.api.User user,
                     javax.servlet.http.HttpServletRequest request,
                     List<com.atlassian.plugin.web.descriptors.WebPanelModuleDescriptor> webPanelModuleDescriptors,
                     Map<String,Object> params)
A convienence method that iterates over of the list of WebPanels and renders each.

Parameters:
user - The user that we are rendering these for
request - The request that these web panels are being rendered in
webPanelModuleDescriptors - The list of WebPanels being rendered
params - The params to pass to the render
Returns:
The rendered HTML

renderModule

String renderModule(com.atlassian.crowd.embedded.api.User user,
                    javax.servlet.http.HttpServletRequest request,
                    com.atlassian.plugin.web.descriptors.WebPanelModuleDescriptor webPanelModuleDescriptor,
                    Map<String,Object> params)
Parameters:
user - The user that we are rendering these for
request - The request that these web panels are being rendered in
webPanelModuleDescriptor - The WebPanel to render
params - The params to pass to the render
Returns:
The rendered HTML


Copyright © 2002-2012 Atlassian. All Rights Reserved.