org.apache.wiki.forms
Class FormInput

java.lang.Object
  org.apache.wiki.forms.FormElement
      org.apache.wiki.forms.FormInput

All Implemented Interfaces:

WikiPlugin

public class FormInput
extends FormElement

Creates a simple input text field.

Field Summary

static String	PARAM_SIZE Parameter name for setting the size of the input field.
static String	PARAM_TYPE Parameter name for setting the type.

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

CORE_PLUGINS_RESOURCEBUNDLE

Constructor Summary

FormInput()

Method Summary

String

execute(WikiContext ctx, Map<String,String> params) Generates a dynamic form element on the WikiPage.

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

Field Detail

PARAM_TYPE

public static final String PARAM_TYPE

Parameter name for setting the type. Value is "type".

See Also:

Constant Field Values

PARAM_SIZE

public static final String PARAM_SIZE

Parameter name for setting the size of the input field. Value is "size".

See Also:

Constant Field Values

Constructor Detail

FormInput

public FormInput()

Method Detail

execute

public String execute(WikiContext ctx,
                      Map<String,String> params)
               throws PluginException

Generates a dynamic form element on the WikiPage. 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.