com.atlassian.plugin.web

Class DefaultWebInterfaceManager

java.lang.Object

com.atlassian.plugin.web.DefaultWebInterfaceManager

All Implemented Interfaces:

DynamicWebInterfaceManager, WebInterfaceManager

public class DefaultWebInterfaceManager
extends Object
implements DynamicWebInterfaceManager

Stores and manages flexible web interface sections available in the system.

Field Summary

Fields

Modifier and Type	Field and Description
static WeightedDescriptorComparator	WEIGHTED_DESCRIPTOR_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
DefaultWebInterfaceManager()
DefaultWebInterfaceManager(com.atlassian.event.api.EventPublisher eventPublisher, com.atlassian.plugin.PluginAccessor pluginAccessor, WebFragmentHelper webFragmentHelper) Deprecated. eventPublisher no longer used
DefaultWebInterfaceManager(com.atlassian.plugin.PluginAccessor pluginAccessor, WebFragmentHelper webFragmentHelper)

Method Summary

Modifier and Type	Method and Description
List<WebItemModuleDescriptor>	getDisplayableItems(String section, Map<String,Object> context)
List<WebSectionModuleDescriptor>	getDisplayableSections(String location, Map<String,Object> context)
Iterable<WebItem>	getDisplayableWebItems(String section, Map<String,Object> context)
List<WebPanelModuleDescriptor>	getDisplayableWebPanelDescriptors(String location, Map<String,Object> context)
List<WebPanel>	getDisplayableWebPanels(String location, Map<String,Object> context)
Iterable<WebSection>	getDisplayableWebSections(String location, Map<String,Object> context)
List<WebItemModuleDescriptor>	getItems(String section)
List<WebSectionModuleDescriptor>	getSections(String location)
WebFragmentHelper	getWebFragmentHelper()
Iterable<WebItem>	getWebItems(String section, Map<String,Object> context)
List<WebPanelModuleDescriptor>	getWebPanelDescriptors(String location)
List<WebPanel>	getWebPanels(String location)
Iterable<WebSection>	getWebSections(String location, Map<String,Object> context)
boolean	hasSectionsForLocation(String location)
void	refresh()
void	setPluginAccessor(com.atlassian.plugin.PluginAccessor pluginAccessor)
void	setWebFragmentHelper(WebFragmentHelper webFragmentHelper)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

WEIGHTED_DESCRIPTOR_COMPARATOR

public static final WeightedDescriptorComparator WEIGHTED_DESCRIPTOR_COMPARATOR

Constructor Detail

DefaultWebInterfaceManager

public DefaultWebInterfaceManager()

DefaultWebInterfaceManager

public DefaultWebInterfaceManager(com.atlassian.plugin.PluginAccessor pluginAccessor,
                                  WebFragmentHelper webFragmentHelper)

DefaultWebInterfaceManager

@Deprecated
public DefaultWebInterfaceManager(@Nullable
                                              com.atlassian.event.api.EventPublisher eventPublisher,
                                              @Nullable
                                              com.atlassian.plugin.PluginAccessor pluginAccessor,
                                              @Nullable
                                              WebFragmentHelper webFragmentHelper)

Deprecated. eventPublisher no longer used

Parameters:

eventPublisher -

pluginAccessor -

webFragmentHelper -

Since:

5.2.0

Method Detail

hasSectionsForLocation

public boolean hasSectionsForLocation(String location)

Specified by:

hasSectionsForLocation in interface WebInterfaceManager

getSections

public List<WebSectionModuleDescriptor> getSections(String location)

Specified by:

getSections in interface WebInterfaceManager

getDisplayableSections

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

Specified by:

getDisplayableSections in interface WebInterfaceManager

getItems

public List<WebItemModuleDescriptor> getItems(String section)

Specified by:

getItems in interface WebInterfaceManager

getDisplayableItems

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

Specified by:

getDisplayableItems in interface WebInterfaceManager

getDisplayableWebPanels

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

Specified by:

getDisplayableWebPanels in interface WebInterfaceManager

getDisplayableWebPanelDescriptors

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

Specified by:

getDisplayableWebPanelDescriptors in interface WebInterfaceManager

getWebPanels

public List<WebPanel> getWebPanels(String location)

Specified by:

getWebPanels in interface WebInterfaceManager

getWebPanelDescriptors

public List<WebPanelModuleDescriptor> getWebPanelDescriptors(String location)

Specified by:

getWebPanelDescriptors in interface WebInterfaceManager

refresh

public void refresh()

Specified by:

refresh in interface WebInterfaceManager

setPluginAccessor

public void setPluginAccessor(com.atlassian.plugin.PluginAccessor pluginAccessor)

Parameters:

pluginAccessor - The plugin accessor to set

Since:

2.2.0

getWebFragmentHelper

public WebFragmentHelper getWebFragmentHelper()

Specified by:

getWebFragmentHelper in interface WebInterfaceManager

setWebFragmentHelper

public void setWebFragmentHelper(WebFragmentHelper webFragmentHelper)

getWebItems

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

Specified by:

getWebItems in interface DynamicWebInterfaceManager

getDisplayableWebItems

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

Specified by:

getDisplayableWebItems in interface DynamicWebInterfaceManager

getWebSections

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

Specified by:

getWebSections in interface DynamicWebInterfaceManager

getDisplayableWebSections

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

Specified by:

getDisplayableWebSections in interface DynamicWebInterfaceManager