Class JmixCheckboxGroup<V>

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.AbstractField<C,T>
com.vaadin.flow.component.AbstractSinglePropertyField<com.vaadin.flow.component.checkbox.CheckboxGroup<T>,Set<T>>
com.vaadin.flow.component.checkbox.CheckboxGroup<V>
io.jmix.flowui.component.checkboxgroup.JmixCheckboxGroup<V>
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasAriaLabel, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasHelper, com.vaadin.flow.component.HasLabel, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.HasValidation, com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.checkbox.CheckboxGroup<V>,Set<V>>,Set<V>>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.checkbox.CheckboxGroup<V>,Set<V>>,Set<V>>, com.vaadin.flow.component.shared.HasClientValidation, com.vaadin.flow.component.shared.HasThemeVariant<com.vaadin.flow.component.checkbox.CheckboxGroupVariant>, com.vaadin.flow.component.shared.HasTooltip, com.vaadin.flow.component.shared.HasValidationProperties, com.vaadin.flow.component.shared.InputField<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.checkbox.CheckboxGroup<V>,Set<V>>,Set<V>>, com.vaadin.flow.data.binder.HasItemComponents<V>, com.vaadin.flow.data.binder.HasValidator<Set<V>>, com.vaadin.flow.data.provider.HasDataView<V,Void,com.vaadin.flow.component.checkbox.dataview.CheckboxGroupDataView<V>>, com.vaadin.flow.data.provider.HasListDataView<V,com.vaadin.flow.component.checkbox.dataview.CheckboxGroupListDataView<V>>, com.vaadin.flow.data.selection.MultiSelect<com.vaadin.flow.component.checkbox.CheckboxGroup<V>,V>, HasRequired, SupportsStatusChangeHandler<JmixCheckboxGroup<V>>, SupportsTypedValue<JmixCheckboxGroup<V>,com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.checkbox.CheckboxGroup<V>,Set<V>>,Collection<V>,Set<V>>, SupportsValidation<Collection<V>>, SupportsDataProvider<V>, SupportsItemsContainer<V>, SupportsItemsEnum<V>, SupportsValueSource<Collection<V>>, Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

