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	getDisplayableItems(java.lang.String section, java.util.Map context)
java.util.List	getDisplayableSections(java.lang.String location, java.util.Map context)
java.util.List	getItems(java.lang.String section)
java.util.List	getSections(java.lang.String location)
WebFragmentHelper	getWebFragmentHelper()
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 getSections(java.lang.String location)

Returns:

A list of all WebSectionModuleDescriptors for the given location.

getDisplayableSections

java.util.List getDisplayableSections(java.lang.String location,
                                      java.util.Map context)

Returns:

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

getItems

java.util.List getItems(java.lang.String section)

Returns:

A list of all WebItemModuleDescriptors for the given section.

getDisplayableItems

java.util.List getDisplayableItems(java.lang.String section,
                                   java.util.Map context)

Returns:

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

refresh

void refresh()

Refresh the contents of the web interface manager.

getWebFragmentHelper

WebFragmentHelper getWebFragmentHelper()

Returns:

The web fragment helper for this implementation.