Package io.jmix.flowui.component.checkboxgroup

Class JmixCheckboxGroup<V>

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.AbstractField<C,T>
com.vaadin.flow.component.AbstractSinglePropertyField<R,T>
com.vaadin.flow.component.checkbox.GeneratedVaadinCheckboxGroup<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.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.data.binder.HasItemComponents<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, 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>, 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>, SupportsValidation<Collection<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.checkbox.GeneratedVaadinCheckboxGroup

    com.vaadin.flow.component.checkbox.GeneratedVaadinCheckboxGroup.InvalidChangeEvent<R extends com.vaadin.flow.component.checkbox.GeneratedVaadinCheckboxGroup<R,?>>

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

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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.springframework.context.ApplicationContext
    applicationContext
     
    protected DataViewDelegate<JmixCheckboxGroup<V>,V>
    dataViewDelegate
     
    protected CollectionFieldDelegate<JmixCheckboxGroup<V>,V,V>
    fieldDelegate
     
    protected Collection<V>
    internalValue
     
    protected boolean
    isVaadinValueChangeEnabled
    Component manually handles Vaadin value change event: when programmatically sets value (see setValueInternal(Collection, Set)) 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
    JmixCheckboxGroup()
     

  • 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
    afterPropertiesSet()
     
    protected void
    attachValueChangeListener()
     
    protected DataViewDelegate<JmixCheckboxGroup<V>,V>
    createDataViewDelegate()
     
    protected CollectionFieldDelegate<JmixCheckboxGroup<V>,V,V>
    createFieldDelegate()
     
    void
    executeValidators()
     
    protected boolean
    fieldValueEquals(Collection<V> value, Collection<V> oldValue)
     
    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)
     
    String
    getRequiredMessage()
     
    Collection<V>
    getTypedValue()
     
    ValueSource<Collection<V>>
    getValueSource()
     
    protected void
    initComponent()
     
    boolean
    isInvalid()
     
    protected void
    onValueChange(com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<JmixCheckboxGroup<V>,Set<V>> event)
     
    void
    setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
     
    void
    setDataProvider(com.vaadin.flow.data.provider.DataProvider<V,?> dataProvider)
     
    void
    setInvalid(boolean invalid)
    Sets invalid state to the field considering result of field validation.
    void
    setItems(CollectionContainer<V> container)
    Sets items from the passed CollectionContainer.
    void
    setRequiredMessage(String requiredMessage)
     
    void
    setTypedValue(Collection<V> value)
     
    void
    setValue(Set<V> value)
     
    protected void
    setValueInternal(Collection<V> modelValue, Set<V> presentationValue)
     
    void
    setValueSource(ValueSource<Collection<V>> valueSource)
     
    protected void
    validate()
     

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

    addSelectionListener, getDataProvider, getErrorMessage, getGenericDataView, getItemEnabledProvider, getItemLabelGenerator, getItemRenderer, getLabel, getListDataView, getSelectedItems, hasValidValue, isReadOnly, isRequired, onAttach, onEnabledStateChanged, setErrorMessage, setItemEnabledProvider, setItemLabelGenerator, setItems, setItems, setItems, setItems, setLabel, setReadOnly, setRenderer, setRequired, updateSelection, valueEquals

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

    addInvalidChangeListener, addThemeVariants, getErrorMessageString, getLabelString, isDisabledBoolean, isInvalidBoolean, isRequiredBoolean, removeThemeVariants, setDisabled

    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, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, 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.HasComponents

    add, add, addComponentAsFirst, addComponentAtIndex, 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, setRequired

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

    clear, getOptionalValue, isEmpty

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

    isRequiredIndicatorVisible, setRequiredIndicatorVisible

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

    deselect, deselect, deselectAll, getEmptyValue, getValue, isSelected, select, select

    Methods inherited from interface io.jmix.flowui.data.SupportsDataProvider

    getDataProvider

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

    getErrorMessage, setErrorMessage

  • 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()

    • 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.GeneratedVaadinCheckboxGroup<com.vaadin.flow.component.checkbox.CheckboxGroup<V>,Set<V>>

    • isInvalid

      public boolean isInvalid()
      Specified by:
      isInvalid in interface com.vaadin.flow.component.HasValidation
      Overrides:
      isInvalid in class com.vaadin.flow.component.checkbox.CheckboxGroup<V>

    • 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 valid
      • 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 valid
      Specified by:
      setInvalid in interface com.vaadin.flow.component.HasValidation
      Specified by:
      setInvalid in interface SupportsValidation<V>
      Overrides:
      setInvalid in class com.vaadin.flow.component.checkbox.CheckboxGroup<V>
      Parameters:
      invalid - whether field should be invalid

    • 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:

    • setDataProvider

      public void setDataProvider(com.vaadin.flow.data.provider.DataProvider<V,?> dataProvider)
      Overrides:
      setDataProvider 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)

    • 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()