Package com.xwiki.macros.confluence

Class ConfluenceTocZoneBlockFilter

java.lang.Object
org.xwiki.rendering.block.PlainTextBlockFilter
com.xwiki.macros.confluence.ConfluenceTocZoneBlockFilter
All Implemented Interfaces:
org.xwiki.rendering.block.BlockFilter
public class ConfluenceTocZoneBlockFilter extends org.xwiki.rendering.block.PlainTextBlockFilter
Used to filter the HeaderBlock title to generate the toc anchor.
Since:
1.25.4
Version:
$Id$

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConfluenceTocZoneBlockFilter(org.xwiki.rendering.parser.Parser plainTextParser, org.xwiki.rendering.renderer.reference.link.LinkLabelGenerator linkLabelGenerator)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    List<org.xwiki.rendering.block.Block>
    generateLabel(org.xwiki.rendering.block.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 Details

    • ConfluenceTocZoneBlockFilter

      public ConfluenceTocZoneBlockFilter(org.xwiki.rendering.parser.Parser plainTextParser, org.xwiki.rendering.renderer.reference.link.LinkLabelGenerator linkLabelGenerator)
      Parameters:
      plainTextParser - a plain text parser used to transform link labels into plain text
      linkLabelGenerator - generate link label.
      Since:
      2.0M3

  • Method Details

    • generateLabel

      public List<org.xwiki.rendering.block.Block> generateLabel(org.xwiki.rendering.block.HeaderBlock headerBlock)
      Parameters:
      headerBlock - the section title.
      Returns:
      the filtered label to use in toc anchor link.