Class InsertPage

  • All Implemented Interfaces:

    public class InsertPage
    extends java.lang.Object
    implements Plugin
    Inserts page contents. Muchos thanks to Scott Hurlbert for the initial code.

    Parameters :

    • page - the name of the page to be inserted
    • style - the style to use
    • maxlength - the maximum length of the page to be inserted (page contents)
    • class - the class to use
    • section - the section of the page that has to be inserted (separated by "----"
    • default - the text to insert if the requested page does not exist
    • Field Summary

      Modifier and Type Field Description
      static java.lang.String ATTR_RECURSE
      This attribute is stashed in the WikiContext to make sure that we don't have circular references.
      static java.lang.String PARAM_CLASS
      Parameter name for setting the class.
      static java.lang.String PARAM_DEFAULT
      Parameter name for setting the default.
      static java.lang.String PARAM_MAXLENGTH
      Parameter name for setting the maxlength.
      static java.lang.String PARAM_PAGENAME
      Parameter name for setting the page.
      static java.lang.String PARAM_SECTION
      Parameter name for setting the section.
      static java.lang.String PARAM_SHOW
      Parameter name for setting the show option.
      static java.lang.String PARAM_STYLE
      Parameter name for setting the style.
    • Constructor Summary

      Constructor Description
    • 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.