com.atlassian.plugin.web.api

Interface DynamicWebInterfaceManager

All Superinterfaces:

WebInterfaceManager

public interface DynamicWebInterfaceManager
extends WebInterfaceManager

A dynamic web interface manager extends the existing WebInterfaceManager interface with methods to retrieve items and sections that are created by WebItemProviders and WebSectionProviders as well as static items and sections returned by the existing WebInterfaceManager.

Host applications and plugins should use these methods in favour of the WebInterfaceManager to retrieve pluggable items and sections since it allows for greater flexibility when writing plugins.

Since:

v3.0.2

Method Summary

Modifier and Type	Method and Description
Iterable<WebItem>	getDisplayableWebItems(String section, Map<String,Object> context) Same as getWebItems(String, java.util.Map) but apply conditions for static web-items using the context provided.
Iterable<WebSection>	getDisplayableWebSections(String location, Map<String,Object> context) Same as getWebSections(String, java.util.Map) but apply conditions for static web-sections using the context provided.
Iterable<WebItem>	getWebItems(String section, Map<String,Object> context) Returns a collection of web-items for the provided section.
Iterable<WebSection>	getWebSections(String location, Map<String,Object> context) Returns a collection of web-sections for the provided location.

Methods inherited from interface com.atlassian.plugin.web.WebInterfaceManager

getDisplayableItems, getDisplayableSections, getDisplayableWebPanelDescriptors, getDisplayableWebPanels, getItems, getSections, getWebFragmentHelper, getWebPanelDescriptors, getWebPanels, hasSectionsForLocation, refresh

Method Detail

getWebItems

Iterable<WebItem> getWebItems(String section,
                              Map<String,Object> context)

Returns a collection of web-items for the provided section. This collection is made up of both static web-items defined in atlassian-plugin.xmls as well as dynamic items provided by WebItemProviders. For static items, no conditions will be applied.

At a minimum, context should provide a "request" HttpServletRequest object to aid with rendering of links including contextpath.

Parameters:

section - the section in which web-items should be located

context - context to render urls, tooltips etc

Returns:

a collection of web-items for the provided section

getDisplayableWebItems

Iterable<WebItem> getDisplayableWebItems(String section,
                                         Map<String,Object> context)

Same as getWebItems(String, java.util.Map) but apply conditions for static web-items using the context provided.

At a minimum, context should provide a "request" HttpServletRequest object to aid with rendering of links including contextpath.

getWebSections

Iterable<WebSection> getWebSections(String location,
                                    Map<String,Object> context)

Returns a collection of web-sections for the provided location. This collection is made up of both static web-sections defined in atlassian-plugin.xmls as well as dynamic sections provided by WebSectionProviders. For static sections, no conditions will be applied.

At a minimum, context should provide a "request" HttpServletRequest object to aid with rendering of links including contextpath.

Parameters:

location - the location in which web-sections should be located

context - context to render urls, tooltips etc

Returns:

a collection of web-sections for the provided section

getDisplayableWebSections

Iterable<WebSection> getDisplayableWebSections(String location,
                                               Map<String,Object> context)

Same as getWebSections(String, java.util.Map) but apply conditions for static web-sections using the context provided.

At a minimum, context should provide a "request" HttpServletRequest object to aid with rendering of links including contextpath.