com.zentense.step2.util
Class Form

java.lang.Object
  com.zentense.step2.util.Form

public class Form
extends java.lang.Object

This bean generates the HTML needed to maintain the state of forms

Version:

$Revision: 1.11 $

Author:

Jose R. Cabanes (aka Kurt)

Nested Class Summary

class	Form.CheckboxField
class	Form.Field
class	Form.FileField
class	Form.PasswordField
class	Form.RadioField
class	Form.SelectField
class	Form.TextAreaField
class	Form.TextField

Constructor Summary

Form(java.lang.String formName, java.lang.String action)

Method Summary

void	addCheckboxField(java.lang.String name, java.lang.String value) Writes a checkbox
void	addField(java.lang.String name, Form.Field field)
void	addFileField(java.lang.String name) Writes a file input field.
void	addFileField(java.lang.String name, java.lang.String accept) Writes a file input field.
void	addFileField(java.lang.String name, java.lang.String accept, java.lang.String servername) Writes a file input field.
void	addHiddenField(java.lang.String name, java.lang.String value) Writes a hidden field
void	addPasswordField(java.lang.String name, int size, int maxlength) Writes a password field
void	addRadioField(java.lang.String name, java.lang.String value) Writes a radio button
Form.SelectField	addSelectField(java.lang.String name)
Form.SelectField	addSelectField(java.lang.String name, View options) Writes a select form field
Form.SelectField	addSelectField(java.lang.String name, View options, java.lang.String colValue, java.lang.String colText)
void	addTextAreaField(java.lang.String name, int cols, int rows, java.lang.String wrap) Writes a text area field
void	addTextField(java.lang.String name) Writes an input text field, with size 20 and no maximum length.
void	addTextField(java.lang.String name, int size, int maxlength) Writes a text field
void	clear()
java.lang.String	close() Closes a tag
java.lang.String	get(java.lang.String name)
java.lang.String	getAction()
Form.Field	getField(java.lang.String name)
java.lang.String	getName()
Form.SelectField	getSelectField(java.lang.String name)
java.lang.String	multipart() Writes a multipart form tag
java.lang.String	multipart(java.lang.String xtra)
java.lang.String	open(java.lang.String method) Writes a form tag, posted with POST method
java.lang.String	open(java.lang.String method, java.lang.String xtra) Writes a form tag
void	populate(HttpServletRequest request) Populates field values from request
void	populatePartial(View v) Populates field values from view.
java.lang.String	renderField(java.lang.String name)
java.lang.String	renderField(java.lang.String name, java.lang.String xtra)
java.lang.String	renderHidden(java.lang.String name, java.lang.String value)
java.lang.String	renderOption(java.lang.String name, java.lang.String value, java.lang.String text)
java.lang.String	renderRadio(java.lang.String name, java.lang.String value, java.lang.String xtra)
java.lang.String	renderSubmit(java.lang.String value) Writes a submit button
java.lang.String	renderSubmit(java.lang.String name, java.lang.String value) Writes a submit button
void	set(java.lang.String name, java.lang.Object value)
void	setAction(java.lang.String action)
void	setDefault(java.lang.String field, java.lang.String deflt)
java.lang.String	toXML(int indent) Returns a XML representation of the state of this form
void	useCheck(Check check, java.lang.String onerror)

Methods inherited from class java.lang.Object

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

Constructor Detail

Form

public Form(java.lang.String formName,
            java.lang.String action)

Method Detail

getName

public final java.lang.String getName()

set

public final void set(java.lang.String name,
                      java.lang.Object value)

get

public final java.lang.String get(java.lang.String name)

getField

public final Form.Field getField(java.lang.String name)

getSelectField

public final Form.SelectField getSelectField(java.lang.String name)

populate

public final void populate(HttpServletRequest request)

Populates field values from request

Parameters:

request - Servlet request

populatePartial

public final void populatePartial(View v)

Populates field values from view. This is the same as populate(View) but fields whose names are not view columns are left unchanged.

Parameters:

vm - Runtime request object

toXML

public final java.lang.String toXML(int indent)
                             throws java.lang.Exception

Returns a XML representation of the state of this form

Throws:

java.lang.Exception

open

public final java.lang.String open(java.lang.String method)

Writes a form tag, posted with POST method

Parameters:

name - Name of the form

action - URL to invoke when form is posted

Returns:

The form tag

open

