com.atlassian.confluence.renderer.radeox.macros
Class IndexMacro

java.lang.Object
  org.radeox.macro.BaseMacro
      com.atlassian.renderer.macro.BaseMacro
          com.atlassian.confluence.renderer.radeox.macros.AbstractHtmlGeneratingMacro
              com.atlassian.confluence.renderer.radeox.macros.IndexMacro

All Implemented Interfaces:

java.lang.Comparable, org.radeox.macro.Macro

public class IndexMacro
extends AbstractHtmlGeneratingMacro

Another SnipSnap compatibility macro. We only support {index:AtoZ} -style indexes at the moment, but it should be pretty easy to add other ones - just change the .vm file that is doing the rendering.

Nested Class Summary

static class

IndexMacro.AlphabeticPageListing

Field Summary

static org.apache.log4j.Category

log

Fields inherited from class org.radeox.macro.BaseMacro

initialContext, paramDescription

Constructor Summary

IndexMacro()

Method Summary

java.lang.String	getHtml(org.radeox.macro.parameter.MacroParameter macroParameter)
java.lang.String	getName()
java.lang.String[]	getParamDescription()
void	setPageManager(PageManager pageManager)
void	setPermissionManager(PermissionManager permissionManager)
void	setSettingsManager(SettingsManager settingsManager)
void	setSpaceManager(SpaceManager spaceManager)

Methods inherited from class com.atlassian.confluence.renderer.radeox.macros.AbstractHtmlGeneratingMacro

buildBaseUrl, errorContent, execute, getPageContext, getRemoteUser, hasLoneParameter, parseParameterForKey

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

getDescription, getResourcePath, setDescription, setResourcePath

Methods inherited from class org.radeox.macro.BaseMacro

compareTo, setInitialContext, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.radeox.macro.Macro

setInitialContext

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

log

public static final org.apache.log4j.Category log

Constructor Detail

IndexMacro

public IndexMacro()

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface org.radeox.macro.Macro

Specified by:

getName in class org.radeox.macro.BaseMacro

getParamDescription

public java.lang.String[] getParamDescription()

Specified by:

getParamDescription in interface org.radeox.macro.Macro

Overrides:

getParamDescription in class org.radeox.macro.BaseMacro

getHtml

public java.lang.String getHtml(org.radeox.macro.parameter.MacroParameter macroParameter)
                         throws java.lang.IllegalArgumentException,
                                java.io.IOException

Specified by:

getHtml in class AbstractHtmlGeneratingMacro

Throws:

java.lang.IllegalArgumentException

java.io.IOException

setSettingsManager

public void setSettingsManager(SettingsManager settingsManager)

setSpaceManager

public void setSpaceManager(SpaceManager spaceManager)

setPermissionManager

public void setPermissionManager(PermissionManager permissionManager)

setPageManager

public void setPageManager(PageManager pageManager)