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

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

Method Detail

hasSectionsForLocation

boolean hasSectionsForLocation(java.lang.String location)

Returns:

True if there are any sections for the given location.

getSections

java.util.List<WebSectionModuleDescriptor> getSections(java.lang.String location)

Returns:

A list of all WebSectionModuleDescriptors for the given location.

getDisplayableSections

java.util.List<WebSectionModuleDescriptor> getDisplayableSections(java.lang.String location,
                                                                  java.util.Map<java.lang.String,java.lang.Object> context)

Returns:

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

getItems

java.util.List<WebItemModuleDescriptor> getItems(java.lang.String section)

Returns:

A list of all WebItemModuleDescriptors for the given section.

getDisplayableItems

java.util.List<WebItemModuleDescriptor> getDisplayableItems(java.lang.String section,
                                                            java.util.Map<java.lang.String,java.lang.Object> context)

Returns:

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

getWebPanels

java.util.List<WebPanel> getWebPanels(java.lang.String location)

Parameters:

location -

Returns:

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

getDisplayableWebPanels

java.util.List<WebPanel> getDisplayableWebPanels(java.lang.String location,
                                                 java.util.Map<java.lang.String,java.lang.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.