Package io.jmix.flowui.facet.settings

Interface ComponentSettingsManager

All Known Implementing Classes:

ComponentSettingsManagerImpl

@NullMarked
public interface ComponentSettingsManager

Saves and restores settings for components.

Method Summary

Modifier and Type	Method	Description
void	applyDataLoadingSettings(Collection<com.vaadin.flow.component.Component> components, UiComponentSettings<?> settings)	Applies data loading settings from UiComponentSettings to provided components.
void	applySettings(Collection<com.vaadin.flow.component.Component> components, UiComponentSettings<?> settings)	Applies settings from UiComponentSettings to provided components.
void	saveSettings(Collection<com.vaadin.flow.component.Component> components, UiComponentSettings<?> settings)	Persists settings if they are changed or UiComponentSettings.isModified() returns true.

Method Details

applySettings

void applySettings(Collection<com.vaadin.flow.component.Component> components,
 UiComponentSettings<?> settings)

Applies settings from UiComponentSettings to provided components.

Note, component should have and id and ComponentSettingsBinder. Otherwise, it will be skipped while applying settings. See DataGridSettingsBinder as an example.

Parameters:

components - components to apply settings

settings - UiComponentSettings

applyDataLoadingSettings

void applyDataLoadingSettings(Collection<com.vaadin.flow.component.Component> components,
 UiComponentSettings<?> settings)

Applies data loading settings from UiComponentSettings to provided components.

Note, component should have and id and ComponentSettingsBinder. Otherwise, it will be skipped while applying settings. See DataGridSettingsBinder as an example.

Parameters:

components - components to apply settings

settings - UiComponentSettings

saveSettings

void saveSettings(Collection<com.vaadin.flow.component.Component> components,
 UiComponentSettings<?> settings)

Persists settings if they are changed or UiComponentSettings.isModified() returns true.

Note, component should have and id and ComponentSettingsBinder. Otherwise, it will be skipped while saving settings. See DataGridSettingsBinder as an example.

Parameters:

components - components to save settings

settings - UiComponentSettings