public final java.lang.String open(java.lang.String method,
                                   java.lang.String xtra)

Writes a form tag

Parameters:

name - Name of the form

action - URL to invoke when form is posted

method - GET or POST

xtra - Extra parameters

Returns:

The form tag

close

public final java.lang.String close()

Closes a tag

multipart

public final java.lang.String multipart()

Writes a multipart form tag

Parameters:

name - Name of the form

action - URL to invoke when form is posted

Returns:

The form tag

multipart

public final java.lang.String multipart(java.lang.String xtra)

addField

public final void addField(java.lang.String name,
                           Form.Field field)

addTextField

public final void addTextField(java.lang.String name)

Writes an input text field, with size 20 and no maximum length.

Parameters:

name - Name of the field

addTextField

public final void addTextField(java.lang.String name,
                               int size,
                               int maxlength)

Writes a text field

Parameters:

name - Name of the field

size - Graphical size of the field

maxlength - Maximum length of this field

addPasswordField

public final void addPasswordField(java.lang.String name,
                                   int size,
                                   int maxlength)

Writes a password field

Parameters:

name - Name of the field

size - Graphical size of the field

maxlength - Maximum length of this field

addHiddenField

public final void addHiddenField(java.lang.String name,
                                 java.lang.String value)

Writes a hidden field

Parameters:

name - Name of the field

value - Value of the field

addTextAreaField

public final void addTextAreaField(java.lang.String name,
                                   int cols,
                                   int rows,
                                   java.lang.String wrap)

Writes a text area field

Parameters:

name - Name of the text area

cols - Colums for this text area

rows - Rows for this text area

wrap - What kind of wrapping (off, virtual, etc)

addSelectField

public final Form.SelectField addSelectField(java.lang.String name,
                                             View options)
                                      throws java.lang.Exception

Writes a select form field

Parameters:

name - Field name

options - View with options

Throws:

java.lang.Exception

addSelectField

public final Form.SelectField addSelectField(java.lang.String name)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

addSelectField

public final Form.SelectField addSelectField(java.lang.String name,
                                             View options,
                                             java.lang.String colValue,
                                             java.lang.String colText)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

addCheckboxField

public final void addCheckboxField(java.lang.String name,
                                   java.lang.String value)

Writes a checkbox

Parameters:

name - Name of the checkbox

value - Value for this checkbox

addRadioField

public final void addRadioField(java.lang.String name,
                                java.lang.String value)

Writes a radio button

Parameters:

name - Name of the radio

value - Value for this radio

setDefault

public final void setDefault(java.lang.String field,
                             java.lang.String deflt)

renderSubmit

public final java.lang.String renderSubmit(java.lang.String value)

Writes a submit button

Parameters:

value - Text shown in the button

renderSubmit

public final java.lang.String renderSubmit(java.lang.String name,
                                           java.lang.String value)

Writes a submit button

Parameters:

name - Button name

value - Text shown in the button

addFileField

public final void addFileField(java.lang.String name)

Writes a file input field. File fields only work for a multipart form. Files are left on application current working directory.

Parameters:

name - Name of this field

addFileField

public final void addFileField(java.lang.String name,
                               java.lang.String accept)

Writes a file input field. File fields only work for a multipart form. Files are left on application current working directory.

Parameters:

name - Name of this field

accept - MIME type of files accepted in this field

addFileField

public final void addFileField(java.lang.String name,
                               java.lang.String accept,
                               java.lang.String servername)

Writes a file input field. File fields only work for a multipart form. Files are left on application current working directory.

Parameters:

name - Name of this field

servername - Name (at server) for uploaded file

renderField

public final java.lang.String renderField(java.lang.String name)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

renderField

public final java.lang.String renderField(java.lang.String name,
                                          java.lang.String xtra)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

renderHidden

public final java.lang.String renderHidden(java.lang.String name,
                                           java.lang.String value)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

renderRadio

public final java.lang.String renderRadio(java.lang.String name,
                                          java.lang.String value,
                                          java.lang.String xtra)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

renderOption

public final java.lang.String renderOption(java.lang.String name,
                                           java.lang.String value,
                                           java.lang.String text)

useCheck

public final void useCheck(Check check,
                           java.lang.String onerror)

clear

public void clear()
           throws java.lang.Exception

Throws:

java.lang.Exception

setAction

public void setAction(java.lang.String action)

getAction

public java.lang.String getAction()