Package ch.tocco.nice2.model.form.api.form2.components

Interface Field

All Superinterfaces:

Cloneable, Component, DataComponent

All Known Subinterfaces:

AddressField, CodeField, DocumentField, FulltextSearch, GeosearchField, HtmlField, LocationField, RangeField, RelationField, RemoteField, SelectBox

All Known Implementing Classes:

AddressFieldImpl, CodeFieldImpl, DocumentFieldImpl, FieldImpl, FulltextSearchImpl, GeosearchFieldImpl, HtmlFieldImpl, LocationFieldImpl, RangeFieldImpl, RelationFieldImpl, RemoteFieldImpl, SelectBoxImpl

public interface Field
extends DataComponent

A form field which represents a field of an entity model.

Nested Class Summary

Nested classes/interfaces inherited from interface ch.tocco.nice2.model.form.api.form2.components.Component

Component.Configuration

Method Summary

Modifier and Type	Method	Description
default void	accept(ComponentVisitor visitor)	Implement method (and add new method to ComponentVisitor), if during traversing the form something should happen with this specific component type
String	getAutoCompleteEndpoint()
String	getDataType()	The data type of the field (e.g.
@Nullable DefaultValueDescriptor	getDefaultValue()
String	getPath()	The path from the base entity to the field or relation.
boolean	getSimpleSearch()
AndGroupValidator	getValidator()
boolean	isParentContainerReadonly()

Methods inherited from interface ch.tocco.nice2.model.form.api.form2.components.Component

getForm, getId, getLabel, getParent, getPosition, validate

Methods inherited from interface ch.tocco.nice2.model.form.api.form2.components.DataComponent

getDefaultLabel

Method Details

getPath

String getPath()

The path from the base entity to the field or relation. The base entity is defined in the containing Form component.

getDataType

String getDataType()

The data type of the field (e.g. date, datetime, string, ...).

getDefaultValue

@Nullable
@Nullable DefaultValueDescriptor getDefaultValue()

Returns:

the default value for this form component as specified in the form xml.

getValidator

AndGroupValidator getValidator()

getAutoCompleteEndpoint

String getAutoCompleteEndpoint()

getSimpleSearch

boolean getSimpleSearch()

accept

default void accept(ComponentVisitor visitor)

Description copied from interface: Component

Implement method (and add new method to ComponentVisitor), if during traversing the form something should happen with this specific component type

Specified by:

accept in interface Component

isParentContainerReadonly

boolean isParentContainerReadonly()