Package io.jmix.flowui.facet.settings

Interface ViewSettingsComponentManager

All Superinterfaces:

ComponentSettingsManager

@Deprecated(since="2.8",
            forRemoval=true)
public interface ViewSettingsComponentManager
extends ComponentSettingsManager

Deprecated, for removal: This API element is subject to removal in a future version.

use ComponentSettingsManager instead

Saves and restores settings for components.

Method Summary

Modifier and Type	Method	Description
default void	applyDataLoadingSettings(Collection<com.vaadin.flow.component.Component> components, UiComponentSettings<?> settings)	Deprecated, for removal: This API element is subject to removal in a future version. Applies data loading settings from UiComponentSettings to provided components.
void	applyDataLoadingSettings(Collection<com.vaadin.flow.component.Component> components, ViewSettings viewSettings)	Deprecated, for removal: This API element is subject to removal in a future version. Applies data loading settings from ViewSettings to provided components.
default void	applySettings(Collection<com.vaadin.flow.component.Component> components, UiComponentSettings<?> settings)	Deprecated, for removal: This API element is subject to removal in a future version. Applies settings from UiComponentSettings to provided components.
void	applySettings(Collection<com.vaadin.flow.component.Component> components, ViewSettings viewSettings)	Deprecated, for removal: This API element is subject to removal in a future version. Applies settings from ViewSettings to provided components.
default void	saveSettings(Collection<com.vaadin.flow.component.Component> components, UiComponentSettings<?> settings)	Deprecated, for removal: This API element is subject to removal in a future version. Persists settings if they are changed or UiComponentSettings.isModified() returns true.
void	saveSettings(Collection<com.vaadin.flow.component.Component> components, ViewSettings viewSettings)	Deprecated, for removal: This API element is subject to removal in a future version. Persists settings if they are changed or UiComponentSettings.isModified() returns true.

Method Details

applySettings

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

Deprecated, for removal: This API element is subject to removal in a future version.

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.

Parameters:

components - components to apply settings

viewSettings - View settings

applySettings

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

Deprecated, for removal: This API element is subject to removal in a future version.

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

settings - UiComponentSettings

applyDataLoadingSettings

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

Deprecated, for removal: This API element is subject to removal in a future version.

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.

Parameters:

components - components to apply settings

viewSettings - View settings

applyDataLoadingSettings

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

Deprecated, for removal: This API element is subject to removal in a future version.

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

settings - UiComponentSettings

saveSettings

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

Deprecated, for removal: This API element is subject to removal in a future version.

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

viewSettings - screen settings

saveSettings

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

Deprecated, for removal: This API element is subject to removal in a future version.

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

settings - UiComponentSettings