Package org.apache.wiki.plugin
Class TableOfContents
java.lang.Object
org.apache.wiki.plugin.TableOfContents
- All Implemented Interfaces:
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
FieldsModifier and TypeFieldDescriptionstatic final String
Parameter name for setting whether the headings should be numbered.static final String
Parameter name for setting what the prefix for the heading is.static final String
Parameter name for setting where the numbering should start.static final String
Parameter name for setting the title.Fields inherited from interface org.apache.wiki.api.plugin.Plugin
CORE_PLUGINS_RESOURCEBUNDLE
-
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
PARAM_TITLE
Parameter name for setting the title.- See Also:
-
PARAM_NUMBERED
Parameter name for setting whether the headings should be numbered.- See Also:
-
PARAM_START
Parameter name for setting where the numbering should start.- See Also:
-
PARAM_PREFIX
Parameter name for setting what the prefix for the heading is.- See Also:
-
-
Constructor Details
-
TableOfContents
public TableOfContents()
-
-
Method Details
-
headingAdded
Is called whenever a heading is encountered in the stream.- Specified by:
headingAdded
in interfaceHeadingListener
- Parameters:
context
- The WikiContexthd
- The heading which was just encountered.
-
execute
- Specified by:
execute
in interfacePlugin
- Throws:
PluginException
-