Package io.jmix.flowui.facet.impl

Class AbstractSettingsFacet<S extends UiComponentSettings<S>>

java.lang.Object

io.jmix.flowui.facet.impl.AbstractFacet

io.jmix.flowui.facet.impl.AbstractSettingsFacet<S>

All Implemented Interfaces:

Facet, SettingsFacet<S>

Direct Known Subclasses:

FragmentSettingsFacetImpl, ViewSettingsFacetImpl

public abstract class AbstractSettingsFacet<S extends UiComponentSettings<S>>
extends AbstractFacet
implements SettingsFacet<S>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractSettingsFacet.OwnerEventListener

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

SettingsFacet.SettingsContext<S extends UiComponentSettings<S>>

Field Summary

Fields

Modifier and Type	Field	Description
protected Consumer<SettingsFacet.SettingsContext<S>>	applyDataLoadingSettingsDelegate
protected Consumer<SettingsFacet.SettingsContext<S>>	applySettingsDelegate
protected boolean	auto
protected Set<String>	componentIds
protected S	componentSettings
protected Set<String>	excludedComponentIds
protected ReflectionCacheManager	reflectionCacheManager
protected Consumer<SettingsFacet.SettingsContext<S>>	saveSettingsDelegate
protected SettingsFacetUrlQueryParametersHelper	settingsHelper
protected ComponentSettingsManager	settingsManager
protected UserSettingsCache	userSettingsCache
protected com.vaadin.flow.router.QueryParameters	viewQueryParameters

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

id, owner

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSettingsFacet(SettingsFacetUrlQueryParametersHelper settingsHelper, ReflectionCacheManager reflectionCacheManager, UserSettingsCache userSettingsCache, ComponentSettingsManager 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.
protected void	applyComponentSettings(Collection<com.vaadin.flow.component.Component> components)
protected void	applyDataLoadingComponentSettings(Collection<com.vaadin.flow.component.Component> components)
void	applyDataLoadingSettings()	Restores settings that related with data loading.
void	applySettings()	Restores settings for components.
protected void	checkAttachedToOwner()
protected abstract S	createSettings(FacetOwner owner)
protected SettingsFacet.SettingsContext<S>	createSettingsContext()
protected Collection<com.vaadin.flow.component.Component>	excludeUrlQueryParametersFacetComponents(Collection<com.vaadin.flow.component.Component> components)
Consumer<SettingsFacet.SettingsContext<S>>	getApplyDataLoadingSettingsDelegate()
Consumer<SettingsFacet.SettingsContext<S>>	getApplySettingsDelegate()
Set<String>	getComponentIds()
Set<String>	getExcludedComponentIds()
protected abstract HasFacets	getFacets()
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> ownerComponents)
protected com.vaadin.flow.component.Composite<?>	getOwnerComponent()
Consumer<SettingsFacet.SettingsContext<S>>	getSaveSettingsDelegate()
S	getSettings()
protected void	initSettings(S settings)
boolean	isAuto()
protected boolean	isSettingsEnabled()
protected void	saveComponentSettings(Collection<com.vaadin.flow.component.Component> components)
void	saveSettings()	Persists settings to store.
void	setApplyDataLoadingSettingsDelegate(Consumer<SettingsFacet.SettingsContext<S>> delegate)	Sets handler that should be invoked instead of the default facet's logic for applying data loading settings.
void	setApplySettingsDelegate(Consumer<SettingsFacet.SettingsContext<S>> delegate)	Sets handler that should be invoked instead of the default facet's logic for applying settings.
void	setAuto(boolean auto)	Defines in which mode facet will work.
<T extends com.vaadin.flow.component.Composite<?> & FacetOwner> void	setOwner(T owner)	Sets an owner containing this facet.
void	setSaveSettingsDelegate(Consumer<SettingsFacet.SettingsContext<S>> delegate)	Sets handler that should be invoked instead of the default facet's logic for saving settings.
protected abstract void	subscribeOwnerLifecycle()
protected abstract void	unsubscribeOwnerLifecycle()

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 ComponentSettingsManager settingsManager

userSettingsCache

protected UserSettingsCache userSettingsCache

componentIds

protected Set<String> componentIds

excludedComponentIds

protected Set<String> excludedComponentIds

componentSettings

protected S extends UiComponentSettings<S> componentSettings

auto

protected boolean auto

applySettingsDelegate

protected Consumer<SettingsFacet.SettingsContext<S extends UiComponentSettings<S>>> applySettingsDelegate

applyDataLoadingSettingsDelegate

protected Consumer<SettingsFacet.SettingsContext<S extends UiComponentSettings<S>>> applyDataLoadingSettingsDelegate

saveSettingsDelegate

protected Consumer<SettingsFacet.SettingsContext<S extends UiComponentSettings<S>>> saveSettingsDelegate

