com.ecyrd.jspwiki.plugin
Class ReferredPagesPlugin

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

public class ReferredPagesPlugin
extends Object
implements WikiPlugin

Displays the pages referring to the current page.

Parameters

Author:
Dirk Frederickx

Field Summary
static int MAX_DEPTH
          The maximum depth.
static int MIN_DEPTH
          The minimum depth.
static String PARAM_DEPTH
          The parameter name for the depth.
static String PARAM_EXCLUDE
          The parameter name for the excluded pages.
static String PARAM_FORMAT
          The parameter name for the format.
static String PARAM_INCLUDE
          The parameter name for the included pages.
static String PARAM_ROOT
          The parameter name for the root page to start from.
static String PARAM_TYPE
          The parameter name for the type of the references.
 
Fields inherited from interface com.ecyrd.jspwiki.plugin.WikiPlugin
CORE_PLUGINS_RESOURCEBUNDLE
 
Constructor Summary
ReferredPagesPlugin()
           
 
Method Summary
 String execute(WikiContext context, Map params)
          This is the main entry point for any plugin.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PARAM_ROOT

public static final String PARAM_ROOT
The parameter name for the root page to start from. Value is "page".

See Also:
Constant Field Values

PARAM_DEPTH

public static final String PARAM_DEPTH
The parameter name for the depth. Value is "depth".

See Also:
Constant Field Values

PARAM_TYPE

public static final String PARAM_TYPE
The parameter name for the type of the references. Value is "type".

See Also:
Constant Field Values

PARAM_INCLUDE

public static final String PARAM_INCLUDE
The parameter name for the included pages. Value is "include".

See Also:
Constant Field Values

PARAM_EXCLUDE

public static final String PARAM_EXCLUDE
The parameter name for the excluded pages. Value is "exclude".

See Also:
Constant Field Values

PARAM_FORMAT

public static final String PARAM_FORMAT
The parameter name for the format. Value is "format".

See Also:
Constant Field Values

MIN_DEPTH

public static final int MIN_DEPTH
The minimum depth. Value is 1.

See Also:
Constant Field Values

MAX_DEPTH

public static final int MAX_DEPTH
The maximum depth. Value is 8.

See Also:
Constant Field Values
Constructor Detail

ReferredPagesPlugin

public ReferredPagesPlugin()
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.