com.ecyrd.jspwiki.plugin
Class TableOfContents
java.lang.Object
com.ecyrd.jspwiki.plugin.TableOfContents
- All Implemented Interfaces:
- HeadingListener, WikiPlugin
public class TableOfContents
- extends Object
- implements WikiPlugin, HeadingListener
Provides a table of contents.
- Since:
- 2.2
- Author:
- Janne Jalkanen
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PARAM_TITLE
public static final String PARAM_TITLE
- See Also:
- Constant Field Values
PARAM_NUMBERED
public static final String PARAM_NUMBERED
- See Also:
- Constant Field Values
PARAM_START
public static final String PARAM_START
- See Also:
- Constant Field Values
PARAM_PREFIX
public static final String PARAM_PREFIX
- See Also:
- Constant Field Values
TableOfContents
public TableOfContents()
headingAdded
public void headingAdded(WikiContext context,
Heading hd)
- Description copied from interface:
HeadingListener
- Is called whenever a heading is encountered in the stream.
- Specified by:
headingAdded
in interface HeadingListener
execute
public String execute(WikiContext context,
Map params)
throws PluginException
- Description copied from interface:
WikiPlugin
- 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 WikiPlugin
- 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.