com.atlassian.plugin.web
Interface WebInterfaceManager

All Known Implementing Classes:

DefaultWebInterfaceManager

public interface WebInterfaceManager

A simple manager to provide sections of the web interface through plugins.

Method Summary

List<WebItemModuleDescriptor>	getDisplayableItems(String section, Map<String,Object> context)
List<WebSectionModuleDescriptor>	getDisplayableSections(String location, Map<String,Object> context)
List<WebPanel>	getDisplayableWebPanels(String location, Map<String,Object> context)
List<WebItemModuleDescriptor>	getItems(String section)
List<WebSectionModuleDescriptor>	getSections(String location)
WebFragmentHelper	getWebFragmentHelper()
List<WebPanel>	getWebPanels(String location)
boolean	hasSectionsForLocation(String location)
void	refresh() Refresh the contents of the web interface manager.

Method Detail

hasSectionsForLocation

boolean hasSectionsForLocation(String location)

Returns:

True if there are any sections for the given location.

getSections

List<WebSectionModuleDescriptor> getSections(String location)

Returns:

A list of all WebSectionModuleDescriptors for the given location.

getDisplayableSections

List<WebSectionModuleDescriptor> getDisplayableSections(String location,
                                                        Map<String,Object> context)

Returns:

A list of all AbstractWebLinkFragmentModuleDescriptor viewable in a given context in the given location.

getItems

List<WebItemModuleDescriptor> getItems(String section)

Returns:

A list of all WebItemModuleDescriptors for the given section.

getDisplayableItems

List<WebItemModuleDescriptor> getDisplayableItems(String section,
                                                  Map<String,Object> context)

Returns:

A list of all AbstractWebLinkFragmentModuleDescriptor viewable in a given context in the given section.

getWebPanels

List<WebPanel> getWebPanels(String location)

Parameters:

location -

Returns:

A list of all WebPanel module instances for the given location.

getDisplayableWebPanels

List<WebPanel> getDisplayableWebPanels(String location,
                                       Map<String,Object> context)

Parameters:

location -

context -

Returns:

A list of all WebPanel module instances viewable in a given context in the given location.

refresh

void refresh()

Refresh the contents of the web interface manager.

getWebFragmentHelper

WebFragmentHelper getWebFragmentHelper()

Returns:

The web fragment helper for this implementation.