Package org.apache.wiki.plugin
Class IndexPlugin
java.lang.Object
org.apache.wiki.plugin.AbstractReferralPlugin
org.apache.wiki.plugin.IndexPlugin
- All Implemented Interfaces:
Plugin
A Plugin that creates an index of pages according to a certain pattern.
The default is to include all pages.
The default is to include all pages.
This is a rewrite of the earlier JSPWiki IndexPlugin using JDOM2. 8
Parameters (from AbstractReferralPlugin):
- include - A regexp pattern for marking which pages should be included.
- exclude - A regexp pattern for marking which pages should be excluded.
- Author:
- Ichiro Furusato
-
Field Summary
Fields inherited from class org.apache.wiki.plugin.AbstractReferralPlugin
ALL_ITEMS, 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_COLUMNS, 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_LOCALEFields inherited from interface org.apache.wiki.api.plugin.Plugin
CORE_PLUGINS_RESOURCEBUNDLE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThis is the main entry point for any plugin.getDisplayName(Locale locale) Provides the ability for a plugin to provide it's display name that is visible via the [{}] autocomplete/suggestion mechanism within the editor.Example: Calls My Custom pluginMethods inherited from class org.apache.wiki.plugin.AbstractReferralPlugin
applyColumnsStyle, filterAndSortCollection, filterCollection, filterWikiPageCollection, initialize, makeHTML, wikitizeCollectionMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.wiki.api.plugin.Plugin
getSnipExample
-
Constructor Details
-
IndexPlugin
public IndexPlugin()
-
-
Method Details
-
getDisplayName
Description copied from interface:PluginProvides the ability for a plugin to provide it's display name that is visible via the [{}] autocomplete/suggestion mechanism within the editor.Example: Calls My Custom plugin- Specified by:
getDisplayNamein interfacePlugin- Returns:
- String
-
execute
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:
executein interfacePlugin- 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.
-