Package io.jmix.flowui.facet.impl

Class ViewSettingsFacetImpl

java.lang.Object

io.jmix.flowui.facet.impl.AbstractFacet

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

io.jmix.flowui.facet.impl.ViewSettingsFacetImpl

All Implemented Interfaces:

Facet, SettingsFacet<ViewSettings>, ViewSettingsFacet

public class ViewSettingsFacetImpl
extends AbstractSettingsFacet<ViewSettings>
implements ViewSettingsFacet

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

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.flowui.facet.impl.AbstractSettingsFacet

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 AbstractSettingsFacet<ViewSettings>.OwnerEventListener	beforeShowListener
protected AbstractSettingsFacet<ViewSettings>.OwnerEventListener	detachListener
protected AbstractSettingsFacet<ViewSettings>.OwnerEventListener	queryParametersChangeListener
protected AbstractSettingsFacet<ViewSettings>.OwnerEventListener	readyListener

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

applyDataLoadingSettingsDelegate, applySettingsDelegate, auto, componentIds, componentSettings, excludedComponentIds, reflectionCacheManager, saveSettingsDelegate, settingsHelper, settingsManager, userSettingsCache, viewQueryParameters

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

id, owner

Constructor Summary

Constructors

Constructor	Description
ViewSettingsFacetImpl(SettingsFacetUrlQueryParametersHelper settingsHelper, ReflectionCacheManager reflectionCacheManager, UserSettingsCache userSettingsCache, ComponentSettingsManager settingsManager, UserSettingsService userSettingsService)

Method Summary

Modifier and Type	Method	Description
protected ViewSettings	createSettings(FacetOwner owner)
protected HasFacets	getFacets()
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)
protected void	subscribeOwnerLifecycle()
protected void	unsubscribeOwnerLifecycle()

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

addComponentIds, addExcludedComponentIds, applyComponentSettings, applyDataLoadingComponentSettings, applyDataLoadingSettings, applySettings, checkAttachedToOwner, createSettingsContext, excludeUrlQueryParametersFacetComponents, getApplyDataLoadingSettingsDelegate, getApplySettingsDelegate, getComponentIds, getExcludedComponentIds, getManagedComponents, getManagedComponentsFromCollection, getOwnerComponent, getSaveSettingsDelegate, getSettings, initSettings, isAuto, isSettingsEnabled, saveComponentSettings, saveSettings, setApplyDataLoadingSettingsDelegate, setApplySettingsDelegate, setAuto, setOwner, setSaveSettingsDelegate

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, setOwner

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

addComponentIds, addExcludedComponentIds, applyDataLoadingSettings, applySettings, getApplyDataLoadingSettingsDelegate, getApplySettingsDelegate, getComponentIds, getExcludedComponentIds, getManagedComponents, getSaveSettingsDelegate, getSettings, isAuto, saveSettings, setApplyDataLoadingSettingsDelegate, setApplySettingsDelegate, setAuto, setSaveSettingsDelegate

Field Details

beforeShowListener

protected AbstractSettingsFacet<ViewSettings>.OwnerEventListener beforeShowListener

readyListener

protected AbstractSettingsFacet<ViewSettings>.OwnerEventListener readyListener

detachListener

protected AbstractSettingsFacet<ViewSettings>.OwnerEventListener detachListener

queryParametersChangeListener

protected AbstractSettingsFacet<ViewSettings>.OwnerEventListener queryParametersChangeListener

Constructor Details

ViewSettingsFacetImpl

public ViewSettingsFacetImpl(SettingsFacetUrlQueryParametersHelper settingsHelper,
 ReflectionCacheManager reflectionCacheManager,
 UserSettingsCache userSettingsCache,
 ComponentSettingsManager settingsManager,
 @Nullable
 UserSettingsService userSettingsService)

Method Details

createSettings

protected ViewSettings createSettings(FacetOwner owner)

Specified by:

createSettings in class AbstractSettingsFacet<ViewSettings>

unsubscribeOwnerLifecycle

protected void unsubscribeOwnerLifecycle()

Specified by:

unsubscribeOwnerLifecycle in class AbstractSettingsFacet<ViewSettings>

subscribeOwnerLifecycle

protected void subscribeOwnerLifecycle()

Specified by:

subscribeOwnerLifecycle in class AbstractSettingsFacet<ViewSettings>

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)

getFacets

protected HasFacets getFacets()

Specified by:

getFacets in class AbstractSettingsFacet<ViewSettings>