|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.wiki.plugin.TableOfContents
public class TableOfContents
Provides a table of contents.
Parameters :
Field Summary | |
---|---|
static String |
PARAM_NUMBERED
Parameter name for setting whether the headings should be numbered. |
static String |
PARAM_PREFIX
Parameter name for setting what the prefix for the heading is. |
static String |
PARAM_START
Parameter name for setting where the numbering should start. |
static String |
PARAM_TITLE
Parameter name for setting the title. |
Fields inherited from interface org.apache.wiki.api.plugin.WikiPlugin |
---|
CORE_PLUGINS_RESOURCEBUNDLE |
Constructor Summary | |
---|---|
TableOfContents()
|
Method Summary | |
---|---|
String |
execute(WikiContext context,
Map<String,String> params)
This is the main entry point for any plugin. |
void |
headingAdded(WikiContext 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 Detail |
---|
public static final String PARAM_TITLE
public static final String PARAM_NUMBERED
public static final String PARAM_START
public static final String PARAM_PREFIX
Constructor Detail |
---|
public TableOfContents()
Method Detail |
---|
public void headingAdded(WikiContext context, Heading hd)
headingAdded
in interface HeadingListener
context
- The WikiContexthd
- The heading which was just encountered.public String execute(WikiContext context, Map<String,String> params) throws PluginException
Note that it is preferred that the plugin returns XHTML-compliant HTML (i.e. close all tags, use <br /> instead of <br>, etc.
execute
in interface WikiPlugin
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.
PluginException
- In case anything goes wrong.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |