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
,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 Summary
Modifier and TypeMethodDescriptionvoid
applySettings
(V component, S settings) Applies settings to the component.Class<? extends com.vaadin.flow.component.Component>
getSettings
(V component) boolean
saveSettings
(V component, S settings) Invoked when component properties or states should be saved to settings.
-
Method Details
-
getComponentClass
Class<? extends com.vaadin.flow.component.Component> getComponentClass()- Returns:
- component class, e.g.
JmixDetails
-
getSettingsClass
- Returns:
- component settings class, e.g.
JmixDetailsSettings
-
applySettings
Applies settings to the component.- Parameters:
component
- componentsettings
- settings for the component
-
saveSettings
Invoked when component properties or states should be saved to settings.- Parameters:
component
- componentsettings
- settings for the component- Returns:
true
if settings were modified
-
getSettings
- Parameters:
component
- component- Returns:
- current component settings. It retrieves current property values from component and creates new settings instance.
-