com.ecyrd.jspwiki.plugin
Class Note

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

public class Note
extends Object
implements WikiPlugin

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 http://www.456bereastreet.com/archive/200412/the_alt_and_title_attributes/ for discussion on alt and title attributes.

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

Parameters :

Author:
John Volkar, Scott Hulbert

Field Summary
static String DEFAULT_NOTE_IMAGE
          The default name for the note.
static String PROP_NOTE_IMAGE
          Property name for setting the image for the note.
 
Fields inherited from interface com.ecyrd.jspwiki.plugin.WikiPlugin
CORE_PLUGINS_RESOURCEBUNDLE
 
Constructor Summary
Note()
           
 
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

PROP_NOTE_IMAGE

public static final String PROP_NOTE_IMAGE
Property name for setting the image for the note. Value is "notePlugin.imageName".

See Also:
Constant Field Values

DEFAULT_NOTE_IMAGE

public static final String DEFAULT_NOTE_IMAGE
The default name for the note. Value is "note.png".

See Also:
Constant Field Values
Constructor Detail

Note

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