Package io.jmix.flowui.facet.impl

Class SettingsFacetImpl

java.lang.Object

io.jmix.flowui.facet.impl.AbstractFacet

io.jmix.flowui.facet.impl.SettingsFacetImpl

All Implemented Interfaces:

Facet, SettingsFacet

public class SettingsFacetImpl
extends AbstractFacet
implements SettingsFacet

An implementation of the SettingsFacet interface that provides functionality for managing and applying settings related to views and their components.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	SettingsFacetImpl.ViewEventListener

Nested classes/interfaces inherited from interface io.jmix.flowui.facet.SettingsFacet

SettingsFacet.SettingsContext

Field Summary

Fields

Modifier and Type	Field	Description
protected Consumer<SettingsFacet.SettingsContext>	applyDataLoadingSettingsDelegate
protected Consumer<SettingsFacet.SettingsContext>	applySettingsDelegate
protected boolean	auto
protected SettingsFacetImpl.ViewEventListener	beforeShowListener
protected Set<String>	componentIds
protected SettingsFacetImpl.ViewEventListener	detachListener
protected Set<String>	excludedComponentIds
protected SettingsFacetImpl.ViewEventListener	readyListener
protected ReflectionCacheManager	reflectionCacheManager
protected Consumer<SettingsFacet.SettingsContext>	saveSettingsDelegate
protected SettingsFacetUrlQueryParametersHelper	settingsHelper
protected ViewSettingsComponentManager	settingsManager
protected UserSettingsCache	userSettingsCache
protected com.vaadin.flow.router.QueryParameters	viewQueryParameters
protected ViewSettings	viewSettings

Fields inherited from class io.jmix.flowui.facet.impl.AbstractFacet

id, owner

Constructor Summary

Constructors

Constructor	Description
SettingsFacetImpl(SettingsFacetUrlQueryParametersHelper settingsHelper, ReflectionCacheManager reflectionCacheManager, UserSettingsCache userSettingsCache, ViewSettingsComponentManager settingsManager, UserSettingsService userSettingsService)

Method Summary

Modifier and Type	Method	Description
void	addComponentIds(String... ids)	Adds component ids that should be managed when SettingsFacet.isAuto() returns false.
void	addExcludedComponentIds(String... ids)	Adds component ids that should be excluded from applying and saving settings.
void	applyDataLoadingSettings()	Restores settings that related with data loading.
protected void	applyDataLoadingViewSettings(Collection<com.vaadin.flow.component.Component> components)
void	applySettings()	Restores settings for components.
protected void	applyViewSettings(Collection<com.vaadin.flow.component.Component> components)
protected void	checkAttachedToView()
protected SettingsFacet.SettingsContext	createSettingsContext()
protected ViewSettings	createViewSettings(View<?> view)
protected Collection<com.vaadin.flow.component.Component>	excludeUrlQueryParametersFacetComponents(Collection<com.vaadin.flow.component.Component> components)
Consumer<SettingsFacet.SettingsContext>	getApplyDataLoadingSettingsDelegate()
Consumer<SettingsFacet.SettingsContext>	getApplySettingsDelegate()
Set<String>	getComponentIds()
Set<String>	getExcludedComponentIds()
Collection<com.vaadin.flow.component.Component>	getManagedComponents()	Collection depends on SettingsFacet.isAuto() property.
protected Collection<com.vaadin.flow.component.Component>	getManagedComponentsFromCollection(Collection<com.vaadin.flow.component.Component> viewComponents)
Consumer<SettingsFacet.SettingsContext>	getSaveSettingsDelegate()
ViewSettings	getSettings()
protected View<?>	getView()
protected void	initViewSettings(ViewSettings viewSettings)
boolean	isAuto()
protected boolean	isSettingsEnabled()
protected void	onQueryParametersChange(com.vaadin.flow.component.ComponentEvent<?> event)
protected void	onViewBeforeShow(com.vaadin.flow.component.ComponentEvent<?> event)
protected void	onViewDetach(com.vaadin.flow.component.ComponentEvent<?> event)
protected void	onViewReady(com.vaadin.flow.component.ComponentEvent<?> event)
void	saveSettings()	Persists settings to store.
protected void	saveViewSettings(Collection<com.vaadin.flow.component.Component> components)
void	setApplyDataLoadingSettingsDelegate(Consumer<SettingsFacet.SettingsContext> delegate)	Sets handler that should be invoked instead of default facet's logic for applying data loading settings.
void	setApplySettingsDelegate(Consumer<SettingsFacet.SettingsContext> delegate)	Sets handler that should be invoked instead of default facet's logic for applying settings.
void	setAuto(boolean auto)	Defines in which mode facet will work.
void	setOwner(View<?> owner)	Sets a view containing this facet.
void	setSaveSettingsDelegate(Consumer<SettingsFacet.SettingsContext> delegate)	Sets handler that should be invoked instead of default facet's logic for saving settings.
protected void	subscribeViewLifecycle()
protected void	unsubscribeViewLifecycle()

