Package org.apache.wiki.forms

Class FormClose

java.lang.Object

org.apache.wiki.forms.FormElement

org.apache.wiki.forms.FormClose

All Implemented Interfaces:

Plugin

public class FormClose
extends FormElement

Closes a WikiForm.

Field Summary

Fields inherited from class org.apache.wiki.forms.FormElement

FORM_VALUES_CARRIER, HANDLERPARAM_PREFIX, HIDE_SUCCESS, PARAM_ELEMENT, PARAM_FORM, PARAM_FORMNAMEHIDDEN, PARAM_HANDLER, PARAM_HIDEFORM, PARAM_INPUTNAME, PARAM_POPULATE, PARAM_SUBMITHANDLER, PARAM_VALUE

Fields inherited from interface org.apache.wiki.api.plugin.Plugin

CORE_PLUGINS_RESOURCEBUNDLE

Constructor Summary

Constructors

Constructor	Description
FormClose()

Method Summary

Modifier and Type	Method	Description
java.lang.String	execute(Context ctx, java.util.Map<java.lang.String,java.lang.String> params)	Builds a Form close tag.

Methods inherited from class org.apache.wiki.forms.FormElement

getFormInfo, storeFormInfo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FormClose

public FormClose()

Method Details

execute

public java.lang.String execute(Context ctx,
java.util.Map<java.lang.String,java.lang.String> params)
                         throws PluginException

Builds a Form close tag. Removes any information on the form from the WikiContext. 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.

Parameters:

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