com.swfit.core.xhtml
Class XHTMLFormTools

java.lang.Object
  |
  +--com.swfit.core.xhtml.XHTMLFormTools

public final class XHTMLFormTools

extends java.lang.Object

A collection of methods to render the most common form elements, with some javascript twists to fire off the form when the right changes are done.

Since:

SWFIT1.0

Version:

$Revision: 1.1 $ $Date: 2003/02/02 20:47:25 $

Author:

Olaf Havnes

Field Summary

static java.lang.String	DEFAULT_FORM_NAME Some common Javascript commands
static int	DEFAULT_METHOD Set the form method from a constant
static java.lang.String	DEFAULT_SUBMIT_NAME
static java.lang.String	DEFAULT_SUBMIT_VALUE
static java.lang.String	FORM_BACK_ACTION Some common Javascript commands
static java.lang.String	FORM_ERROR_ACTION Some common Javascript commands
static int	GET_METHOD Set the form method from a constant
static java.lang.String[]	METHODS
static int	POST_METHOD Set the form method from a constant
static java.lang.String	SUBMIT_FORM_ON_CHANGE Some common Javascript commands

Method Summary

static java.lang.String	alertJS(java.lang.String msg)
static java.lang.StringBuffer	checkBoxes(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String[] values) Render an array of checkboxes
static java.lang.StringBuffer	checkBoxes(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String[] values, java.lang.String[] texts, java.lang.String style, boolean[] selected, boolean readonly, boolean breaks)
static java.lang.StringBuffer	checkBoxes(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String[] values, java.lang.String[] texts, java.lang.String style, int[] selected_values)
static java.lang.StringBuffer	checkBoxes(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String[] values, java.lang.String[] texts, java.lang.String style, java.lang.String[] selected_values)
static java.lang.StringBuffer	fileField(java.lang.StringBuffer str_b, java.lang.String name) Render a file field from various inputs
static java.lang.StringBuffer	fileField(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String style, boolean readonly)
static java.lang.StringBuffer	formEnd(java.lang.StringBuffer str_b, boolean wrapped) End the form
static java.lang.String	formStart(java.lang.String action) This method differs from the others in that it must run after all other fields has been rendered, since we need to know whether or not the form contains a file field.
static java.lang.String	formStart(java.lang.String name, java.lang.String action)
static java.lang.String	formStart(java.lang.String name, java.lang.String action, boolean file_field)
static java.lang.String	formStart(java.lang.String name, java.lang.String action, boolean file_field, int method, boolean wrapped) NB XHTML 1.0 Strict requires a <div> or <p> or some such element wrapped around the contents of a form - unledd the form is wrapped around a table, with the fields inside table cells.
static java.lang.StringBuffer	formToolTest(java.lang.StringBuffer str_b) Test the fields with random values
static java.lang.StringBuffer	hiddenField(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String value) Render a hidden field
static java.lang.StringBuffer	insertFormStart(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String action, boolean file_field, int method, boolean wrapped)
static java.lang.String	linkJS(java.lang.String command)
static java.lang.String	methodType(int method)
static java.lang.StringBuffer	multiList(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String[] values, java.lang.String[] texts, java.lang.String style, int[] selected_values)
static java.lang.StringBuffer	multiList(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String[] values, java.lang.String[] texts, java.lang.String explainer, java.lang.String style, boolean[] selected, boolean readonly, int size)
static java.lang.StringBuffer	optionList(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String[] values, java.lang.String[] texts, java.lang.String explainer, java.lang.String style, boolean[] selected, boolean readonly, boolean submittor)
static java.lang.StringBuffer	optionList(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String[] values, java.lang.String[] texts, java.lang.String explainer, java.lang.String style, int selected_value)
static java.lang.StringBuffer	optionList(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String[] values, java.lang.String style, int selected_value) Render an option list
static java.lang.StringBuffer	passwordField(java.lang.StringBuffer str_b, java.lang.String name) Render a password field from various inputs
static java.lang.StringBuffer	passwordField(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String value)
static java.lang.StringBuffer	passwordField(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String value, java.lang.String style)
static java.lang.StringBuffer	passwordField(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String value, java.lang.String style, boolean readonly)
static java.lang.StringBuffer	plainText(java.lang.StringBuffer str_b, java.lang.String value) A quasi field for inserting plain text into a form list.
static java.lang.StringBuffer	radioButtons(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String[] values) Render an array of radio buttons
static java.lang.StringBuffer	radioButtons(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String[] values, java.lang.String[] texts, java.lang.String style, boolean[] selected, boolean readonly, boolean breaks)
static java.lang.StringBuffer	radioButtons(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String[] values, java.lang.String[] texts, java.lang.String style, int selected_value)
static java.lang.StringBuffer	radioButtons(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String[] values, java.lang.String[] texts, java.lang.String style, java.lang.String selected_value)
static java.lang.StringBuffer	submitField(java.lang.StringBuffer str_b) Render a submit field from various inputs
static java.lang.StringBuffer	submitField(java.lang.StringBuffer str_b, java.lang.String name)
static java.lang.StringBuffer	submitField(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String value)
static java.lang.StringBuffer	submitField(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String value, java.lang.String style)
static java.lang.StringBuffer	submitField(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String value, java.lang.String style, boolean readonly)
static java.lang.StringBuffer	textArea(java.lang.StringBuffer str_b, java.lang.String name)
static java.lang.StringBuffer	textArea(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String value)
static java.lang.StringBuffer	textArea(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String value, java.lang.String style)
static java.lang.StringBuffer	textArea(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String value, java.lang.String style, boolean readonly)
static java.lang.StringBuffer	textArea(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String value, java.lang.String style, int cols, int rows, boolean readonly)
static java.lang.StringBuffer	textField(java.lang.StringBuffer str_b, java.lang.String name) Render a text field from various inputs
static java.lang.StringBuffer	textField(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String value)
static java.lang.StringBuffer	textField(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String value, java.lang.String style)
static java.lang.StringBuffer	textField(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String value, java.lang.String style, boolean readonly)

