|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.wiki.plugin.Note
public class Note
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 :
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 org.apache.wiki.api.plugin.WikiPlugin |
---|
CORE_PLUGINS_RESOURCEBUNDLE |
Constructor Summary | |
---|---|
Note()
|
Method Summary | |
---|---|
String |
execute(WikiContext context,
Map<String,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 Detail |
---|
public static final String PROP_NOTE_IMAGE
public static final String DEFAULT_NOTE_IMAGE
Constructor Detail |
---|
public Note()
Method Detail |
---|
public String execute(WikiContext context, Map<String,String> params) throws PluginException
Note that it is preferred that the plugin returns XHTML-compliant HTML (i.e. close all tags, use <br /> instead of <br>, etc.
execute
in interface WikiPlugin
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.
PluginException
- In case anything goes wrong.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |