public class

PageContext

extends RenderContext
implements LinkContext
java.lang.Object
   ↳ com.atlassian.renderer.RenderContext
     ↳ com.atlassian.confluence.renderer.PageContext

Class Overview

Context object that gets passed to the renderer to tell it what circumstances the page is being rendered in. This is used for all rendering in Confluence, not just rendering pages.

Summary

[Expand]
Inherited Constants
From interface com.atlassian.renderer.RenderContextOutputType
Public Constructors
PageContext()
PageContext(String spaceKey)
PageContext(ContentEntityObject entity)
PageContext(ContentEntityObject entity, PageContext previousContext)
Constructs a PageContext wrapping another pageContext.
Public Methods
static PageContext contextWithTimeout(ContentEntityObject entity, Timeout timeout)
Construct a new PageContext for the rendering of some entity within a given time.
static Timeout createMinimumTimeout()
Returns a timeout of 1 hour.
boolean equals(Object o)
ContentEntityObject getEntity()
PageContext getOriginalContext()
String getPageTitle()
Calendar getPostingDay()
String getSpaceKey()
Timeout getTimeout()
int hashCode()
[Expand]
Inherited Methods
From class com.atlassian.renderer.RenderContext
From class java.lang.Object

Public Constructors

public PageContext ()

public PageContext (String spaceKey)

public PageContext (ContentEntityObject entity)

public PageContext (ContentEntityObject entity, PageContext previousContext)

Constructs a PageContext wrapping another pageContext. Uses the original PageContext's Timeout and RenderedContentStore.

Public Methods

public static PageContext contextWithTimeout (ContentEntityObject entity, Timeout timeout)

Construct a new PageContext for the rendering of some entity within a given time.

public static Timeout createMinimumTimeout ()

Returns a timeout of 1 hour. No conversion or rendering should ever take anything approaching that length.

public boolean equals (Object o)

public ContentEntityObject getEntity ()

public PageContext getOriginalContext ()

public String getPageTitle ()

public Calendar getPostingDay ()

public String getSpaceKey ()

public Timeout getTimeout ()

Returns
  • a timeout object indicating whether rendering has exceeded its allotted time.

public int hashCode ()