Methods inherited from class java.lang.Object

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

Field Detail

POST_METHOD

public static final int POST_METHOD

Set the form method from a constant

GET_METHOD

public static final int GET_METHOD

Set the form method from a constant

DEFAULT_METHOD

public static final int DEFAULT_METHOD

Set the form method from a constant

METHODS

public static final java.lang.String[] METHODS

DEFAULT_FORM_NAME

public static final java.lang.String DEFAULT_FORM_NAME

Some common Javascript commands

SUBMIT_FORM_ON_CHANGE

public static final java.lang.String SUBMIT_FORM_ON_CHANGE

Some common Javascript commands

FORM_BACK_ACTION

public static final java.lang.String FORM_BACK_ACTION

Some common Javascript commands

FORM_ERROR_ACTION

public static final java.lang.String FORM_ERROR_ACTION

Some common Javascript commands

DEFAULT_SUBMIT_NAME

public static final java.lang.String DEFAULT_SUBMIT_NAME

DEFAULT_SUBMIT_VALUE

public static final java.lang.String DEFAULT_SUBMIT_VALUE

Method Detail

methodType

public static final java.lang.String methodType(int method)

alertJS

public static final java.lang.String alertJS(java.lang.String msg)

linkJS

public static final java.lang.String linkJS(java.lang.String command)

formStart

public static final java.lang.String formStart(java.lang.String action)

This method differs from the others in that it must run after all other fields has been rendered, since we need to know whether or not the form contains a file field. For that reason we just return a String, and leave it to the programmer to insert the results at the right place of the current StringBuffer. For convenience there is a method to insert the String at the beginning of a StringBuffer.

formStart

public static final java.lang.String formStart(java.lang.String name,
                                               java.lang.String action)

formStart

public static final java.lang.String formStart(java.lang.String name,
                                               java.lang.String action,
                                               boolean file_field)

formStart

public static final java.lang.String formStart(java.lang.String name,
                                               java.lang.String action,
                                               boolean file_field,
                                               int method,
                                               boolean wrapped)

NB XHTML 1.0 Strict requires a <div> or <p> or some such element wrapped around the contents of a form - unledd the form is wrapped around a table, with the fields inside table cells. Note the boolean variable 'wrapped'.

insertFormStart