viewQueryParameters

protected com.vaadin.flow.router.QueryParameters viewQueryParameters

Constructor Details

AbstractSettingsFacet

protected AbstractSettingsFacet(SettingsFacetUrlQueryParametersHelper settingsHelper,
 ReflectionCacheManager reflectionCacheManager,
 UserSettingsCache userSettingsCache,
 ComponentSettingsManager settingsManager,
 @Nullable
 UserSettingsService userSettingsService)

Method Details

isAuto

public boolean isAuto()

Specified by:

isAuto in interface SettingsFacet<S extends UiComponentSettings<S>>

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<S extends UiComponentSettings<S>>

Parameters:

auto - whether facet should include all components

getSettings

public S getSettings()

Specified by:

getSettings in interface SettingsFacet<S extends UiComponentSettings<S>>

Returns:

UiComponentSettings or null if facet is not attached to the FacetOwner

applySettings

public void applySettings()

Description copied from interface: SettingsFacet

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

Specified by:

applySettings in interface SettingsFacet<S extends UiComponentSettings<S>>

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 Owner's View.BeforeShowEvent.

Specified by:

applyDataLoadingSettings in interface SettingsFacet<S extends UiComponentSettings<S>>

saveSettings

public void saveSettings()

Description copied from interface: SettingsFacet

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

Specified by:

saveSettings in interface SettingsFacet<S extends UiComponentSettings<S>>

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 Owner's, otherwise it will be ignored.

Specified by:

addComponentIds in interface SettingsFacet<S extends UiComponentSettings<S>>

Parameters:

ids - component ids

getComponentIds

public Set<String> getComponentIds()

Specified by:

getComponentIds in interface SettingsFacet<S extends UiComponentSettings<S>>

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<S extends UiComponentSettings<S>>

Parameters:

ids - component ids to exclude

getExcludedComponentIds

public Set<String> getExcludedComponentIds()

Specified by:

getExcludedComponentIds in interface SettingsFacet<S extends UiComponentSettings<S>>

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, a collection will be filled by Owner's components, otherwise a collection will be filled by components that explicitly added by SettingsFacet.addComponentIds(String...).

Specified by:

getManagedComponents in interface SettingsFacet<S extends UiComponentSettings<S>>

Returns:

components collection that is used for applying and saving settings

getApplySettingsDelegate

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

Specified by:

getApplySettingsDelegate in interface SettingsFacet<S extends UiComponentSettings<S>>

Returns:

apply settings delegate or null if not set

setApplySettingsDelegate

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

Description copied from interface: SettingsFacet

Sets handler that should be invoked instead of the 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<S extends UiComponentSettings<S>>

Parameters:

delegate - handler to set

getApplyDataLoadingSettingsDelegate

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

Specified by:

getApplyDataLoadingSettingsDelegate in interface SettingsFacet<S extends UiComponentSettings<S>>

Returns:

apply data loading settings delegate or null if not set

setApplyDataLoadingSettingsDelegate

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

Description copied from interface: SettingsFacet

Sets handler that should be invoked instead of the 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<S extends UiComponentSettings<S>>

Parameters:

delegate - handler to set

getSaveSettingsDelegate

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

Specified by:

getSaveSettingsDelegate in interface SettingsFacet<S extends UiComponentSettings<S>>

Returns:

save settings delegate or null if not set

setSaveSettingsDelegate

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

Description copied from interface: SettingsFacet

Sets handler that should be invoked instead of the 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<S extends UiComponentSettings<S>>

Parameters:

delegate - handler to set

setOwner

public <T extends com.vaadin.flow.component.Composite<?> & FacetOwner>
void setOwner(@Nullable
 T owner)

Description copied from interface: Facet

Sets an owner containing this facet.

Specified by:

setOwner in interface Facet

Overrides:

setOwner in class AbstractFacet

Type Parameters:

T - the type of the owner

Parameters:

owner - an owner containing this facet

getManagedComponentsFromCollection

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

createSettings

protected abstract S createSettings(FacetOwner owner)

initSettings

protected void initSettings(S settings)

unsubscribeOwnerLifecycle

protected abstract void unsubscribeOwnerLifecycle()

subscribeOwnerLifecycle

protected abstract void subscribeOwnerLifecycle()

applyComponentSettings

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

applyDataLoadingComponentSettings

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

saveComponentSettings

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

checkAttachedToOwner

protected void checkAttachedToOwner()

isSettingsEnabled

protected boolean isSettingsEnabled()

excludeUrlQueryParametersFacetComponents

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

getFacets

protected abstract HasFacets getFacets()

getOwnerComponent

protected com.vaadin.flow.component.Composite<?> getOwnerComponent()

createSettingsContext

protected SettingsFacet.SettingsContext<S> createSettingsContext()