Package io.jmix.flowuidata.settings

Class ViewSettingsComponentManagerImpl

java.lang.Object

io.jmix.flowuidata.settings.ViewSettingsComponentManagerImpl

All Implemented Interfaces:

ViewSettingsComponentManager

@Component("flowui_ViewSettingsComponentManagerImpl")
public class ViewSettingsComponentManagerImpl
extends Object
implements ViewSettingsComponentManager

Field Summary

Fields

Modifier and Type	Field	Description
protected ViewSettingsComponentRegistry	settingsRegistry
protected UserSettingsCache	userSettingsCache

Constructor Summary

Constructors

Constructor	Description
ViewSettingsComponentManagerImpl(ViewSettingsComponentRegistry settingsRegistry, UserSettingsCache userSettingsCache)

Method Summary

Modifier and Type	Method	Description
void	applyDataLoadingSettings(Collection<com.vaadin.flow.component.Component> components, ViewSettings viewSettings)	Applies data loading settings from ViewSettings to provided components.
void	applySettings(Collection<com.vaadin.flow.component.Component> components, ViewSettings viewSettings)	Applies settings from ViewSettings to provided components.
void	saveSettings(Collection<com.vaadin.flow.component.Component> components, ViewSettings viewSettings)	Persists settings if they are changed or ViewSettings.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 ViewSettingsComponentRegistry settingsRegistry

userSettingsCache

protected UserSettingsCache userSettingsCache

Constructor Details

ViewSettingsComponentManagerImpl

public ViewSettingsComponentManagerImpl(ViewSettingsComponentRegistry settingsRegistry,
 UserSettingsCache userSettingsCache)

Method Details

applySettings

public void applySettings(Collection<com.vaadin.flow.component.Component> components,
 ViewSettings viewSettings)

Description copied from interface: ViewSettingsComponentManager

Applies settings from ViewSettings 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 ViewSettingsComponentManager

Parameters:

components - components to apply settings

viewSettings - View settings

applyDataLoadingSettings

public void applyDataLoadingSettings(Collection<com.vaadin.flow.component.Component> components,
 ViewSettings viewSettings)

Description copied from interface: ViewSettingsComponentManager

Applies data loading settings from ViewSettings 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 ViewSettingsComponentManager

Parameters:

components - components to apply settings

viewSettings - View settings

saveSettings

public void saveSettings(Collection<com.vaadin.flow.component.Component> components,
 ViewSettings viewSettings)

Description copied from interface: ViewSettingsComponentManager

Persists settings if they are changed or ViewSettings.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 ViewSettingsComponentManager

Parameters:

components - components to save settings

viewSettings - screen settings