com.atlassian.confluence.plugin.descriptor.web

Class ConfluenceWebInterfaceManager

java.lang.Object

com.atlassian.confluence.plugin.descriptor.web.ConfluenceWebInterfaceManager

All Implemented Interfaces:

com.atlassian.plugin.web.WebInterfaceManager

public class ConfluenceWebInterfaceManager
extends Object
implements com.atlassian.plugin.web.WebInterfaceManager

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTEXT_KEY_HELPER Deprecated. since 2.8 see WebInterfaceContext

Constructor Summary

Constructors

Constructor and Description
ConfluenceWebInterfaceManager()

Method Summary

Modifier and Type	Method and Description
List<com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor>	getDisplayableItems(String key, Map<String,Object> params)
List<com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor>	getDisplayableItems(String key, WebInterfaceContext context)
List<com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor>	getDisplayableSections(String key, Map<String,Object> params)
List<com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor>	getDisplayableSections(String key, WebInterfaceContext context)
List<com.atlassian.plugin.web.descriptors.WebPanelModuleDescriptor>	getDisplayableWebPanelDescriptors(String s, Map<String,Object> stringObjectMap)
List<com.atlassian.plugin.web.model.WebPanel>	getDisplayableWebPanels(String location, Map<String,Object> context)
List<com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor>	getItems(String section)
List<com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor>	getSections(String location)
com.atlassian.plugin.web.WebFragmentHelper	getWebFragmentHelper()
List<com.atlassian.plugin.web.descriptors.WebPanelModuleDescriptor>	getWebPanelDescriptors(String s)
List<com.atlassian.plugin.web.model.WebPanel>	getWebPanels(String location)
boolean	hasSectionsForLocation(String location)
void	refresh()
void	setWebInterfaceManager(com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager)

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT_KEY_HELPER

@Deprecated
public static final String CONTEXT_KEY_HELPER

Deprecated. since 2.8 see WebInterfaceContext

See Also:

Constant Field Values

Constructor Detail

ConfluenceWebInterfaceManager

public ConfluenceWebInterfaceManager()

Method Detail

getDisplayableWebPanelDescriptors

public List<com.atlassian.plugin.web.descriptors.WebPanelModuleDescriptor> getDisplayableWebPanelDescriptors(String s,
                                                                                                             Map<String,Object> stringObjectMap)

Specified by:

getDisplayableWebPanelDescriptors in interface com.atlassian.plugin.web.WebInterfaceManager

getWebPanelDescriptors

public List<com.atlassian.plugin.web.descriptors.WebPanelModuleDescriptor> getWebPanelDescriptors(String s)

Specified by:

getWebPanelDescriptors in interface com.atlassian.plugin.web.WebInterfaceManager

getWebFragmentHelper

public com.atlassian.plugin.web.WebFragmentHelper getWebFragmentHelper()

Specified by:

getWebFragmentHelper in interface com.atlassian.plugin.web.WebInterfaceManager

hasSectionsForLocation

public boolean hasSectionsForLocation(String location)

Specified by:

hasSectionsForLocation in interface com.atlassian.plugin.web.WebInterfaceManager

getSections

public List<com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor> getSections(String location)

Specified by:

getSections in interface com.atlassian.plugin.web.WebInterfaceManager

getDisplayableSections

public List<com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor> getDisplayableSections(String key,
                                                                                                    Map<String,Object> params)

Specified by:

getDisplayableSections in interface com.atlassian.plugin.web.WebInterfaceManager

getDisplayableSections

public List<com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor> getDisplayableSections(String key,
                                                                                                    WebInterfaceContext context)

getItems

public List<com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor> getItems(String section)

Specified by:

getItems in interface com.atlassian.plugin.web.WebInterfaceManager

getDisplayableItems

public List<com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor> getDisplayableItems(String key,
                                                                                              Map<String,Object> params)

Specified by:

getDisplayableItems in interface com.atlassian.plugin.web.WebInterfaceManager

getDisplayableItems

public List<com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor> getDisplayableItems(String key,
                                                                                              WebInterfaceContext context)

refresh

public void refresh()

Specified by:

refresh in interface com.atlassian.plugin.web.WebInterfaceManager

setWebInterfaceManager

public void setWebInterfaceManager(com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager)

getWebPanels

public List<com.atlassian.plugin.web.model.WebPanel> getWebPanels(String location)

Specified by:

getWebPanels in interface com.atlassian.plugin.web.WebInterfaceManager

getDisplayableWebPanels

public List<com.atlassian.plugin.web.model.WebPanel> getDisplayableWebPanels(String location,
                                                                             Map<String,Object> context)

Specified by:

getDisplayableWebPanels in interface com.atlassian.plugin.web.WebInterfaceManager