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

java.lang.Object
  com.atlassian.confluence.plugin.descriptor.web.ConfluenceWebInterfaceManager

All Implemented Interfaces:

WebInterfaceManager

public class ConfluenceWebInterfaceManager
extends Object
implements WebInterfaceManager

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

Field Summary

static String

CONTEXT_KEY_HELPER Deprecated. since 2.8 see WebInterfaceContext

Constructor Summary

ConfluenceWebInterfaceManager()

Method Summary

List<WebItemModuleDescriptor>	getDisplayableItems(String key, Map<String,Object> params)
List<WebItemModuleDescriptor>	getDisplayableItems(String section, com.atlassian.user.User remoteUser, GlobalHelper helper) Deprecated. since 2.8 use getDisplayableItems(String, WebInterfaceContext) with the result of getWebInterfaceContext() on your action.
List<WebItemModuleDescriptor>	getDisplayableItems(String key, WebInterfaceContext context)
List<WebSectionModuleDescriptor>	getDisplayableSections(String key, Map<String,Object> params)
List<WebSectionModuleDescriptor>	getDisplayableSections(String location, com.atlassian.user.User remoteUser, GlobalHelper helper) Deprecated. since 2.8 use getDisplayableSections(String, WebInterfaceContext) with the result of ConfluenceActionSupport.getWebInterfaceContext().
List<WebSectionModuleDescriptor>	getDisplayableSections(String key, WebInterfaceContext context)
List<WebPanelModuleDescriptor>	getDisplayableWebPanelDescriptors(String s, Map<String,Object> stringObjectMap)
List<WebPanel>	getDisplayableWebPanels(String location, Map<String,Object> context)
List<WebItemModuleDescriptor>	getItems(String section)
List<WebSectionModuleDescriptor>	getSections(String location)
WebFragmentHelper	getWebFragmentHelper()
List<WebPanelModuleDescriptor>	getWebPanelDescriptors(String s)
List<WebPanel>	getWebPanels(String location)
boolean	hasSectionsForLocation(String location)
void	refresh()
void	setWebInterfaceManager(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<WebPanelModuleDescriptor> getDisplayableWebPanelDescriptors(String s,
                                                                        Map<String,Object> stringObjectMap)

Specified by:

getDisplayableWebPanelDescriptors in interface WebInterfaceManager

getWebPanelDescriptors

public List<WebPanelModuleDescriptor> getWebPanelDescriptors(String s)

Specified by:

getWebPanelDescriptors in interface WebInterfaceManager

getWebFragmentHelper

public WebFragmentHelper getWebFragmentHelper()

Specified by:

getWebFragmentHelper in interface WebInterfaceManager

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 key,
                                                               Map<String,Object> params)

Specified by:

getDisplayableSections in interface WebInterfaceManager

getDisplayableSections

public List<WebSectionModuleDescriptor> getDisplayableSections(String key,
                                                               WebInterfaceContext context)

getDisplayableSections

@Deprecated
public List<WebSectionModuleDescriptor> getDisplayableSections(String location,
                                                                          com.atlassian.user.User remoteUser,
                                                                          GlobalHelper helper)

Deprecated. since 2.8 use getDisplayableSections(String, WebInterfaceContext) with the result of ConfluenceActionSupport.getWebInterfaceContext().

getItems

public List<WebItemModuleDescriptor> getItems(String section)

Specified by:

getItems in interface WebInterfaceManager

getDisplayableItems

public List<WebItemModuleDescriptor> getDisplayableItems(String key,
                                                         Map<String,Object> params)

Specified by:

getDisplayableItems in interface WebInterfaceManager

getDisplayableItems

public List<WebItemModuleDescriptor> getDisplayableItems(String key,
                                                         WebInterfaceContext context)

getDisplayableItems

@Deprecated
public List<WebItemModuleDescriptor> getDisplayableItems(String section,
                                                                    com.atlassian.user.User remoteUser,
                                                                    GlobalHelper helper)

Deprecated. since 2.8 use getDisplayableItems(String, WebInterfaceContext) with the result of getWebInterfaceContext() on your action.

refresh

public void refresh()

Specified by:

refresh in interface WebInterfaceManager

setWebInterfaceManager

public void setWebInterfaceManager(WebInterfaceManager webInterfaceManager)

getWebPanels

public List<WebPanel> getWebPanels(String location)

Specified by:

getWebPanels in interface WebInterfaceManager

getDisplayableWebPanels

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

Specified by:

getDisplayableWebPanels in interface WebInterfaceManager