com.ecyrd.jspwiki.plugin
Class IndexPlugin

java.lang.Object
  extended by com.ecyrd.jspwiki.plugin.AbstractReferralPlugin
      extended by com.ecyrd.jspwiki.plugin.IndexPlugin
All Implemented Interfaces:
WikiPlugin

public class IndexPlugin
extends AbstractReferralPlugin
implements WikiPlugin

A plugin that creates an index of pages according to a certain pattern.
The default is to include all pages.

This is a complete rewrite of the old IndexPlugin under an Apache license.

Parameters (From AbstractReferralPlugin) :


Field Summary
 
Fields inherited from class com.ecyrd.jspwiki.plugin.AbstractReferralPlugin
ALL_ITEMS, m_after, m_before, m_dateFormat, m_dateLastModified, m_engine, m_exclude, m_include, m_lastModified, m_maxwidth, m_separator, m_show, m_sorter, PARAM_AFTER, PARAM_BEFORE, PARAM_EXCLUDE, PARAM_INCLUDE, PARAM_LASTMODIFIED, PARAM_MAXWIDTH, PARAM_SEPARATOR, PARAM_SHOW, PARAM_SHOW_VALUE_COUNT, PARAM_SHOW_VALUE_PAGES, PARAM_SORTORDER, PARAM_SORTORDER_HUMAN, PARAM_SORTORDER_JAVA, PARAM_SORTORDER_LOCALE
 
Fields inherited from interface com.ecyrd.jspwiki.plugin.WikiPlugin
CORE_PLUGINS_RESOURCEBUNDLE
 
Constructor Summary
IndexPlugin()
           
 
Method Summary
 String execute(WikiContext context, Map params)
          This is the main entry point for any plugin.
 
Methods inherited from class com.ecyrd.jspwiki.plugin.AbstractReferralPlugin
filterAndSortCollection, filterCollection, initialize, makeHTML, wikitizeCollection
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IndexPlugin

public IndexPlugin()
Method Detail

execute

public String execute(WikiContext context,
                      Map 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 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.