com.atlassian.confluence.impl.util

Class DecoratorUtil

java.lang.Object

com.atlassian.confluence.impl.util.DecoratorUtil

public class DecoratorUtil
extends Object

This class provides helper methods for deferred rendering of page sections in main decorator

Since:

5.10

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DecoratorUtil.ContentNavigationContext
static class	DecoratorUtil.SideBarContext

Constructor Summary

Constructors

Constructor and Description
DecoratorUtil()

Method Summary

Modifier and Type	Method and Description
static DecoratorUtil.ContentNavigationContext	getContentNavContext() Methods returns page/blogpost context, saved into request for deferred (sitemesh) content nav execution.
static DecoratorUtil.SideBarContext	getSidebarContext() Methods returns page/blogpost context, saved into request for deferred (sitemesh) sidebar execution.
static boolean	hasContentNavContext() Methods returns true if content navigation context was set to http request, false otherwise
static boolean	hasSidebarContext() Methods returns true if sidebar context was set to http request, false otherwise
static void	setContentNavContext(AbstractPage page, String mode, String context, ThemeHelper helper) Page/blogpost context should be saved for deferred (sitemesh) content navigation execution, because main sitemesh decorator is executed under DecoratorAction, which does not contain page/space context of the main request.
static void	setSidebarContext(Space space, AbstractPage page, String pageId, String context, String contextKey, String collectorKey) Page/blogpost context should be saved for deferred (sitemesh) sidebar execution, because main sitemesh decorator is executed under DecoratorAction, which does not contain page/space context of the main request.

Methods inherited from class java.lang.Object

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

Constructor Detail

DecoratorUtil

public DecoratorUtil()

Method Detail

setSidebarContext

public static void setSidebarContext(Space space,
                                     AbstractPage page,
                                     String pageId,
                                     String context,
                                     String contextKey,
                                     String collectorKey)

Page/blogpost context should be saved for deferred (sitemesh) sidebar execution, because main sitemesh decorator is executed under DecoratorAction, which does not contain page/space context of the main request. Context is saved as attribute in HttpServletRequest.

Parameters:

page - current page

pageId - current page id

context - execution context name

contextKey - context key

collectorKey - collector key

Since:

5.10

setContentNavContext

public static void setContentNavContext(AbstractPage page,
                                        String mode,
                                        String context,
                                        ThemeHelper helper)

Page/blogpost context should be saved for deferred (sitemesh) content navigation execution, because main sitemesh decorator is executed under DecoratorAction, which does not contain page/space context of the main request. Context is saved as attribute in HttpServletRequest.

Parameters:

page - current page

mode - mode

context - execution context name

helper - page helper

Since:

5.10

hasSidebarContext

public static boolean hasSidebarContext()

Methods returns true if sidebar context was set to http request, false otherwise

Since:

5.10

hasContentNavContext

public static boolean hasContentNavContext()

Methods returns true if content navigation context was set to http request, false otherwise

Since:

5.10

getSidebarContext

public static DecoratorUtil.SideBarContext getSidebarContext()

Methods returns page/blogpost context, saved into request for deferred (sitemesh) sidebar execution.

Since:

5.10

See Also:

DecoratorUtil.SideBarContext

getContentNavContext

public static DecoratorUtil.ContentNavigationContext getContentNavContext()

Methods returns page/blogpost context, saved into request for deferred (sitemesh) content nav execution.

Since:

5.10

See Also:

DecoratorUtil.ContentNavigationContext