public static final java.lang.StringBuffer insertFormStart(java.lang.StringBuffer str_b,
                                                           java.lang.String name,
                                                           java.lang.String action,
                                                           boolean file_field,
                                                           int method,
                                                           boolean wrapped)

formEnd

public static final java.lang.StringBuffer formEnd(java.lang.StringBuffer str_b,
                                                   boolean wrapped)

End the form

hiddenField

public static final java.lang.StringBuffer hiddenField(java.lang.StringBuffer str_b,
                                                       java.lang.String name,
                                                       java.lang.String value)

Render a hidden field

textField

public static final java.lang.StringBuffer textField(java.lang.StringBuffer str_b,
                                                     java.lang.String name)

Render a text field from various inputs

textField

public static final java.lang.StringBuffer textField(java.lang.StringBuffer str_b,
                                                     java.lang.String name,
                                                     java.lang.String value)

textField

public static final java.lang.StringBuffer textField(java.lang.StringBuffer str_b,
                                                     java.lang.String name,
                                                     java.lang.String value,
                                                     java.lang.String style)

textField

public static final java.lang.StringBuffer textField(java.lang.StringBuffer str_b,
                                                     java.lang.String name,
                                                     java.lang.String value,
                                                     java.lang.String style,
                                                     boolean readonly)

submitField

public static final java.lang.StringBuffer submitField(java.lang.StringBuffer str_b)

Render a submit field from various inputs

submitField

public static final java.lang.StringBuffer submitField(java.lang.StringBuffer str_b,
                                                       java.lang.String name)

submitField

public static final java.lang.StringBuffer submitField(java.lang.StringBuffer str_b,
                                                       java.lang.String name,
                                                       java.lang.String value)

submitField

public static final java.lang.StringBuffer submitField(java.lang.StringBuffer str_b,
                                                       java.lang.String name,
                                                       java.lang.String value,
                                                       java.lang.String style)

submitField

public static final java.lang.StringBuffer submitField(java.lang.StringBuffer str_b,
                                                       java.lang.String name,
                                                       java.lang.String value,
                                                       java.lang.String style,
                                                       boolean readonly)

passwordField

public static final java.lang.StringBuffer passwordField(java.lang.StringBuffer str_b,
                                                         java.lang.String name)

Render a password field from various inputs

passwordField

public static final java.lang.StringBuffer passwordField(java.lang.StringBuffer str_b,
                                                         java.lang.String name,
                                                         java.lang.String value)

passwordField

public static final java.lang.StringBuffer passwordField(java.lang.StringBuffer str_b,
                                                         java.lang.String name,
                                                         java.lang.String value,
                                                         java.lang.String style)

passwordField

public static final java.lang.StringBuffer passwordField(java.lang.StringBuffer str_b,
                                                         java.lang.String name,
                                                         java.lang.String value,
                                                         java.lang.String style,
                                                         boolean readonly)

fileField

public static final java.lang.StringBuffer fileField(java.lang.StringBuffer str_b,
                                                     java.lang.String name)

Render a file field from various inputs

fileField

public static final java.lang.StringBuffer fileField(java.lang.StringBuffer str_b,
                                                     java.lang.String name,
                                                     java.lang.String style,
                                                     boolean readonly)

textArea

public static final java.lang.StringBuffer textArea(java.lang.StringBuffer str_b,
                                                    java.lang.String name)

textArea

public static final java.lang.StringBuffer textArea(java.lang.StringBuffer str_b,
                                                    java.lang.String name,
                                                    java.lang.String value)

textArea

public static final java.lang.StringBuffer textArea(java.lang.StringBuffer str_b,
                                                    java.lang.String name,
                                                    java.lang.String value,
                                                    java.lang.String style)

textArea

public static final java.lang.StringBuffer textArea(java.lang.StringBuffer str_b,
                                                    java.lang.String name,
                                                    java.lang.String value,
                                                    java.lang.String style,
                                                    boolean readonly)

textArea

public static final java.lang.StringBuffer textArea(java.lang.StringBuffer str_b,
                                                    java.lang.String name,
                                                    java.lang.String value,
                                                    java.lang.String style,
                                                    int cols,
                                                    int rows,
                                                    boolean readonly)

