com.haulmont.cuba.gui.components

Interface Field

All Superinterfaces:

Component, Component.BelongToFrame, Component.Editable, Component.HasCaption, Component.HasIcon, Component.HasValue, Component.Validatable, DatasourceComponent

All Known Subinterfaces:

CheckBox, ColorPicker, CurrencyField, DateField, DatePicker, EntityLinkField, FileUploadField, ListEditor, LookupField, LookupPickerField, MaskedField, OptionsField, OptionsGroup, OptionsList, PasswordField, PickerField, ResizableTextArea, RichTextArea, SearchField, SearchPickerField, SourceCodeEditor, SuggestionField, SuggestionPickerField, TextArea, TextField, TextInputField, TextInputField.CaseConversionSupported, TextInputField.CursorPositionSupported, TextInputField.EnterPressNotifier, TextInputField.MaxLengthLimited, TextInputField.TextChangeNotifier, TextInputField.TextSelectionSupported, TextInputField.TrimSupported, TimeField, TokenList, TwinColumn

All Known Implementing Classes:

DesktopAbstractField, DesktopAbstractOptionsField, DesktopAbstractTextField, DesktopAbstractUploadField, DesktopCheckBox, DesktopCurrencyField, DesktopDateField, DesktopFileUploadField, DesktopListEditor, DesktopLookupField, DesktopLookupPickerField, DesktopMaskedField, DesktopOptionsGroup, DesktopPasswordField, DesktopPickerField, DesktopResizableTextArea, DesktopSearchField, DesktopSearchPickerField, DesktopSourceCodeEditor, DesktopSuggestionField, DesktopSuggestionPickerField, DesktopTextArea, DesktopTextField, DesktopTimeField, DesktopTokenList, WebAbstractField, WebAbstractOptionsBase, WebAbstractOptionsField, WebAbstractTextArea, WebAbstractTextField, WebAbstractUploadField, WebCheckBox, WebColorPicker, WebCurrencyField, WebDateField, WebDatePicker, WebEntityLinkField, WebFileUploadField, WebListEditor, WebLookupField, WebLookupPickerField, WebMaskedField, WebOptionsGroup, WebOptionsList, WebPasswordField, WebPickerField, WebProgressBar, WebResizableTextArea, WebRichTextArea, WebSearchField, WebSearchPickerField, WebSourceCodeEditor, WebSuggestionField, WebSuggestionPickerField, WebTextArea, WebTextField, WebTimeField, WebTokenList, WebTwinColumn

public interface Field
extends DatasourceComponent, Component.HasCaption, Component.HasValue, Component.Editable, Component.BelongToFrame, Component.Validatable, Component.HasIcon

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 Field validator. Validators are invoked when Validatable#validate() is called.

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

Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper

Field Summary

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

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
void	addValidator(Field.Validator validator) Add Field.Validator instance.
java.lang.String	getRequiredMessage()
java.util.Collection<Field.Validator>	getValidators()
boolean	isRequired()
void	removeValidator(Field.Validator 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.Component.HasValue

addListener, addValueChangeListener, getValue, removeListener, removeValueChangeListener, setValue

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.Component

addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, 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.Component.HasCaption

getCaption, getDescription, setCaption, setDescription

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

isValid, isValidateOnCommit, validate

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

getIcon, setIcon

Method Detail

isRequired

boolean isRequired()

Returns:

whether the field must contain a non-null value

setRequired

void setRequired(boolean required)

setRequiredMessage

void setRequiredMessage(java.lang.String msg)

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

getRequiredMessage

java.lang.String getRequiredMessage()

addValidator

void addValidator(Field.Validator validator)

Add Field.Validator instance.

removeValidator

void removeValidator(Field.Validator validator)

getValidators

java.util.Collection<Field.Validator> getValidators()

Returns:

unmodifiable collection with Field validators