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

java.lang.Object
  org.xwiki.rendering.block.PlainTextBlockFilter
      org.xwiki.rendering.internal.macro.toc.TocBlockFilter

All Implemented Interfaces:

BlockFilter

public class TocBlockFilter
extends PlainTextBlockFilter

Used to filter the HeaderBlock title to generate the toc anchor.

Since:

1.8RC2

Version:

$Id$

Constructor Summary

TocBlockFilter(Parser plainTextParser, LinkLabelGenerator linkLabelGenerator)

Method Summary

List<Block>

generateLabel(HeaderBlock headerBlock)

Methods inherited from class org.xwiki.rendering.block.PlainTextBlockFilter

filter

Methods inherited from class java.lang.Object

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

Constructor Detail

TocBlockFilter

public TocBlockFilter(Parser plainTextParser,
                      LinkLabelGenerator linkLabelGenerator)

Parameters:

plainTextParser - a plain text parser used to transform link labels into plain text

linkLabelGenerator - generate link label.

Since:

2.0M3

Method Detail

generateLabel

public List<Block> generateLabel(HeaderBlock headerBlock)

Parameters:

headerBlock - the section title.

Returns:

the filtered label to use in toc anchor link.