com.haulmont.cuba.gui.components

Interface Field<V>

All Superinterfaces:

Component, Component.BelongToFrame, Component.Editable, Component.HasCaption, Component.HasDescription, Component.HasIcon, DatasourceComponent<V>, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasValue<V>, HasValueSource<V>, Validatable

All Known Subinterfaces:

CheckBox, CheckBoxGroup<I>, ColorPicker, CurrencyField<V>, DateField<V>, DatePicker<V>, EntityLinkField<V>, FileUploadField, ListEditor<V>, LookupField<V>, LookupPickerField<V>, MaskedField<V>, OptionsField<V,I>, OptionsGroup<V,I>, OptionsList<V,I>, PasswordField, PickerField<V>, RadioButtonGroup<I>, ResizableTextArea<V>, RichTextArea, SearchField<V>, SearchPickerField<V>, SourceCodeEditor, SuggestionField<V>, SuggestionPickerField<V>, TextArea<V>, TextField<V>, TextInputField<V>, TimeField<V>, TokenList<V>, TwinColumn<V>

public interface Field<V>
extends DatasourceComponent<V>, HasValueSource<V>, Component.HasCaption, HasValue<V>, Component.Editable, Component.BelongToFrame, Validatable, Component.HasIcon, HasContextHelp, HasHtmlCaption, HasHtmlDescription

Base interface for "fields" - components intended to display and edit value of a certain entity attribute.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Field.Validator<T> Deprecated. Use typed Consumer instead.

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasValue

HasValue.ValueChangeEvent<V>

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
void	addValidator(java.util.function.Consumer<? super V> validator) Add validator instance.
default void	addValidators(java.util.function.Consumer<? super V>... validators)
java.lang.String	getRequiredMessage()
java.util.Collection<java.util.function.Consumer<V>>	getValidators()
boolean	isRequired()
void	removeValidator(java.util.function.Consumer<V> validator)
void	setRequired(boolean required)
void	setRequiredMessage(java.lang.String msg) A message that will be displayed to user if the field is required but has null value

Methods inherited from interface com.haulmont.cuba.gui.components.DatasourceComponent

getDatasource, getMetaProperty, getMetaPropertyPath, setDatasource

Methods inherited from interface com.haulmont.cuba.gui.components.HasValue

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, removeValueChangeListener, setValue

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.data.HasValueSource

getValueSource, setValueSource

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.Validatable

isValid, isValidateOnCommit, validate

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, setCaption

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasDescription

getDescription, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Method Detail

isRequired

boolean isRequired()

Returns:

whether the field must contain a non-null value

setRequired

void setRequired(boolean required)

getRequiredMessage

java.lang.String getRequiredMessage()

setRequiredMessage

void setRequiredMessage(java.lang.String msg)

A message that will be displayed to user if the field is required but has null value

addValidator

void addValidator(java.util.function.Consumer<? super V> validator)

Add validator instance. ValidationException this exception must be thrown by the validator if the value is not valid.

removeValidator

void removeValidator(java.util.function.Consumer<V> validator)

addValidators

default void addValidators(java.util.function.Consumer<? super V>... validators)

getValidators

java.util.Collection<java.util.function.Consumer<V>> getValidators()

Returns:

unmodifiable collection with Field validators