Package org.teamapps.ux.component.form

Class AbstractForm<RECORD>

java.lang.Object

org.teamapps.ux.component.AbstractComponent

org.teamapps.ux.component.form.AbstractForm<RECORD>

All Implemented Interfaces:

ClientObject, Component

Direct Known Subclasses:

GenericForm, ResponsiveForm

public abstract class AbstractForm<RECORD>
extends AbstractComponent
implements Component

Field Summary

Fields

Modifier and Type	Field	Description
final Event<FieldChangeEventData>	onFieldValueChanged

Fields inherited from class org.teamapps.ux.component.AbstractComponent

DELETED_ATTRIBUTE, onRendered

Constructor Summary

Constructors

Constructor	Description
AbstractForm()

Method Summary

Modifier and Type	Method	Description
protected void	addComponent(Component component)
protected void	addField(String propertyName, AbstractField<?> field)
void	addMultiFieldValidator(MultiFieldValidator multiFieldValidator)
void	applyFieldValuesToRecord(RECORD record)
void	applyRecordValuesToFields(RECORD record)
void	clearAllFields()
UiComponent	createUiComponent()
List<Component>	getAllChildren()
<V> AbstractField<V>	getFieldByPropertyName(String propertyName)
List<AbstractField<?>>	getFields()
Map<String,AbstractField<?>>	getFieldsMap()
Object	getFieldValue(String fieldName)	convenience method for field.getValue()
abstract List<FormLayoutPolicy>	getLayoutPolicies()
PropertyInjector<RECORD>	getPropertyInjector()
PropertyProvider<RECORD>	getPropertyProvider()
void	handleUiEvent(UiEvent event)
boolean	isChangedByClient()	Checks whether any of the form fields have been mutated by the client.
void	setFieldValue(String fieldName, Object value)	convenience method for field.setValue(...).
void	setPropertyExtractor(PropertyExtractor<RECORD> propertyExtractor)
void	setPropertyInjector(PropertyInjector<RECORD> propertyInjector)
void	setPropertyProvider(PropertyProvider<RECORD> propertyProvider)
void	setSectionCollapsed(String sectionId, boolean collapsed)
protected void	updateLayoutPolicies()
FieldMessage.Severity	validate()

Methods inherited from class org.teamapps.ux.component.AbstractComponent

createUiReference, getDebuggingId, getId, getParent, getSessionContext, isRendered, isVisible, mapAbstractUiComponentProperties, queueCommandIfRendered, render, reRenderIfRendered, setAttribute, setCssStyle, setDebuggingId, setParent, setVisible, toggleCssClass, toString, unrender

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.teamapps.ux.component.ClientObject

createUiReference, getId, handleUiQuery, isRendered, render, unrender

Methods inherited from interface org.teamapps.ux.component.Component

getParent, isVisible, setAriaLabel, setAttribute, setAttribute, setCssStyle, setCssStyle, setHtmlTitle, setMargin, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setParent, setShadow, setVisible, toggleCssClass, toggleCssClass

Field Details

onFieldValueChanged

public final Event<FieldChangeEventData> onFieldValueChanged

Constructor Details

AbstractForm

public AbstractForm()

Method Details

clearAllFields

public void clearAllFields()

setFieldValue

public void setFieldValue(String fieldName,
 Object value)

convenience method for field.setValue(...). Caution: this method is NOT typesafe! You can set any value type, but this would probably cause runtime errors.

getFieldValue

public Object getFieldValue(String fieldName)

convenience method for field.getValue()

addField

protected void addField(String propertyName,
 AbstractField<?> field)

addComponent

protected void addComponent(Component component)

getLayoutPolicies

public abstract List<FormLayoutPolicy> getLayoutPolicies()

createUiComponent

public UiComponent createUiComponent()

Specified by:

createUiComponent in class AbstractComponent

updateLayoutPolicies

protected void updateLayoutPolicies()

applyRecordValuesToFields

public void applyRecordValuesToFields(RECORD record)

applyFieldValuesToRecord

public void applyFieldValuesToRecord(RECORD record)

getPropertyProvider

public PropertyProvider<RECORD> getPropertyProvider()

setPropertyProvider

public void setPropertyProvider(PropertyProvider<RECORD> propertyProvider)

setPropertyExtractor

public void setPropertyExtractor(PropertyExtractor<RECORD> propertyExtractor)

getPropertyInjector

public PropertyInjector<RECORD> getPropertyInjector()

setPropertyInjector

public void setPropertyInjector(PropertyInjector<RECORD> propertyInjector)

handleUiEvent

public void handleUiEvent(UiEvent event)

Specified by:

handleUiEvent in interface ClientObject

getFields

public List<AbstractField<?>> getFields()

getFieldsMap

public Map<String,AbstractField<?>> getFieldsMap()

getFieldByPropertyName

public <V> AbstractField<V> getFieldByPropertyName(String propertyName)

getAllChildren

public List<Component> getAllChildren()

setSectionCollapsed

public void setSectionCollapsed(String sectionId,
 boolean collapsed)

addMultiFieldValidator

public void addMultiFieldValidator(MultiFieldValidator multiFieldValidator)

validate

public FieldMessage.Severity validate()

isChangedByClient

public boolean isChangedByClient()

Checks whether any of the form fields have been mutated by the client.

Returns:

true if any of the form fields' values have been changed, false otherwise