Methods inherited from class io.jmix.flowui.facet.impl.AbstractFacet

getId, getOwner, setId

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.flowui.facet.Facet

getId, getOwner, setId

Field Details

settingsHelper

protected SettingsFacetUrlQueryParametersHelper settingsHelper

reflectionCacheManager

protected ReflectionCacheManager reflectionCacheManager

settingsManager

protected ViewSettingsComponentManager settingsManager

userSettingsCache

protected UserSettingsCache userSettingsCache

componentIds

protected Set<String> componentIds

excludedComponentIds

protected Set<String> excludedComponentIds

viewSettings

protected ViewSettings viewSettings

auto

protected boolean auto

beforeShowListener

protected SettingsFacetImpl.ViewEventListener beforeShowListener

readyListener

protected SettingsFacetImpl.ViewEventListener readyListener

detachListener

protected SettingsFacetImpl.ViewEventListener detachListener

applySettingsDelegate

protected Consumer<SettingsFacet.SettingsContext> applySettingsDelegate

applyDataLoadingSettingsDelegate

protected Consumer<SettingsFacet.SettingsContext> applyDataLoadingSettingsDelegate

saveSettingsDelegate

protected Consumer<SettingsFacet.SettingsContext> saveSettingsDelegate

viewQueryParameters

protected com.vaadin.flow.router.QueryParameters viewQueryParameters

Constructor Details

SettingsFacetImpl

public SettingsFacetImpl(SettingsFacetUrlQueryParametersHelper settingsHelper,
 ReflectionCacheManager reflectionCacheManager,
 UserSettingsCache userSettingsCache,
 ViewSettingsComponentManager settingsManager,
 @Nullable
 UserSettingsService userSettingsService)

Method Details

isAuto

public boolean isAuto()

Specified by:

isAuto in interface SettingsFacet

Returns:

the mode in which facet is worked. true if facet includes all components and false if only specified components by SettingsFacet.addComponentIds(String...) will be managed.

setAuto

public void setAuto(boolean auto)

Description copied from interface: SettingsFacet

Defines in which mode facet will work. If 'auto' is set to true it means that all components that contain an id and have ComponentSettingsBinder will be managed by facet.

If 'auto' mode is disabled (set to false), only specified components by SettingsFacet.addComponentIds(String...) will be managed.

The default value is false.

Specified by:

setAuto in interface SettingsFacet

Parameters:

auto - whether facet should include all components

getSettings

public ViewSettings getSettings()

Specified by:

getSettings in interface SettingsFacet

Returns:

View settings or null if facet is not attached to the View

applySettings

public void applySettings()

Description copied from interface: SettingsFacet

Restores settings for components. Facet applies settings on View's View.ReadyEvent.

Specified by:

applySettings in interface SettingsFacet

applyDataLoadingSettings

public void applyDataLoadingSettings()

Description copied from interface: SettingsFacet

Restores settings that related with data loading. For instance, it applies sort columns and its direction in DataGrid before data loading.

Facet applies data loading settings on View's View.BeforeShowEvent.

Specified by:

applyDataLoadingSettings in interface SettingsFacet

saveSettings

public void saveSettings()

Description copied from interface: SettingsFacet

Persists settings to store. Facet saves settings on View's DetachEvent.

Specified by:

saveSettings in interface SettingsFacet

addComponentIds

public void addComponentIds(String... ids)

Description copied from interface: SettingsFacet

Adds component ids that should be managed when SettingsFacet.isAuto() returns false.

Note, component must be attached to the View, otherwise it will be ignored.

Specified by:

addComponentIds in interface SettingsFacet

Parameters:

ids - component ids

getComponentIds

public Set<String> getComponentIds()

Specified by:

getComponentIds in interface SettingsFacet

Returns:

set of component ids that should be handled when SettingsFacet.isAuto() returns false

addExcludedComponentIds

public void addExcludedComponentIds(String... ids)

Description copied from interface: SettingsFacet

Adds component ids that should be excluded from applying and saving settings. Excluding is applied despite SettingsFacet.isAuto() mode and has priority over explicitly added component ids SettingsFacet.addComponentIds(String...).

Specified by:

addExcludedComponentIds in interface SettingsFacet

Parameters:

ids - component ids to exclude

getExcludedComponentIds

public Set<String> getExcludedComponentIds()

Specified by:

getExcludedComponentIds in interface SettingsFacet

Returns:

set of component ids that should be excluded from applying and saving settings

getManagedComponents

public Collection<com.vaadin.flow.component.Component> getManagedComponents()

Description copied from interface: SettingsFacet

Collection depends on SettingsFacet.isAuto() property. If SettingsFacet.isAuto() returns true, collection will be filled by View's components, otherwise collection will be filled by components that explicitly added by SettingsFacet.addComponentIds(String...).

