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 java.lang.Object
implements com.atlassian.plugin.web.WebInterfaceManager

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

Field Summary

static java.lang.String

CONTEXT_KEY_HELPER Deprecated. since 2.8 see WebInterfaceContext

Constructor Summary

ConfluenceWebInterfaceManager()

Method Summary

java.util.List<com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor>	getDisplayableItems(java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> params)
java.util.List<com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor>	getDisplayableItems(java.lang.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.
java.util.List<com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor>	getDisplayableItems(java.lang.String key, WebInterfaceContext context)
java.util.List<com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor>	getDisplayableSections(java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> params)
java.util.List<com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor>	getDisplayableSections(java.lang.String location, com.atlassian.user.User remoteUser, GlobalHelper helper) Deprecated. since 2.8 use getDisplayableSections(String, WebInterfaceContext) with the result of ConfluenceActionSupport.getWebInterfaceContext().
java.util.List<com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor>	getDisplayableSections(java.lang.String key, WebInterfaceContext context)
java.util.List<com.atlassian.plugin.web.model.WebPanel>	getDisplayableWebPanels(java.lang.String location, java.util.Map<java.lang.String,java.lang.Object> context)
java.util.List<com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor>	getItems(java.lang.String section)
java.util.List<com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor>	getSections(java.lang.String location)
com.atlassian.plugin.web.WebFragmentHelper	getWebFragmentHelper()
java.util.List<com.atlassian.plugin.web.model.WebPanel>	getWebPanels(java.lang.String location)
boolean	hasSectionsForLocation(java.lang.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

public static final java.lang.String CONTEXT_KEY_HELPER

Deprecated. since 2.8 see WebInterfaceContext

See Also:

Constant Field Values

Constructor Detail

ConfluenceWebInterfaceManager

public ConfluenceWebInterfaceManager()

Method Detail

getWebFragmentHelper

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

Specified by:

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

hasSectionsForLocation

public boolean hasSectionsForLocation(java.lang.String location)

Specified by:

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

getSections

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

Specified by:

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

getDisplayableSections

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

Specified by:

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

getDisplayableSections

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

getDisplayableSections

public java.util.List<com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor> getDisplayableSections(java.lang.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 java.util.List<com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor> getItems(java.lang.String section)

Specified by:

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

getDisplayableItems

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

Specified by:

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

getDisplayableItems

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

getDisplayableItems

public java.util.List<com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor> getDisplayableItems(java.lang.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 com.atlassian.plugin.web.WebInterfaceManager

setWebInterfaceManager

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

getWebPanels

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

Specified by:

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

getDisplayableWebPanels

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

Specified by:

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