org.exoplatform.wiki.rendering.macro.pagetree

Class PageTreeMacroParameters

java.lang.Object

org.exoplatform.wiki.rendering.macro.pagetree.PageTreeMacroParameters

public class PageTreeMacroParameters
extends Object

Constructor Summary

Constructors

Constructor and Description
PageTreeMacroParameters()

Method Summary

Modifier and Type	Method and Description
String	getRoot()
String	getStartDepth()
boolean	isExcerpt()
void	setExcerpt(boolean excerpt)
void	setRoot(String root)
void	setStartDepth(String depth)

Methods inherited from class java.lang.Object

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

Constructor Detail

PageTreeMacroParameters

public PageTreeMacroParameters()

Method Detail

getRoot

public String getRoot()

Returns:

root page of children

setRoot

public void setRoot(String root)

Parameters:

root - root of page tree

getStartDepth

public String getStartDepth()

Returns:

the depth of children

setStartDepth

public void setStartDepth(String depth)
                   throws org.xwiki.rendering.macro.MacroExecutionException

Parameters:

depth - depth of children to set

Throws:

org.xwiki.rendering.macro.MacroExecutionException - if parameter is not empty and not a number

isExcerpt

public boolean isExcerpt()

Returns:

the value allow hide excerpt or not

setExcerpt

public void setExcerpt(boolean excerpt)

Parameters:

excerpt - the value show excerpt to set