Specified by:

getManagedComponents in interface SettingsFacet

Returns:

components collection that is used for applying and saving settings

getApplySettingsDelegate

@Nullable
public Consumer<SettingsFacet.SettingsContext> getApplySettingsDelegate()

Specified by:

getApplySettingsDelegate in interface SettingsFacet

Returns:

apply settings delegate or null if not set

setApplySettingsDelegate

public void setApplySettingsDelegate(@Nullable
 Consumer<SettingsFacet.SettingsContext> delegate)

Description copied from interface: SettingsFacet

Sets handler that should be invoked instead of default facet's logic for applying settings.

For instance:

 @Install(to = "settingsFacet", subject = "applySettingsDelegate")
 private void onApplySettings(SettingsFacet.SettingsContext settingsContext) {
     settingsFacet.applySettings();
 }
 

Specified by:

setApplySettingsDelegate in interface SettingsFacet

Parameters:

delegate - handler to set

getApplyDataLoadingSettingsDelegate

@Nullable
public Consumer<SettingsFacet.SettingsContext> getApplyDataLoadingSettingsDelegate()

Specified by:

getApplyDataLoadingSettingsDelegate in interface SettingsFacet

Returns:

apply data loading settings delegate or null if not set

setApplyDataLoadingSettingsDelegate

public void setApplyDataLoadingSettingsDelegate(@Nullable
 Consumer<SettingsFacet.SettingsContext> delegate)

Description copied from interface: SettingsFacet

Sets handler that should be invoked instead of default facet's logic for applying data loading settings.

For instance:

 @Install(to = "settingsFacet", subject = "applyDataLoadingSettingsDelegate")
 private void onApplyDataLoadingSettings(SettingsFacet.SettingsContext settingsContext) {
     settingsFacet.applyDataLoadingSettings();
 }
 

Specified by:

setApplyDataLoadingSettingsDelegate in interface SettingsFacet

Parameters:

delegate - handler to set

getSaveSettingsDelegate

@Nullable
public Consumer<SettingsFacet.SettingsContext> getSaveSettingsDelegate()

Specified by:

getSaveSettingsDelegate in interface SettingsFacet

Returns:

save settings delegate or null if not set

setSaveSettingsDelegate

public void setSaveSettingsDelegate(@Nullable
 Consumer<SettingsFacet.SettingsContext> delegate)

Description copied from interface: SettingsFacet

Sets handler that should be invoked instead of default facet's logic for saving settings.

For instance:

 @Install(to = "settingsFacet", subject = "saveSettingsDelegate")
 private void onSaveSettings(SettingsFacet.SettingsContext settingsContext) {
     settingsFacet.saveSettings();
 }
 

Specified by:

setSaveSettingsDelegate in interface SettingsFacet

Parameters:

delegate - handler to set

setOwner

public void setOwner(@Nullable
 View<?> owner)

Description copied from interface: Facet

Sets a view containing this facet.

Specified by:

setOwner in interface Facet

Overrides:

setOwner in class AbstractFacet

Parameters:

owner - a view containing this facet

getManagedComponentsFromCollection

protected Collection<com.vaadin.flow.component.Component> getManagedComponentsFromCollection(Collection<com.vaadin.flow.component.Component> viewComponents)

createViewSettings

protected ViewSettings createViewSettings(View<?> view)

initViewSettings

protected void initViewSettings(ViewSettings viewSettings)

unsubscribeViewLifecycle

protected void unsubscribeViewLifecycle()

subscribeViewLifecycle

protected void subscribeViewLifecycle()

onViewBeforeShow

protected void onViewBeforeShow(com.vaadin.flow.component.ComponentEvent<?> event)

onViewReady

protected void onViewReady(com.vaadin.flow.component.ComponentEvent<?> event)

onViewDetach

protected void onViewDetach(com.vaadin.flow.component.ComponentEvent<?> event)

onQueryParametersChange

protected void onQueryParametersChange(com.vaadin.flow.component.ComponentEvent<?> event)

applyViewSettings

protected void applyViewSettings(Collection<com.vaadin.flow.component.Component> components)

applyDataLoadingViewSettings

protected void applyDataLoadingViewSettings(Collection<com.vaadin.flow.component.Component> components)

saveViewSettings

protected void saveViewSettings(Collection<com.vaadin.flow.component.Component> components)

checkAttachedToView

protected void checkAttachedToView()

isSettingsEnabled

protected boolean isSettingsEnabled()

excludeUrlQueryParametersFacetComponents

protected Collection<com.vaadin.flow.component.Component> excludeUrlQueryParametersFacetComponents(Collection<com.vaadin.flow.component.Component> components)

getView

protected View<?> getView()

createSettingsContext

protected SettingsFacet.SettingsContext createSettingsContext()