Package org.apache.wiki.plugin

Class TableOfContents

java.lang.Object
org.apache.wiki.plugin.TableOfContents
All Implemented Interfaces:
Plugin, HeadingListener
public class TableOfContents
extends java.lang.Object
implements Plugin, HeadingListener
Provides a table of contents.

Parameters :

  • title - The title of the table of contents.
  • numbered - if true, generates automatically numbers for the headings.
  • start - If using a numbered list, sets the start number.
  • prefix - If using a numbered list, sets the prefix used for the list.
Since:
2.2

  • Field Summary

    Fields
    Modifier and Type Field Description
    static java.lang.String PARAM_NUMBERED
    Parameter name for setting whether the headings should be numbered.
    static java.lang.String PARAM_PREFIX
    Parameter name for setting what the prefix for the heading is.
    static java.lang.String PARAM_START
    Parameter name for setting where the numbering should start.
    static java.lang.String PARAM_TITLE
    Parameter name for setting the title.

    Fields inherited from interface org.apache.wiki.api.plugin.Plugin

    CORE_PLUGINS_RESOURCEBUNDLE

  • Constructor Summary

    Constructors
    Constructor Description
    TableOfContents()  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String execute​(Context context, java.util.Map<java.lang.String,​java.lang.String> params)
    This is the main entry point for any plugin.
    void headingAdded​(Context context, Heading hd)
    Is called whenever a heading is encountered in the stream.

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

  • Method Details

    • headingAdded

      public void headingAdded​(Context context, Heading hd)
      Is called whenever a heading is encountered in the stream.
      Specified by:
      headingAdded in interface HeadingListener
      Parameters:
      context - The WikiContext
      hd - The heading which was just encountered.

    • execute

      public java.lang.String execute​(Context context, java.util.Map<java.lang.String,​java.lang.String> params) throws PluginException
      This is the main entry point for any plugin. The parameters are parsed, and a special parameter called "_body" signifies the name of the plugin body, i.e. the part of the plugin that is not a parameter of the form "key=value". This has been separated using an empty line.

      Note that it is preferred that the plugin returns XHTML-compliant HTML (i.e. close all tags, use <br /> instead of <br>, etc.

      Specified by:
      execute in interface Plugin
      Parameters:
      context - The current WikiContext.
      params - A Map which contains key-value pairs. Any parameter that the user has specified on the wiki page will contain String-String parameters, but it is possible that at some future date, JSPWiki will give you other things that are not Strings.
      Returns:
      HTML, ready to be included into the rendered page.
      Throws:
      PluginException - In case anything goes wrong.