Package io.jmix.flowui.facet.settings
Interface ViewSettingsComponentManager
- All Known Implementing Classes:
ViewSettingsComponentManagerImpl
public interface ViewSettingsComponentManager
Saves and restores settings for components.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
applyDataLoadingSettings
(Collection<com.vaadin.flow.component.Component> components, ViewSettings viewSettings) Applies data loading settings fromViewSettings
to provided components.void
applySettings
(Collection<com.vaadin.flow.component.Component> components, ViewSettings viewSettings) Applies settings fromViewSettings
to provided components.void
saveSettings
(Collection<com.vaadin.flow.component.Component> components, ViewSettings viewSettings) Persists settings if they are changed orViewSettings.isModified()
returnstrue
.
-
Method Details
-
applySettings
void applySettings(Collection<com.vaadin.flow.component.Component> components, ViewSettings viewSettings) Applies settings fromViewSettings
to provided components.Note, component should have and id and
ComponentSettingsBinder
. Otherwise, it will be skipped while applying settings. SeeDataGridSettingsBinder
as an example.- Parameters:
components
- components to apply settingsviewSettings
-View
settings
-
applyDataLoadingSettings
void applyDataLoadingSettings(Collection<com.vaadin.flow.component.Component> components, ViewSettings viewSettings) Applies data loading settings fromViewSettings
to provided components.Note, component should have and id and
ComponentSettingsBinder
. Otherwise, it will be skipped while applying settings. SeeDataGridSettingsBinder
as an example.- Parameters:
components
- components to apply settingsviewSettings
-View
settings
-
saveSettings
void saveSettings(Collection<com.vaadin.flow.component.Component> components, ViewSettings viewSettings) Persists settings if they are changed orViewSettings.isModified()
returnstrue
.Note, component should have and id and
ComponentSettingsBinder
. Otherwise, it will be skipped while saving settings. SeeDataGridSettingsBinder
as an example.- Parameters:
components
- components to save settingsviewSettings
- screen settings
-