public class JmixCheckboxGroup<V> extends com.vaadin.flow.component.checkbox.CheckboxGroup<V> implements SupportsTypedValue<JmixCheckboxGroup<V>,com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.checkbox.CheckboxGroup<V>,Set<V>>,Collection<V>,Set<V>>, SupportsValueSource<Collection<V>>, SupportsDataProvider<V>, SupportsItemsContainer<V>, SupportsItemsEnum<V>, SupportsValidation<Collection<V>>, SupportsStatusChangeHandler<JmixCheckboxGroup<V>>, HasRequired, org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean
See Also:
  • Nested Class Summary

    Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField

    com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<C extends com.vaadin.flow.component.Component,V extends Object>

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.shared.HasClientValidation

    com.vaadin.flow.component.shared.HasClientValidation.ClientValidatedEvent

    Nested classes/interfaces inherited from interface com.vaadin.flow.data.binder.HasItemComponents

    com.vaadin.flow.data.binder.HasItemComponents.ItemComponent<T extends Object>

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue

    com.vaadin.flow.component.HasValue.ValueChangeEvent<V extends Object>, com.vaadin.flow.component.HasValue.ValueChangeListener<E extends com.vaadin.flow.component.HasValue.ValueChangeEvent<?>>

    Nested classes/interfaces inherited from interface io.jmix.flowui.component.SupportsStatusChangeHandler

    SupportsStatusChangeHandler.StatusContext<C extends com.vaadin.flow.component.Component>

    Nested classes/interfaces inherited from interface io.jmix.flowui.component.SupportsTypedValue

    SupportsTypedValue.TypedValueChangeEvent<C extends com.vaadin.flow.component.Component,V>
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.springframework.context.ApplicationContext
     
     
     
    protected Collection<V>
     
    protected boolean
    Component manually handles Vaadin value change event: when programmatically sets value (see setValueInternal(Collection, Set, boolean)) and client-side sets value (see onValueChange(ComponentValueChangeEvent)).

    Fields inherited from interface io.jmix.flowui.component.HasRequired

    PROPERTY_REQUIRED

    Fields inherited from interface io.jmix.flowui.component.SupportsValidation

    PROPERTY_ERROR_MESSAGE
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    com.vaadin.flow.shared.Registration
    addTypedValueChangeListener(com.vaadin.flow.component.ComponentEventListener<SupportsTypedValue.TypedValueChangeEvent<JmixCheckboxGroup<V>,Collection<V>>> listener)
     
    com.vaadin.flow.shared.Registration
    addValidator(Validator<? super Collection<V>> validator)
     
    com.vaadin.flow.shared.Registration
    addValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener<? super com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.checkbox.CheckboxGroup<V>,Set<V>>> listener)
     
    void
     
    protected void
     
    protected void
    bindDataProvider(com.vaadin.flow.data.provider.DataProvider<V,?> dataProvider)
     
     
     
    void
     
    protected boolean
     
    protected void
    fireAllValueChangeEvents(Collection<V> value, Collection<V> oldValue, boolean isFromClient)
     
    protected void
    fireCheckboxGroupValueChangeEvent(Collection<V> oldValue, boolean isFromClient)
     
    protected void
    fireTypedValueChangeEvent(Collection<V> value, Collection<V> oldValue, boolean isFromClient)
     
    com.vaadin.flow.data.provider.DataProvider<V,?>
     
     
     
     
     
    protected void
     
    boolean
     
    protected void
    onValueChange(com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<JmixCheckboxGroup<V>,Set<V>> event)
     
    void
    setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
     
    void
    setErrorMessage(String errorMessage)
     
    void
    setInvalid(boolean invalid)
    Sets invalid state to the field considering result of field validation.
    com.vaadin.flow.component.checkbox.dataview.CheckboxGroupDataView<V>
    setItems(com.vaadin.flow.data.provider.DataProvider<V,Void> dataProvider)
     
    com.vaadin.flow.component.checkbox.dataview.CheckboxGroupDataView<V>
    setItems(com.vaadin.flow.data.provider.InMemoryDataProvider<V> inMemoryDataProvider)
     
    com.vaadin.flow.component.checkbox.dataview.CheckboxGroupListDataView<V>
    setItems(com.vaadin.flow.data.provider.ListDataProvider<V> dataProvider)
     
    void
    Sets items from the passed CollectionContainer.
    void
    setItems(Class<V> itemsEnum)
    Sets items from the passed EnumClass.
    void
    setRequired(boolean required)
     
    void
    setRequiredIndicatorVisible(boolean requiredIndicatorVisible)
     
    void
    setRequiredMessage(String requiredMessage)
     
    void
    Sets a callback to be used to handle component status changes, e.g.
    void
     
    void
    setValue(Set<V> value)
     
    protected void
    setValueInternal(Collection<V> modelValue, Set<V> presentationValue, boolean fromClient)
     
    void
     
    protected void
     

    Methods inherited from class com.vaadin.flow.component.checkbox.CheckboxGroup

    addSelectionListener, getAriaLabel, getAriaLabelledBy, getGenericDataView, getItemEnabledProvider, getItemLabelGenerator, getItemRenderer, getLabel, getListDataView, getSelectedItems, hasValidValue, isDisabledBoolean, isReadOnly, isRequired, onAttach, onEnabledStateChanged, setAriaLabel, setAriaLabelledBy, setDataProvider, setDisabled, setItemEnabledProvider, setItemLabelGenerator, setLabel, setManualValidation, setReadOnly, setRenderer, updateSelection, valueEquals

    Methods inherited from class com.vaadin.flow.component.AbstractSinglePropertyField

    getSynchronizationRegistration, setPresentationValue, setSynchronizedEvent

    Methods inherited from class com.vaadin.flow.component.AbstractField

    getEmptyValue, getValue, isEmpty, setModelValue

    Methods inherited from class com.vaadin.flow.component.Component

    addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.vaadin.flow.component.AttachNotifier

    addAttachListener

    Methods inherited from interface com.vaadin.flow.component.DetachNotifier

    addDetachListener

    Methods inherited from interface com.vaadin.flow.component.shared.HasClientValidation

    addClientValidatedEventListener

    Methods inherited from interface com.vaadin.flow.component.HasComponents

    add, add, add, addComponentAsFirst, addComponentAtIndex, remove, remove, removeAll

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

    getHelperComponent, getHelperText, setHelperComponent, setHelperText

    Methods inherited from interface com.vaadin.flow.data.binder.HasItemComponents

    addComponents, getItemPosition, prependComponents

    Methods inherited from interface com.vaadin.flow.data.provider.HasListDataView

    setItems, setItems

    Methods inherited from interface io.jmix.flowui.component.HasRequired

    isRequired

    Methods inherited from interface com.vaadin.flow.component.HasSize

    getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

    Methods inherited from interface com.vaadin.flow.component.HasStyle

    addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

    Methods inherited from interface com.vaadin.flow.component.HasTheme

    addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

    Methods inherited from interface com.vaadin.flow.component.shared.HasThemeVariant

    addThemeVariants, removeThemeVariants

    Methods inherited from interface com.vaadin.flow.component.shared.HasTooltip

    getTooltip, setTooltipText

    Methods inherited from interface com.vaadin.flow.component.HasValidation

    setManualValidation

    Methods inherited from interface com.vaadin.flow.data.binder.HasValidator

    addValidationStatusChangeListener, getDefaultValidator

    Methods inherited from interface com.vaadin.flow.component.HasValue

    clear, getOptionalValue, isEmpty

    Methods inherited from interface com.vaadin.flow.component.HasValueAndElement

    isRequiredIndicatorVisible

    Methods inherited from interface com.vaadin.flow.data.selection.MultiSelect

    deselect, deselect, deselectAll, getEmptyValue, getValue, isSelected, select, select
  • Field Details

  • Constructor Details

    • JmixCheckboxGroup

      public JmixCheckboxGroup()
  • Method Details

    • setApplicationContext

      public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext) throws org.springframework.beans.BeansException
      Specified by:
      setApplicationContext in interface org.springframework.context.ApplicationContextAware
      Throws:
      org.springframework.beans.BeansException
    • afterPropertiesSet

      public void afterPropertiesSet() throws Exception
      Specified by:
      afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
      Throws:
      Exception
    • initComponent

      protected void initComponent()
    • setRequired

      public void setRequired(boolean required)
      Specified by:
      setRequired in interface HasRequired
      Overrides:
      setRequired in class com.vaadin.flow.component.checkbox.CheckboxGroup<V>
    • setRequiredIndicatorVisible

      public void setRequiredIndicatorVisible(boolean requiredIndicatorVisible)
      Specified by:
      setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.checkbox.CheckboxGroup<V>,Set<V>>,Set<V>>
      Specified by:
      setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.checkbox.CheckboxGroup<V>,Set<V>>,Set<V>>
    • getRequiredMessage

      @Nullable public String getRequiredMessage()
      Specified by:
      getRequiredMessage in interface HasRequired
    • setRequiredMessage

      public void setRequiredMessage(@Nullable String requiredMessage)
      Specified by:
      setRequiredMessage in interface HasRequired
    • addValidator

      public com.vaadin.flow.shared.Registration addValidator(Validator<? super Collection<V>> validator)
      Specified by:
      addValidator in interface SupportsValidation<V>
    • executeValidators

      public void executeValidators() throws ValidationException
      Specified by:
      executeValidators in interface SupportsValidation<V>
      Throws:
      ValidationException
    • validate

      protected void validate()
      Overrides:
      validate in class com.vaadin.flow.component.checkbox.CheckboxGroup<V>
    • isInvalid

      public boolean isInvalid()
      Specified by:
      isInvalid in interface com.vaadin.flow.component.HasValidation
      Specified by:
      isInvalid in interface com.vaadin.flow.component.shared.HasValidationProperties
    • setInvalid

      public void setInvalid(boolean invalid)
      Description copied from interface: SupportsValidation
      Sets invalid state to the field considering result of field validation.
      • Invalid - false and validation passed - false = field is invalid
      • Invalid - false and validation passed - true = field is valid
      • Invalid - true and validation passed - false = field is invalid
      • Invalid - true and validation passed - true = field is invalid
      Specified by:
      setInvalid in interface com.vaadin.flow.component.HasValidation
      Specified by:
      setInvalid in interface com.vaadin.flow.component.shared.HasValidationProperties
      Specified by:
      setInvalid in interface SupportsValidation<V>
      Parameters:
      invalid - whether field should be invalid
    • getErrorMessage

      @Nullable public String getErrorMessage()
      Specified by:
      getErrorMessage in interface com.vaadin.flow.component.HasValidation
      Specified by:
      getErrorMessage in interface com.vaadin.flow.component.shared.HasValidationProperties
      Specified by:
      getErrorMessage in interface SupportsValidation<V>
    • setErrorMessage

      public void setErrorMessage(@Nullable String errorMessage)
      Specified by:
      setErrorMessage in interface com.vaadin.flow.component.HasValidation
      Specified by:
      setErrorMessage in interface com.vaadin.flow.component.shared.HasValidationProperties
      Specified by:
      setErrorMessage in interface SupportsValidation<V>
    • setStatusChangeHandler

      public void setStatusChangeHandler(@Nullable Consumer<SupportsStatusChangeHandler.StatusContext<JmixCheckboxGroup<V>>> handler)
      Description copied from interface: SupportsStatusChangeHandler
      Sets a callback to be used to handle component status changes, e.g. validation messages set by HasValidation.setErrorMessage(String).
      Specified by:
      setStatusChangeHandler in interface SupportsStatusChangeHandler<V>
      Parameters:
      handler - a handler to set
    • setItems

      public void setItems(CollectionContainer<V> container)
      Description copied from interface: SupportsItemsContainer
      Sets items from the passed CollectionContainer.
      Specified by:
      setItems in interface SupportsItemsContainer<V>
      Parameters:
      container - a CollectionContainer to be used as items source
      See Also:
    • setItems

      public void setItems(Class<V> itemsEnum)
      Description copied from interface: SupportsItemsEnum
      Sets items from the passed EnumClass.
      Specified by:
      setItems in interface SupportsItemsEnum<V>
      Parameters:
      itemsEnum - a EnumClass to be used as items source
      See Also:
    • setItems

      public com.vaadin.flow.component.checkbox.dataview.CheckboxGroupDataView<V> setItems(com.vaadin.flow.data.provider.DataProvider<V,Void> dataProvider)
      Specified by:
      setItems in interface com.vaadin.flow.data.provider.HasDataView<V,Void,com.vaadin.flow.component.checkbox.dataview.CheckboxGroupDataView<V>>
      Overrides:
      setItems in class com.vaadin.flow.component.checkbox.CheckboxGroup<V>
    • setItems

      public com.vaadin.flow.component.checkbox.dataview.CheckboxGroupDataView<V> setItems(com.vaadin.flow.data.provider.InMemoryDataProvider<V> inMemoryDataProvider)
      Specified by:
      setItems in interface com.vaadin.flow.data.provider.HasDataView<V,Void,com.vaadin.flow.component.checkbox.dataview.CheckboxGroupDataView<V>>
      Overrides:
      setItems in class com.vaadin.flow.component.checkbox.CheckboxGroup<V>
    • setItems

      public com.vaadin.flow.component.checkbox.dataview.CheckboxGroupListDataView<V> setItems(com.vaadin.flow.data.provider.ListDataProvider<V> dataProvider)
      Specified by:
      setItems in interface com.vaadin.flow.data.provider.HasListDataView<V,com.vaadin.flow.component.checkbox.dataview.CheckboxGroupListDataView<V>>
      Overrides:
      setItems in class com.vaadin.flow.component.checkbox.CheckboxGroup<V>
    • bindDataProvider

      protected void bindDataProvider(com.vaadin.flow.data.provider.DataProvider<V,?> dataProvider)
    • getDataProvider

      @Nullable public com.vaadin.flow.data.provider.DataProvider<V,?> getDataProvider()
      Specified by:
      getDataProvider in interface SupportsDataProvider<V>
      Overrides:
      getDataProvider in class com.vaadin.flow.component.checkbox.CheckboxGroup<V>
    • getValueSource

      @Nullable public ValueSource<Collection<V>> getValueSource()
      Specified by:
      getValueSource in interface SupportsValueSource<V>
    • setValueSource

      public void setValueSource(@Nullable ValueSource<Collection<V>> valueSource)
      Specified by:
      setValueSource in interface SupportsValueSource<V>
    • getTypedValue

      @Nullable public Collection<V> getTypedValue()
      Specified by:
      getTypedValue in interface SupportsTypedValue<JmixCheckboxGroup<V>,com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.checkbox.CheckboxGroup<V>,Set<V>>,Collection<V>,Set<V>>
    • setTypedValue

      public void setTypedValue(@Nullable Collection<V> value)
      Specified by:
      setTypedValue in interface SupportsTypedValue<JmixCheckboxGroup<V>,com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.checkbox.CheckboxGroup<V>,Set<V>>,Collection<V>,Set<V>>
    • setValue

      public void setValue(Set<V> value)
      Specified by:
      setValue in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.checkbox.CheckboxGroup<V>,Set<V>>,Set<V>>
      Specified by:
      setValue in interface com.vaadin.flow.data.selection.MultiSelect<com.vaadin.flow.component.checkbox.CheckboxGroup<V>,V>
      Overrides:
      setValue in class com.vaadin.flow.component.checkbox.CheckboxGroup<V>
    • setValueInternal

      protected void setValueInternal(@Nullable Collection<V> modelValue, Set<V> presentationValue, boolean fromClient)
    • addValueChangeListener

      public com.vaadin.flow.shared.Registration addValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener<? super com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.checkbox.CheckboxGroup<V>,Set<V>>> listener)
      Specified by:
      addValueChangeListener in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.checkbox.CheckboxGroup<V>,Set<V>>,Set<V>>
      Overrides:
      addValueChangeListener in class com.vaadin.flow.component.AbstractField<com.vaadin.flow.component.checkbox.CheckboxGroup<V>,Set<V>>
    • addTypedValueChangeListener

      public com.vaadin.flow.shared.Registration addTypedValueChangeListener(com.vaadin.flow.component.ComponentEventListener<SupportsTypedValue.TypedValueChangeEvent<JmixCheckboxGroup<V>,Collection<V>>> listener)
      Specified by:
      addTypedValueChangeListener in interface SupportsTypedValue<JmixCheckboxGroup<V>,com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.checkbox.CheckboxGroup<V>,Set<V>>,Collection<V>,Set<V>>
    • attachValueChangeListener

      protected void attachValueChangeListener()
    • onValueChange

      protected void onValueChange(com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<JmixCheckboxGroup<V>,Set<V>> event)
    • fireCheckboxGroupValueChangeEvent

      protected void fireCheckboxGroupValueChangeEvent(@Nullable Collection<V> oldValue, boolean isFromClient)
    • fireAllValueChangeEvents

      protected void fireAllValueChangeEvents(@Nullable Collection<V> value, @Nullable Collection<V> oldValue, boolean isFromClient)
    • fireTypedValueChangeEvent

      protected void fireTypedValueChangeEvent(@Nullable Collection<V> value, @Nullable Collection<V> oldValue, boolean isFromClient)
    • fieldValueEquals

      protected boolean fieldValueEquals(@Nullable Collection<V> value, @Nullable Collection<V> oldValue)
    • createFieldDelegate

      protected CollectionFieldDelegate<JmixCheckboxGroup<V>,V,V> createFieldDelegate()
    • createDataViewDelegate

      protected DataViewDelegate<JmixCheckboxGroup<V>,V> createDataViewDelegate()