Package com.atlassian.jira.web.component

Interface ModuleWebComponent

All Known Implementing Classes:
ModuleWebComponentImpl
public interface ModuleWebComponent
Renders WebPanel with the common JIRA module structure. It also makes the header links and dropdown links.
Since:
v4.4

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    renderModule(ApplicationUser user, javax.servlet.http.HttpServletRequest request, com.atlassian.plugin.web.api.descriptors.WebPanelModuleDescriptor<? extends com.atlassian.plugin.web.api.model.WebPanel> webPanelModuleDescriptor, Map<String,Object> params)
     
    String
    renderModules(ApplicationUser user, javax.servlet.http.HttpServletRequest request, List<? extends com.atlassian.plugin.web.api.descriptors.WebPanelModuleDescriptor<? extends com.atlassian.plugin.web.api.model.WebPanel>> webPanelModuleDescriptors, Map<String,Object> params)
    A convienence method that iterates over of the list of WebPanels and renders each.

  • Method Details

    • renderModules

      String renderModules(ApplicationUser user, javax.servlet.http.HttpServletRequest request, List<? extends com.atlassian.plugin.web.api.descriptors.WebPanelModuleDescriptor<? extends com.atlassian.plugin.web.api.model.WebPanel>> 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(ApplicationUser user, javax.servlet.http.HttpServletRequest request, com.atlassian.plugin.web.api.descriptors.WebPanelModuleDescriptor<? extends com.atlassian.plugin.web.api.model.WebPanel> 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