com.ebasetech.xi.api

Interface WebFormField

All Superinterfaces:

Element, Field, java.io.Serializable, WebFormFieldOrColumn

public interface WebFormField
extends Field, WebFormFieldOrColumn

The WebFormField interface represents a form field in an interactive web form.

Individual fields can be accessed via the Fields interface.

Since:

V4.4

Method Summary

Modifier and Type	Method and Description
FieldControl	getFieldControl() Returns the first Field Control on the current page that displays this field.
FieldControl	getFieldControl(Page page) Returns the first Field Control on the specified page that displays this field.
boolean	isUrlParameter() Returns true if the field is a URL parameter field.

Methods inherited from interface com.ebasetech.xi.api.Field

getDisplayValue, getDisplayValue, getStringValue, getType, getValue, setDisplayValue, setValue

Methods inherited from interface com.ebasetech.xi.api.Element

getElementName, getElementType

Methods inherited from interface com.ebasetech.xi.api.WebFormFieldOrColumn

createCustomList, createCustomList, getDisplayLength, getDisplayType, getHelpText, getLabelText, getList, getMaxDisplayLength, isClientAccessible

Method Detail

getFieldControl

FieldControl getFieldControl()

Returns the first Field Control on the current page that displays this field.

Returns:

field control

See Also:

getFieldControl(Page)

getFieldControl

FieldControl getFieldControl(Page page)

Returns the first Field Control on the specified page that displays this field.

Returns:

field control

See Also:

getFieldControl()

isUrlParameter

boolean isUrlParameter()

Returns true if the field is a URL parameter field.

All parameter fields and their values can be determined as follows:

 var parms = {};
 for ( var field in Iterator(form.fields.iterator()) )
 {
   if (field.isUrlParameter())
   {
     parms[field.elementName] = field.value;
   }
 }
 

Since:

V5.2.1