Summary: Methods | [Expand All]
public interface

WebInterfaceManager

com.atlassian.plugin.web.WebInterfaceManager
Known Indirect Subclasses

Class Overview

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

Summary

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

Public Methods

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

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

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

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

public abstract List<WebPanelModuleDescriptor> getDisplayableWebPanelDescriptors (String location, Map<String, Object> context)

Returns

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

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

public abstract List<WebItemModuleDescriptor> getItems (String section)

Returns
  • A list of all WebItemModuleDescriptors for the given section.

public abstract List<WebSectionModuleDescriptor> getSections (String location)

Returns
  • A list of all WebSectionModuleDescriptors for the given location.

public abstract WebFragmentHelper getWebFragmentHelper ()

Returns
  • The web fragment helper for this implementation.

public abstract List<WebPanelModuleDescriptor> getWebPanelDescriptors (String location)

Returns

public abstract List<WebPanel> getWebPanels (String location)

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

public abstract boolean hasSectionsForLocation (String location)

Returns
  • True if there are any sections for the given location.

public abstract void refresh ()

Refresh the contents of the web interface manager.