Class FormControlType

public static final FormControlType BUTTON

The form control type given to a submit button control implemented using a BUTTON element.

<button type="submit" name="FieldName" value="PredefinedValue">Send</button>

getElementName() = HTMLElementName.BUTTON
hasPredefinedValue() = true
isSubmit() = true

public static final FormControlType CHECKBOX

The form control type given to a checkbox control.

<input type="checkbox" name="FieldName" value="PredefinedValue" />

getElementName() = HTMLElementName.INPUT
hasPredefinedValue() = true
isSubmit() = false

public static final FormControlType FILE

The form control type given to a file select control.

This library considers the submission value of this type of control to be consist of only the selected file name, regardless of whether the file content would normally be included in the form data set.

To determine manually whether the file content is included in the form data set, the enctype attribute of the control's associated FORM element can be examined. Although the exact behaviour is not defined in the HTML 4.01 specification, the convention is that the content is not included unless an enctype value of "multipart/form-data" is specified.

For more information see the HTML 4.01 specification section 17.13.4 - Form content types.

<input type="file" name="FieldName" value="DefaultFileName" />

getElementName() = HTMLElementName.INPUT
hasPredefinedValue() = false
isSubmit() = false

public static final FormControlType HIDDEN

The form control type given to a hidden control.

<input type="hidden" name="FieldName" value="DefaultValue" />

getElementName() = HTMLElementName.INPUT
hasPredefinedValue() = false
isSubmit() = false

Note that hasPredefinedValue() returns false for this control type because the value of hidden fields is usually set via server or client side scripting.

public static final FormControlType IMAGE

The form control type given to a submit button control implemented using an INPUT element with attribute type="image".

See the description under the heading "image" in the HTML 4.01 specification section 17.4.1 - Form control types created with INPUT.

When a form control of type IMAGE is present in the form used to construct a FormFields instance, three separate FormField objects are created for the one control. One has the name specified in the name attribute of the INPUT element, and the other two have this name with the suffixes ".x" and ".y" appended to them to represent the additional click coordinates submitted by this control when activated using a pointing device.

This type of control is also mentioned in the HTML 4.01 specification section 13.6.2 - Server-side image maps.

<input type="image" name="FieldName" src="ImageURL" value="PredefinedValue" />

getElementName() = HTMLElementName.INPUT
hasPredefinedValue() = true
isSubmit() = true

public static final FormControlType PASSWORD

The form control type given to a text input control implemented using an INPUT element with attribute type="password".

<input type="password" name="FieldName" value="DefaultValue" />

getElementName() = HTMLElementName.INPUT
hasPredefinedValue() = false
isSubmit() = false

public static final FormControlType RADIO

The form control type given to a radio button control.

<input type="radio" name="FieldName" value="PredefinedValue" />

getElementName() = HTMLElementName.INPUT
hasPredefinedValue() = true
isSubmit() = false

public static final FormControlType SELECT_MULTIPLE

The form control type given to a menu control implemented using a SELECT element containing the attribute "multiple".

SELECT elements that do not contain the attribute "multiple" are represented by the SELECT_SINGLE form control type.

This is the only control type that can have multiple submission values within the one control. Contrast this with CHECKBOX controls, which require multiple separate controls with the same name in order to contribute multiple submission values.

The individual OPTION elements contained within a form control of this type can be obtained using the FormControl.getOptionElementIterator() method.

The most efficient way to test whether a form control type is either SELECT_MULTIPLE or SELECT_SINGLE is to test for getElementName()==HTMLElementName.SELECT.

<select name="FieldName" multiple>
  <option value="PredefinedValue1" selected>Display Text1</option>
  <option value="PredefinedValue2">Display Text2</option>
</select>

getElementName() = HTMLElementName.SELECT
hasPredefinedValue() = true
isSubmit() = false

public static final FormControlType SELECT_SINGLE

The form control type given to a menu control implemented using a SELECT element that does not contain the attribute "multiple".

SELECT elements that do contain the attribute "multiple" are represented by the SELECT_MULTIPLE form control type.

The individual OPTION elements contained within a form control of this type can be obtained using the FormControl.getOptionElementIterator() method.

The most efficient way to test whether a form control type is either SELECT_MULTIPLE or SELECT_SINGLE is to test for getElementName()==HTMLElementName.SELECT.

<select name="FieldName">
  <option value="PredefinedValue1" selected>Display Text1</option>
  <option value="PredefinedValue2">Display Text2</option>
</select>

getElementName() = HTMLElementName.SELECT
hasPredefinedValue() = true
isSubmit() = false

public static final FormControlType SUBMIT

The form control type given to a submit button control implemented using an INPUT element with attribute type="submit".

<input type="submit" name="FieldName" value="PredefinedValue" />

getElementName() = HTMLElementName.INPUT
hasPredefinedValue() = true
isSubmit() = true

public static final FormControlType TEXT

The form control type given to a text input control implemented using an INPUT element with attribute type="text".

<input type="text" name="FieldName" value="DefaultValue" />

getElementName() = HTMLElementName.INPUT
hasPredefinedValue() = false
isSubmit() = false

public static final FormControlType TEXTAREA

The form control type given to a text input control implemented using a TEXTAREA element.

<textarea name="FieldName">Default Value</textarea>

getElementName() = HTMLElementName.TEXTAREA
hasPredefinedValue() = false
isSubmit() = false

public String getElementName()

Returns the name of the Element that constitues this form control type.

Returns:

the name of the Element that constitues this form control type.

public boolean hasPredefinedValue()

Indicates whether any value submitted by this type of control is predefined in the HTML and typically not modified by the user or server/client scripts.

The word "typically" is used because the use of client side scripts can cause control types which normally have predefined values to be set by the user, which is a condition which is beyond the scope of this library to test for.

The predefined value is defined by the control's initial value.

A return value of true signifies that a form control of this type is a predefined value control.

A return value of false signifies that a form control of this type is a user value control.

Note that the HIDDEN type returns false for this method because the value of hidden fields is usually set via server or client side scripting.

Returns:

true if any value submitted by this type of control is predefined in the HTML and typically not modified by the user or server/client scripts, otherwise false.

public boolean isSubmit()

Indicates whether this control type causes the form to be submitted.

Returns true only for the SUBMIT, BUTTON, and IMAGE instances.

Returns:

true if this control type causes the form to be submitted, otherwise false.