Package io.jmix.flowui.facet.settings

Class ComponentSettingsManagerImpl

java.lang.Object

io.jmix.flowui.facet.settings.ComponentSettingsManagerImpl

All Implemented Interfaces:

ComponentSettingsManager

@Component("flowui_ComponentSettingsManagerImpl")
public class ComponentSettingsManagerImpl
extends Object
implements ComponentSettingsManager

Implementation of ComponentSettingsManager that applies, saves, and manages settings for components using ComponentSettingsRegistry and UserSettingsCache.

Field Summary

Fields

Modifier and Type	Field	Description
protected ComponentSettingsRegistry	settingsRegistry
protected UserSettingsCache	userSettingsCache

Constructor Summary

Constructors

Constructor	Description
ComponentSettingsManagerImpl(ComponentSettingsRegistry settingsRegistry, UserSettingsCache userSettingsCache)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

settingsRegistry

protected ComponentSettingsRegistry settingsRegistry

userSettingsCache

protected UserSettingsCache userSettingsCache

Constructor Details

ComponentSettingsManagerImpl

public ComponentSettingsManagerImpl(ComponentSettingsRegistry settingsRegistry,
 UserSettingsCache userSettingsCache)

Method Details

applySettings

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

Description copied from interface: ComponentSettingsManager

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.

Specified by:

applySettings in interface ComponentSettingsManager

Parameters:

components - components to apply settings

componentSettings - UiComponentSettings

applyDataLoadingSettings

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

Description copied from interface: ComponentSettingsManager

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.

Specified by:

applyDataLoadingSettings in interface ComponentSettingsManager

Parameters:

components - components to apply settings

componentSettings - UiComponentSettings

saveSettings

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

Description copied from interface: ComponentSettingsManager

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.

Specified by:

saveSettings in interface ComponentSettingsManager

Parameters:

components - components to save settings

componentSettings - UiComponentSettings