plainText

public static final java.lang.StringBuffer plainText(java.lang.StringBuffer str_b,
                                                     java.lang.String value)

A quasi field for inserting plain text into a form list. Does not encode the content any further.

radioButtons

public static final java.lang.StringBuffer radioButtons(java.lang.StringBuffer str_b,
                                                        java.lang.String name,
                                                        java.lang.String[] values)

Render an array of radio buttons

radioButtons

public static final java.lang.StringBuffer radioButtons(java.lang.StringBuffer str_b,
                                                        java.lang.String name,
                                                        java.lang.String[] values,
                                                        java.lang.String[] texts,
                                                        java.lang.String style,
                                                        int selected_value)

radioButtons

public static final java.lang.StringBuffer radioButtons(java.lang.StringBuffer str_b,
                                                        java.lang.String name,
                                                        java.lang.String[] values,
                                                        java.lang.String[] texts,
                                                        java.lang.String style,
                                                        java.lang.String selected_value)

radioButtons

public static final java.lang.StringBuffer radioButtons(java.lang.StringBuffer str_b,
                                                        java.lang.String name,
                                                        java.lang.String[] values,
                                                        java.lang.String[] texts,
                                                        java.lang.String style,
                                                        boolean[] selected,
                                                        boolean readonly,
                                                        boolean breaks)

checkBoxes

public static final java.lang.StringBuffer checkBoxes(java.lang.StringBuffer str_b,
                                                      java.lang.String name,
                                                      java.lang.String[] values)

Render an array of checkboxes

checkBoxes

public static final java.lang.StringBuffer checkBoxes(java.lang.StringBuffer str_b,
                                                      java.lang.String name,
                                                      java.lang.String[] values,
                                                      java.lang.String[] texts,
                                                      java.lang.String style,
                                                      int[] selected_values)

checkBoxes

public static final java.lang.StringBuffer checkBoxes(java.lang.StringBuffer str_b,
                                                      java.lang.String name,
                                                      java.lang.String[] values,
                                                      java.lang.String[] texts,
                                                      java.lang.String style,
                                                      java.lang.String[] selected_values)

checkBoxes

public static final java.lang.StringBuffer checkBoxes(java.lang.StringBuffer str_b,
                                                      java.lang.String name,
                                                      java.lang.String[] values,
                                                      java.lang.String[] texts,
                                                      java.lang.String style,
                                                      boolean[] selected,
                                                      boolean readonly,
                                                      boolean breaks)

optionList

public static final java.lang.StringBuffer optionList(java.lang.StringBuffer str_b,
                                                      java.lang.String name,
                                                      java.lang.String[] values,
                                                      java.lang.String style,
                                                      int selected_value)

Render an option list

optionList

public static final java.lang.StringBuffer optionList(java.lang.StringBuffer str_b,
                                                      java.lang.String name,
                                                      java.lang.String[] values,
                                                      java.lang.String[] texts,
                                                      java.lang.String explainer,
                                                      java.lang.String style,
                                                      int selected_value)

optionList

public static final java.lang.StringBuffer optionList(java.lang.StringBuffer str_b,
                                                      java.lang.String name,
                                                      java.lang.String[] values,
                                                      java.lang.String[] texts,
                                                      java.lang.String explainer,
                                                      java.lang.String style,
                                                      boolean[] selected,
                                                      boolean readonly,
                                                      boolean submittor)

multiList

public static final java.lang.StringBuffer multiList(java.lang.StringBuffer str_b,
                                                     java.lang.String name,
                                                     java.lang.String[] values,
                                                     java.lang.String[] texts,
                                                     java.lang.String style,
                                                     int[] selected_values)

multiList

public static final java.lang.StringBuffer multiList(java.lang.StringBuffer str_b,
                                                     java.lang.String name,
                                                     java.lang.String[] values,
                                                     java.lang.String[] texts,
                                                     java.lang.String explainer,
                                                     java.lang.String style,
                                                     boolean[] selected,
                                                     boolean readonly,
                                                     int size)

formToolTest

public static final java.lang.StringBuffer formToolTest(java.lang.StringBuffer str_b)

Test the fields with random values