Class FormList

Represents a list of forms.

Property Summary 

PropertyDescription
selectManyItems: List (read-only)returns the selected list items if the list is configured to support selection of items.
selectManyObjects: List (read-only)Returns a list of all selected objects if the list is configured to support the selection of items.
selectOneItem: FormListItem (read-only)Returns the default list item if the list is configured to support the selection of a default item.
selectOneObject: Object (read-only)Returns the selected object if the list is configured to support the selection of a default item.

Constructor Summary 

This class does not have a constructor, so you cannot create it directly.

Method Summary 

MethodDescription
getSelectManyItems()returns the selected list items if the list is configured to support selection of items.
getSelectManyObjects()Returns a list of all selected objects if the list is configured to support the selection of items.
getSelectOneItem()Returns the default list item if the list is configured to support the selection of a default item.
getSelectOneObject()Returns the selected object if the list is configured to support the selection of a default item.

Methods inherited from class FormGroup 

accept, copyFrom, copyTo, getChildCount, getError, getObject, getSubmittedAction, getTriggeredAction

Methods inherited from class FormElement 

clearFormElement, getDynamicHtmlName, getFormId, getHtmlName, getParent, getValidationResult, invalidateFormElement, invalidateFormElement, isValid

Methods inherited from class Object 

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Property Details 

selectManyItems 

selectManyItems: List (read-only)

returns the selected list items if the list is configured to support selection of items.


selectManyObjects 

selectManyObjects: List (read-only)

Returns a list of all selected objects if the list is configured to support the selection of items. The objects are the objects that were bound to each row.


selectOneItem 

selectOneItem: FormListItem (read-only)

Returns the default list item if the list is configured to support the selection of a default item.


selectOneObject 

selectOneObject: Object (read-only)

Returns the selected object if the list is configured to support the selection of a default item. The object is the object bound to the item.


Method Details 

getSelectManyItems() 

getSelectManyItems(): List

returns the selected list items if the list is configured to support selection of items.

Returns:

  • a List of FormListItem elements or null if no selection was configured for the form.

getSelectManyObjects() 

getSelectManyObjects(): List

Returns a list of all selected objects if the list is configured to support the selection of items. The objects are the objects that were bound to each row.

Returns:

  • a List of objects or null if no selection was configured for the form.

getSelectOneItem() 

getSelectOneItem(): FormListItem

Returns the default list item if the list is configured to support the selection of a default item.

Returns:

  • the default FormListItem elements or null if no selection was configured

getSelectOneObject() 

getSelectOneObject(): Object

Returns the selected object if the list is configured to support the selection of a default item. The object is the object bound to the item.

Returns:

  • the selected object.