io.jmix.ui.settings

Interface ScreenSettingsManager

All Known Implementing Classes:

ScreenSettingsManagerImpl

public interface ScreenSettingsManager

Provides functionality for applying and saving component settings.

Method Summary

Modifier and Type	Method and Description
void	applyDataLoadingSettings(java.util.Collection<Component> components, ScreenSettings screenSettings) Applies data loading settings for component if ComponentSettingsBinder is created for it.
void	applySettings(java.util.Collection<Component> components, ScreenSettings screenSettings) Applies settings for component if ComponentSettingsBinder is created for it.
void	saveSettings(java.util.Collection<Component> components, ScreenSettings screenSettings) Saves settings and persist if they are changed or screen settings is modified.

Method Detail

applySettings

void applySettings(java.util.Collection<Component> components,
                   ScreenSettings screenSettings)

Applies settings for component if ComponentSettingsBinder is created for it. See TableSettingsBinder as an example.

Parameters:

components - components to apply settings

screenSettings - screen settings

applyDataLoadingSettings

void applyDataLoadingSettings(java.util.Collection<Component> components,
                              ScreenSettings screenSettings)

Applies data loading settings for component if ComponentSettingsBinder is created for it. See TableSettingsBinder as an example.

Parameters:

components - components to apply settings

screenSettings - screen settings

saveSettings

void saveSettings(java.util.Collection<Component> components,
                  ScreenSettings screenSettings)

Saves settings and persist if they are changed or screen settings is modified. ComponentSettingsBinder must be created for component. See TableSettingsBinder as an example.

Parameters:

components - components to save settings

screenSettings - screen settings