com.atlassian.confluence.renderer.v2.macros
Class PageIncludeMacro

java.lang.Object
  com.atlassian.renderer.v2.macro.BaseMacro
      com.atlassian.confluence.renderer.v2.macros.PageIncludeMacro

All Implemented Interfaces:

com.atlassian.renderer.v2.macro.Macro

public class PageIncludeMacro
extends com.atlassian.renderer.v2.macro.BaseMacro

A macro to include one Confluence page within another

Field Summary

static org.apache.log4j.Category

log

Fields inherited from interface com.atlassian.renderer.v2.macro.Macro

RAW_PARAMS_KEY

Constructor Summary

PageIncludeMacro()

Method Summary

java.lang.String	execute(java.util.Map parameters, java.lang.String body, com.atlassian.renderer.RenderContext renderContext)
protected java.lang.String	fetchPageContent(java.lang.String spaceKey, java.lang.String pageTitle, java.util.Map parameters, PageContext pageContext)
com.atlassian.renderer.v2.RenderMode	getBodyRenderMode()
boolean	hasBody()
boolean	isInline()
void	setPageManager(PageManager pageManager)
void	setPermissionManager(PermissionManager permissionManager)
void	setSpaceManager(SpaceManager spaceManager)
void	setSubRenderer(com.atlassian.renderer.v2.SubRenderer subRenderer)

Methods inherited from class com.atlassian.renderer.v2.macro.BaseMacro

suppressMacroRenderingDuringWysiwyg, suppressSurroundingTagDuringWysiwygRendering

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final org.apache.log4j.Category log

Constructor Detail

PageIncludeMacro

public PageIncludeMacro()

Method Detail

isInline

public boolean isInline()

getBodyRenderMode

public com.atlassian.renderer.v2.RenderMode getBodyRenderMode()

hasBody

public boolean hasBody()

execute

public java.lang.String execute(java.util.Map parameters,
                                java.lang.String body,
                                com.atlassian.renderer.RenderContext renderContext)
                         throws com.atlassian.renderer.v2.macro.MacroException

Throws:

com.atlassian.renderer.v2.macro.MacroException

fetchPageContent

protected java.lang.String fetchPageContent(java.lang.String spaceKey,
                                            java.lang.String pageTitle,
                                            java.util.Map parameters,
                                            PageContext pageContext)

setPageManager

public void setPageManager(PageManager pageManager)

setSubRenderer

public void setSubRenderer(com.atlassian.renderer.v2.SubRenderer subRenderer)

setPermissionManager

public void setPermissionManager(PermissionManager permissionManager)

setSpaceManager

public void setSpaceManager(SpaceManager spaceManager)