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


Field Summary
static int MAX_DEPTH
           
static int MIN_DEPTH
           
static String PARAM_DEPTH
           
static String PARAM_EXCLUDE
           
static String PARAM_FORMAT
           
static String PARAM_INCLUDE
           
static String PARAM_ROOT
           
static String PARAM_TYPE
           
 
Constructor Summary
ReferredPagesPlugin()
           
 
Method Summary
 String execute(WikiContext context, Map params)
          This is the main entry point for any plugin.
protected  void getReferredPages(WikiContext context, String pagename, int depth)
          Retrieves a list of all referred pages.
protected  void handleLinks(WikiContext context, Collection links, int depth, String pagename)
           
 
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
See Also:
Constant Field Values

PARAM_DEPTH

public static final String PARAM_DEPTH
See Also:
Constant Field Values

PARAM_TYPE

public static final String PARAM_TYPE
See Also:
Constant Field Values

PARAM_INCLUDE

public static final String PARAM_INCLUDE
See Also:
Constant Field Values

PARAM_EXCLUDE

public static final String PARAM_EXCLUDE
See Also:
Constant Field Values

PARAM_FORMAT

public static final String PARAM_FORMAT
See Also:
Constant Field Values

MIN_DEPTH

public static final int MIN_DEPTH
See Also:
Constant Field Values

MAX_DEPTH

public static final int MAX_DEPTH
See Also:
Constant Field Values
Constructor Detail

ReferredPagesPlugin

public ReferredPagesPlugin()
Method Detail

execute

public String execute(WikiContext context,
                      Map params)
               throws PluginException
Description copied from interface: WikiPlugin
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.

getReferredPages

protected void getReferredPages(WikiContext context,
                                String pagename,
                                int depth)
Retrieves a list of all referred pages. Is called recursively depending on the depth parameter


handleLinks

protected void handleLinks(WikiContext context,
                           Collection links,
                           int depth,
                           String pagename)