Class Note

All Implemented Interfaces:

public class Note
extends java.lang.Object
implements Plugin
Outputs an image with the supplied text as the title which is shown as a tooltip by most browsers. This is intended for short one line comments.

See for discussion on alt and title attributes.

Adaption of the CommentPlugin written by Scott Hulbert, cleaned up and generalized, but basically his concept.

Parameters :

  • _cmdline - the commentText
  • Field Summary

    Modifier and Type Field Description
    static java.lang.String DEFAULT_NOTE_IMAGE
    The default name for the note.
    static java.lang.String PROP_NOTE_IMAGE
    Property name for setting the image for the note.

    Fields inherited from interface

  • Constructor Summary

    Constructor Description
  • Method Summary

    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
  • Field Details

  • Constructor Details

    • Note

      public Note()
  • Method Details

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