Class ReferredPagesPlugin

  • All Implemented Interfaces:

    public class ReferredPagesPlugin
    extends java.lang.Object
    implements Plugin
    Displays the pages referring to the current page.


    • name - Name of the root page. Default name of calling page
    • type - local|externalattachment
    • depth - How many levels of pages to be parsed.
    • include - Include only these pages. (eg. include='UC.*|BP.*' )
    • exclude - Exclude with this pattern. (eg. exclude='LeftMenu' )
    • format - full|compact, FULL now expands all levels correctly
    • Field Summary

      Modifier and Type Field Description
      static int MAX_DEPTH
      The maximum depth.
      static int MIN_DEPTH
      The minimum depth.
      static java.lang.String PARAM_COLUMNS
      Parameter name for setting the number of columns that will be displayed by the plugin.
      static java.lang.String PARAM_DEPTH
      The parameter name for the depth.
      static java.lang.String PARAM_EXCLUDE
      The parameter name for the excluded pages.
      static java.lang.String PARAM_FORMAT
      The parameter name for the format.
      static java.lang.String PARAM_INCLUDE
      The parameter name for the included pages.
      static java.lang.String PARAM_ROOT
      The parameter name for the root page to start from.
      static java.lang.String PARAM_TYPE
      The parameter name for the type of the references.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String execute​(Context context, java.util.Map<java.lang.String,​java.lang.String> 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
    • Method Detail

      • execute

        public java.lang.String execute​(Context context,
                                        java.util.Map<java.lang.String,​java.lang.String> 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 Plugin
        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.
        HTML, ready to be included into the rendered page.
        PluginException - In case anything goes wrong.