Package io.jmix.flowui.facet.settings.component.binder

Interface ComponentSettingsBinder<V extends com.vaadin.flow.component.Component,S extends Settings>

All Known Subinterfaces:
DataLoadingSettingsBinder<V,S>
All Known Implementing Classes:
AbstractGridSettingsBinder, DataGridSettingsBinder, GenericFilterSettingsBinder, JmixDetailsSettingsBinder, KanbanSettingsBinder, PivotTableSettingsBinder, SimplePaginationSettingsBinder, TreeDataGridSettingsBinder
public interface ComponentSettingsBinder<V extends com.vaadin.flow.component.Component,S extends Settings>
Base interface for component settings registration. As an example see JmixDetailsSettingsBinder.

  • Method Details

    • getComponentClass

      Class<? extends com.vaadin.flow.component.Component> getComponentClass()
      Returns:
      component class, e.g. JmixDetails

    • getSettingsClass

      Class<? extends Settings> getSettingsClass()
      Returns:
      component settings class, e.g. JmixDetailsSettings

    • applySettings

      void applySettings(V component, S settings)
      Applies settings to the component.
      Parameters:
      component - component
      settings - settings for the component

    • saveSettings

      boolean saveSettings(V component, S settings)
      Invoked when component properties or states should be saved to settings.
      Parameters:
      component - component
      settings - settings for the component
      Returns:
      true if settings were modified

    • getSettings

      S getSettings(V component)
      Parameters:
      component - component
      Returns:
      current component settings. It retrieves current property values from component and creates new settings instance.