Class Form

java.lang.Object

org.patternfly.component.BaseComponent<HTMLFormElement, Form>

org.patternfly.component.form.Form

All Implemented Interfaces:

Iterable<FormGroup>, ElementAttributeMethods<HTMLFormElement, Form>, ElementClassListMethods<HTMLFormElement, Form>, ElementConsumerMethods<HTMLFormElement, Form>, ElementContainerMethods<HTMLFormElement, Form>, ElementEventMethods<HTMLFormElement, Form>, ElementIdMethods<HTMLFormElement, Form>, ElementQueryMethods<HTMLFormElement>, HTMLElementAttributeMethods<HTMLFormElement, Form>, HTMLElementDataMethods<HTMLFormElement, Form>, HTMLElementStyleMethods<HTMLFormElement, Form>, HTMLElementVisibilityMethods<HTMLFormElement, Form>, IsElement<HTMLFormElement>, TypedBuilder<HTMLFormElement, Form>, Component, HasItems<HTMLFormElement, Form, FormGroup>, Modifiers.Horizontal<HTMLFormElement, Form>

public class Form
extends BaseComponent<HTMLFormElement, Form>
implements HasItems<HTMLFormElement, Form, FormGroup>, Modifiers.Horizontal<HTMLFormElement, Form>

A form is a group of elements used to collect information from a user in a variety of contexts, including in a modal, in a wizard, or on a page. Use cases for forms include tasks reliant on user-inputted information for completion like logging in, registering, configuring settings, or completing surveys.

See Also:

• https://www.patternfly.org/components/forms/form

Method Summary

Modifier and Type	Method	Description
Form	add(FormAlert alert)
Form	add(FormGroup item)
Form	addActionGroup(FormActionGroup actionGroup)
Form	addAlert(FormAlert alert)
Form	addFieldGroup(FormFieldGroup fieldGroup)
Form	addGroup(FormGroup group)
Form	addItem(FormGroup item)
<T> Form	addItems(Iterable<T> items, Function<T, FormGroup> display)
Form	addSection(FormSection section)
void	clear()
void	clearAlerts()
boolean	contains(String identifier)
static Form	form()
boolean	isEmpty()
FormGroup	item(String identifier)
Iterator<FormGroup>	iterator()
Form	limitWidth()
Form	onAdd(BiConsumer<Form, FormGroup> onAdd)
Form	onRemove(BiConsumer<Form, FormGroup> onRemove)
void	removeItem(String identifier)
int	size()
Form	that()

Methods inherited from class org.patternfly.component.BaseComponent

componentType, element, registerComponent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.elemento.ElementAttributeMethods

aria, aria, aria, attr, attr, attr, role, role

Methods inherited from interface org.jboss.elemento.ElementClassListMethods

classList, classList, css, toggle, toggle, toggle

Methods inherited from interface org.jboss.elemento.ElementConsumerMethods

apply, run

Methods inherited from interface org.jboss.elemento.ElementContainerMethods

add, add, add, add, addAll, addAll, addAll, addAll, addAll, addAll

Methods inherited from interface org.jboss.elemento.ElementEventMethods

on, on, on

Methods inherited from interface org.jboss.elemento.ElementIdMethods

id, uniqueId

Methods inherited from interface org.jboss.elemento.ElementQueryMethods

closest, querySelector, querySelectorAll

Methods inherited from interface org.patternfly.component.HasItems

items

Methods inherited from interface org.jboss.elemento.HTMLElementAttributeMethods

title

Methods inherited from interface org.jboss.elemento.HTMLElementDataMethods

data

Methods inherited from interface org.jboss.elemento.HTMLElementStyleMethods

style, style, style, style, style, style

Methods inherited from interface org.jboss.elemento.HTMLElementVisibilityMethods

hidden

Methods inherited from interface org.jboss.elemento.IsElement

element

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.patternfly.style.Modifiers.Horizontal

horizontal, horizontal

Method Details

form

public static Form form()

addItems

public <T> Form addItems(Iterable<T> items,
 Function<T, FormGroup> display)

Specified by:

addItems in interface HasItems<HTMLFormElement, Form, FormGroup>

addItem

public Form addItem(FormGroup item)

Specified by:

addItem in interface HasItems<HTMLFormElement, Form, FormGroup>

addGroup

public Form addGroup(FormGroup group)

add

public Form add(FormGroup item)

Specified by:

add in interface HasItems<HTMLFormElement, Form, FormGroup>

addAlert

public Form addAlert(FormAlert alert)

add

public Form add(FormAlert alert)

addSection

public Form addSection(FormSection section)

addFieldGroup

public Form addFieldGroup(FormFieldGroup fieldGroup)

addActionGroup

public Form addActionGroup(FormActionGroup actionGroup)

limitWidth

public Form limitWidth()

that

public Form that()

Specified by:

that in interface TypedBuilder<HTMLFormElement, Form>

onAdd

public Form onAdd(BiConsumer<Form, FormGroup> onAdd)

Specified by:

onAdd in interface HasItems<HTMLFormElement, Form, FormGroup>

onRemove

public Form onRemove(BiConsumer<Form, FormGroup> onRemove)

Specified by:

onRemove in interface HasItems<HTMLFormElement, Form, FormGroup>

iterator

public Iterator<FormGroup> iterator()

Specified by:

iterator in interface Iterable<FormGroup>

size

public int size()

Specified by:

size in interface HasItems<HTMLFormElement, Form, FormGroup>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface HasItems<HTMLFormElement, Form, FormGroup>

contains

public boolean contains(String identifier)

Specified by:

contains in interface HasItems<HTMLFormElement, Form, FormGroup>

item

public FormGroup item(String identifier)

Specified by:

item in interface HasItems<HTMLFormElement, Form, FormGroup>

removeItem

public void removeItem(String identifier)

Specified by:

removeItem in interface HasItems<HTMLFormElement, Form, FormGroup>

clear

public void clear()

Specified by:

clear in interface HasItems<HTMLFormElement, Form, FormGroup>

clearAlerts

public void clearAlerts()