org.xwiki.rendering.internal.macro.toc
Class TocMacro

java.lang.Object
  org.xwiki.rendering.macro.AbstractMacro<TocMacroParameters>
      org.xwiki.rendering.internal.macro.toc.TocMacro

All Implemented Interfaces:

Comparable<Macro<?>>, org.xwiki.component.phase.Initializable, Macro<TocMacroParameters>

@Component
@Named(value="toc")
@Singleton
public class TocMacro
extends AbstractMacro<TocMacroParameters>

Generate a Table Of Contents based on the document sections.

Since:

1.5M2

Version:

$Id$

Field Summary

Fields inherited from class org.xwiki.rendering.macro.AbstractMacro

beanManager, DEFAULT_CATEGORY_CONTENT, DEFAULT_CATEGORY_DEVELOPMENT, DEFAULT_CATEGORY_FORMATTING, DEFAULT_CATEGORY_NAVIGATION

Constructor Summary

TocMacro()
Create and initialize the descriptor of the macro.

Method Summary

List<Block>	execute(TocMacroParameters parameters, String content, MacroTransformationContext context)
void	initialize()
boolean	supportsInlineMode()

Methods inherited from class org.xwiki.rendering.macro.AbstractMacro

compareTo, getDescriptor, getPriority, setDefaultCategory, setDescriptor, setPriority

Methods inherited from class java.lang.Object

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

Constructor Detail

TocMacro

public TocMacro()

Create and initialize the descriptor of the macro.

Method Detail

initialize

public void initialize()
                throws org.xwiki.component.phase.InitializationException

Specified by:

initialize in interface org.xwiki.component.phase.Initializable

Overrides:

initialize in class AbstractMacro<TocMacroParameters>

Throws:

org.xwiki.component.phase.InitializationException

See Also:

Initializable.initialize()

supportsInlineMode

public boolean supportsInlineMode()

See Also:

Macro.supportsInlineMode()

execute

public List<Block> execute(TocMacroParameters parameters,
                           String content,
                           MacroTransformationContext context)
                    throws MacroExecutionException

Throws:

MacroExecutionException

See Also:

Macro.execute(Object, String, MacroTransformationContext)