com.vaadin.flow.component.
Interface HasValueAndElement<E extends HasValue.ValueChangeEvent<V>,V>
Type Parameters:
E
- the value change event type
V
- the value type
All Superinterfaces:
HasElement
, HasEnabled
, HasValue<E,
, Serializable
All Known Subinterfaces:
MultiSelect<C,
, SingleSelect<C,
All Known Implementing Classes:
AbstractCompositeField
, AbstractField
, AbstractNumberField
, AbstractSinglePropertyField
, BigDecimalField
, Checkbox
, CheckboxGroup
, ComboBox
, ComboBoxBase
, CustomField
, DatePicker
, DateTimePicker
, EmailField
, Input
, IntegerField
, ListBox
, ListBoxBase
, MultiSelectComboBox
, MultiSelectListBox
, NumberField
, PasswordField
, RadioButtonGroup
, RangeInput
, RichTextEditor
, Select
, TextArea
, TextField
, TextFieldBase
, TimePicker
A component that has a value.
Since:
1.0
Author:
Vaadin Ltd
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue
HasValue.ValueChangeEvent<V>, HasValue.ValueChangeListener<E extends HasValue.ValueChangeEvent<?>>
-
Method Summary
Modifier and TypeMethodDescriptiondefault boolean
Returns whether this
HasValue
is in read-only mode or not.default boolean
Checks whether the required indicator is visible.
default void
setReadOnly
(boolean readOnly) Sets the read-only mode of this
HasValue
to given mode.default void
setRequiredIndicatorVisible
(boolean requiredIndicatorVisible) Sets the required indicator visible or not.
Methods inherited from interface com.vaadin.flow.component.HasElement
getElement
Methods inherited from interface com.vaadin.flow.component.HasEnabled
isEnabled, setEnabled
Methods inherited from interface com.vaadin.flow.component.HasValue
addValueChangeListener, clear, getEmptyValue, getOptionalValue, getValue, isEmpty, setValue
-
Method Details
-
setRequiredIndicatorVisible
default void setRequiredIndicatorVisible(boolean requiredIndicatorVisible) Description copied from interface:
HasValue
Sets the required indicator visible or not.
If set visible, it is visually indicated in the user interface.
The method is intended to be used with
Binder
which does server-side validation. In case HTML element has its own (client-side) validation it should be disabled whensetRequiredIndicatorVisible(true)
is called and re-enabled back onsetRequiredIndicatorVisible(false)
. It's responsibility of each component implementation to follow the contract so that the method call doesn't do anything else than show/hide the "required" indication. Usually components provide their ownsetRequired
method which should be called in case the client-side validation is required.Specified by:
setRequiredIndicatorVisible
in interfaceHasValue<E extends HasValue.ValueChangeEvent<V>,
V> Parameters:
requiredIndicatorVisible
-true
to make the required indicator visible,false
if not -
isRequiredIndicatorVisible
default boolean isRequiredIndicatorVisible()Description copied from interface:
HasValue
Checks whether the required indicator is visible.
Specified by:
isRequiredIndicatorVisible
in interfaceHasValue<E extends HasValue.ValueChangeEvent<V>,
V> Returns:
true
if visible,false
if not -
setReadOnly
default void setReadOnly(boolean readOnly) Description copied from interface:
HasValue
Sets the read-only mode of this
HasValue
to given mode. The user can't change the value when in read-only mode.A
HasValue
with a visual component in read-only mode typically looks visually different to signal to the user that the value cannot be edited.Specified by:
setReadOnly
in interfaceHasValue<E extends HasValue.ValueChangeEvent<V>,
V> Parameters:
readOnly
- a boolean value specifying whether the component is put read-only mode or not -
isReadOnly
default boolean isReadOnly()Description copied from interface:
HasValue
Returns whether this
HasValue
is in read-only mode or not.Specified by:
isReadOnly
in interfaceHasValue<E extends HasValue.ValueChangeEvent<V>,
V> Returns:
false
if the user can modify the value,true
if not.
-