Package io.jmix.ui.settings.facet

Class ScreenSettingsFacetImpl

java.lang.Object

io.jmix.ui.component.impl.AbstractFacet

io.jmix.ui.settings.facet.ScreenSettingsFacetImpl

All Implemented Interfaces:

Facet, ScreenSettingsFacet, ScreenSettingsFacetResolver.AfterShowEventHandler

public class ScreenSettingsFacetImpl
extends AbstractFacet
implements ScreenSettingsFacet, ScreenSettingsFacetResolver.AfterShowEventHandler

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.settings.facet.ScreenSettingsFacet

ScreenSettingsFacet.SettingsContext

Field Summary

Fields

Modifier and Type	Field	Description
protected Subscription	afterDetachedSubscription
protected Subscription	afterShowSubscription
protected Consumer<ScreenSettingsFacet.SettingsContext>	applyDataLoadingSettingsDelegate
protected Consumer<ScreenSettingsFacet.SettingsContext>	applySettingsDelegate
protected boolean	auto
protected org.springframework.beans.factory.BeanFactory	beanFactory
protected Subscription	beforeShowSubscription
protected Set<String>	componentIds
protected Set<String>	excludedComponentIds
protected boolean	isAfterShowHandled
protected Consumer<ScreenSettingsFacet.SettingsContext>	saveSettingsDelegate
protected ScreenSettings	screenSettings
protected ScreenSettingsFacetResolver	settingsFacetResolver
protected ScreenSettingsManager	settingsManager

Fields inherited from class io.jmix.ui.component.impl.AbstractFacet

id, owner

Constructor Summary

Constructors

Constructor	Description
ScreenSettingsFacetImpl()

Method Summary

Modifier and Type	Method	Description
void	addComponentIds(String... ids)	Adds component ids that should be handled when ScreenSettingsFacet.isAuto() returns false.
protected void	applyDataLoadingScreenSettings(Collection<Component> components)
void	applyDataLoadingSettings()	Applies data loading settings.
void	applyDataLoadingSettings(Collection<Component> components)	Applies data loading settings for the components collection.
protected void	applyScreenSettings(Collection<Component> components)
void	applySettings()	Applies screen settings.
void	applySettings(Collection<Component> components)	Applies screen settings for the components collection.
protected void	checkAttachedFrame()
void	excludeComponentIds(String... ids)	Adds component ids that should be excluded from applying and saving settings.
protected Collection<Component>	fillComponents(Collection<Component> components)
protected Collection<Component>	fillWithInnerComponents(Collection<Component> components, HasInnerComponents hasInnerComponents)
protected Collection<Component>	filterByManagedComponents(Collection<Component> components)
Consumer<ScreenSettingsFacet.SettingsContext>	getApplyDataLoadingSettingsDelegate()
Consumer<ScreenSettingsFacet.SettingsContext>	getApplySettingsDelegate()
Set<String>	getComponentIds()
Collection<Component>	getComponents()	Collection depends on ScreenSettingsFacet.isAuto() property.
Set<String>	getExcludedComponentIds()
Consumer<ScreenSettingsFacet.SettingsContext>	getSaveSettingsDelegate()
protected Screen	getScreenOwner()
ScreenSettings	getSettings()
boolean	isAuto()
protected boolean	isSettingsEnabled()
protected void	onAfterDetachEvent(Screen.AfterDetachEvent event)
void	onAfterShowEvent(Screen.AfterShowEvent event)
protected void	onBeforeShowEvent(Screen.BeforeShowEvent event)
protected void	saveScreenSettings(Collection<Component> components)
void	saveSettings()	Saves and persist settings.
void	saveSettings(Collection<Component> components)	Saves and persist settings for the components collection.
void	setApplyDataLoadingSettingsDelegate(Consumer<ScreenSettingsFacet.SettingsContext> delegate)	Sets apply data loading settings delegate.
void	setApplySettingsDelegate(Consumer<ScreenSettingsFacet.SettingsContext> delegate)	Sets apply settings delegate.
void	setAuto(boolean auto)	Set to true if facet should apply and save settings for all supported component in the screen.
void	setOwner(Frame owner)	Sets owner frame (Window or Fragment) to the facet.
void	setSaveSettingsDelegate(Consumer<ScreenSettingsFacet.SettingsContext> delegate)	Set save settings delegate.
protected void	subscribe()
protected void	unsubscribe()

Methods inherited from class io.jmix.ui.component.impl.AbstractFacet

getEventHub, getId, getOwner, hasSubscriptions, publish, setId, unsubscribe

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.ui.component.Facet

getId, getOwner, setId

Field Details

componentIds

protected Set<String> componentIds

excludedComponentIds

protected Set<String> excludedComponentIds

auto

protected boolean auto

isAfterShowHandled

protected boolean isAfterShowHandled

screenSettings

protected ScreenSettings screenSettings

applySettingsDelegate

protected Consumer<ScreenSettingsFacet.SettingsContext> applySettingsDelegate

applyDataLoadingSettingsDelegate

protected Consumer<ScreenSettingsFacet.SettingsContext> applyDataLoadingSettingsDelegate

saveSettingsDelegate

protected Consumer<ScreenSettingsFacet.SettingsContext> saveSettingsDelegate

beforeShowSubscription

protected Subscription beforeShowSubscription

afterShowSubscription

protected Subscription afterShowSubscription

afterDetachedSubscription

protected Subscription afterDetachedSubscription

settingsManager

@Autowired(required=false)
protected ScreenSettingsManager settingsManager

settingsFacetResolver

@Autowired
protected ScreenSettingsFacetResolver settingsFacetResolver

beanFactory

@Autowired
protected org.springframework.beans.factory.BeanFactory beanFactory

Constructor Details

ScreenSettingsFacetImpl

public ScreenSettingsFacetImpl()

Method Details

getSettings

public ScreenSettings getSettings()

Specified by:

getSettings in interface ScreenSettingsFacet

Returns:

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

applySettings

public void applySettings()

Description copied from interface: ScreenSettingsFacet

Applies screen settings. By default facet applies setting on Screen.AfterShowEvent.

Specified by:

applySettings in interface ScreenSettingsFacet

applySettings

public void applySettings(Collection<Component> components)

Description copied from interface: ScreenSettingsFacet

Applies screen settings for the components collection. Window must contains these components, otherwise they will be ignored.

Specified by:

applySettings in interface ScreenSettingsFacet

Parameters:

components - components to apply

applyDataLoadingSettings

public void applyDataLoadingSettings()

Description copied from interface: ScreenSettingsFacet

Applies data loading settings. By default facet applies data loading settings on Screen.BeforeShowEvent.

Specified by:

applyDataLoadingSettings in interface ScreenSettingsFacet

applyDataLoadingSettings

public void applyDataLoadingSettings(Collection<Component> components)

Description copied from interface: ScreenSettingsFacet

Applies data loading settings for the components collection. Window must contains these components, otherwise they will be ignored.

Specified by:

applyDataLoadingSettings in interface ScreenSettingsFacet

Parameters:

components - components to apply

saveSettings

public void saveSettings()

Description copied from interface: ScreenSettingsFacet

Saves and persist settings. By default facet saves settings on Screen.AfterDetachEvent.

Specified by:

saveSettings in interface ScreenSettingsFacet

saveSettings

public void saveSettings(Collection<Component> components)

Description copied from interface: ScreenSettingsFacet

Saves and persist settings for the components collection. Window must contains these components, otherwise they will be ignored.

Specified by:

saveSettings in interface ScreenSettingsFacet

Parameters:

components - components to save

isAuto

public boolean isAuto()

Specified by:

isAuto in interface ScreenSettingsFacet

Returns:

true if facet should apply and save settings for all supported component in the screen. False by default.

setAuto

public void setAuto(boolean auto)

Description copied from interface: ScreenSettingsFacet

Set to true if facet should apply and save settings for all supported component in the screen. False by default.

Specified by:

setAuto in interface ScreenSettingsFacet

Parameters:

auto - whether facet should include all components for saving settings

addComponentIds

public void addComponentIds(String... ids)

Description copied from interface: ScreenSettingsFacet

Adds component ids that should be handled when ScreenSettingsFacet.isAuto() returns false.

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

Specified by:

addComponentIds in interface ScreenSettingsFacet

Parameters:

ids - component ids

getComponentIds

public Set<String> getComponentIds()

Specified by:

getComponentIds in interface ScreenSettingsFacet

Returns:

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

excludeComponentIds

public void excludeComponentIds(String... ids)

Description copied from interface: ScreenSettingsFacet

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

Specified by:

excludeComponentIds in interface ScreenSettingsFacet

Parameters:

ids - component ids to exclude

getExcludedComponentIds

public Set<String> getExcludedComponentIds()

Specified by:

getExcludedComponentIds in interface ScreenSettingsFacet

Returns:

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

getComponents

public Collection<Component> getComponents()

Description copied from interface: ScreenSettingsFacet

Collection depends on ScreenSettingsFacet.isAuto() property. If ScreenSettingsFacet.isAuto() returns true collection will be filled by Window's components, otherwise collection will be filled by components were added by ScreenSettingsFacet.addComponentIds(String...).

Specified by:

getComponents in interface ScreenSettingsFacet

Returns:

components collection that is used for applying and saving settings.

getApplySettingsDelegate

public Consumer<ScreenSettingsFacet.SettingsContext> getApplySettingsDelegate()

Specified by:

getApplySettingsDelegate in interface ScreenSettingsFacet

Returns:

apply settings delegate or null if not set

setApplySettingsDelegate

public void setApplySettingsDelegate(Consumer<ScreenSettingsFacet.SettingsContext> delegate)

Description copied from interface: ScreenSettingsFacet

Sets apply settings delegate. It will replace default behavior of facet and will be invoked on Screen.AfterShowEvent.

Note, it also will be invoked when lazy tab from TabSheet or Accordion is opened.

For instance:

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

Specified by:

setApplySettingsDelegate in interface ScreenSettingsFacet

Parameters:

delegate - apply settings delegate

getApplyDataLoadingSettingsDelegate

public Consumer<ScreenSettingsFacet.SettingsContext> getApplyDataLoadingSettingsDelegate()

Specified by:

getApplyDataLoadingSettingsDelegate in interface ScreenSettingsFacet

Returns:

apply data loading settings delegate or null if not set

setApplyDataLoadingSettingsDelegate

public void setApplyDataLoadingSettingsDelegate(Consumer<ScreenSettingsFacet.SettingsContext> delegate)

Description copied from interface: ScreenSettingsFacet

Sets apply data loading settings delegate. It will replace default behavior of facet and will be invoked on Screen.BeforeShowEvent.

For instance:

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

Specified by:

setApplyDataLoadingSettingsDelegate in interface ScreenSettingsFacet

Parameters:

delegate - apply settings delegate

getSaveSettingsDelegate

public Consumer<ScreenSettingsFacet.SettingsContext> getSaveSettingsDelegate()

Specified by:

getSaveSettingsDelegate in interface ScreenSettingsFacet

Returns:

save settings delegate or null if not set

setSaveSettingsDelegate

public void setSaveSettingsDelegate(Consumer<ScreenSettingsFacet.SettingsContext> delegate)

Description copied from interface: ScreenSettingsFacet

Set save settings delegate. It will replace default behavior of facet and will be invoked on Screen.AfterDetachEvent.

For instance:

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

Specified by:

setSaveSettingsDelegate in interface ScreenSettingsFacet

Parameters:

delegate - save settings delegate

setOwner

public void setOwner(@Nullable
 Frame owner)

Description copied from interface: Facet

Sets owner frame (Window or Fragment) to the facet.

Specified by:

setOwner in interface Facet

Overrides:

setOwner in class AbstractFacet

Parameters:

owner - owner frame

subscribe

protected void subscribe()

unsubscribe

protected void unsubscribe()

getScreenOwner

@Nullable
protected Screen getScreenOwner()

onBeforeShowEvent

protected void onBeforeShowEvent(Screen.BeforeShowEvent event)

onAfterShowEvent

public void onAfterShowEvent(Screen.AfterShowEvent event)

Specified by:

onAfterShowEvent in interface ScreenSettingsFacetResolver.AfterShowEventHandler

onAfterDetachEvent

protected void onAfterDetachEvent(Screen.AfterDetachEvent event)

applyScreenSettings

protected void applyScreenSettings(Collection<Component> components)

applyDataLoadingScreenSettings

protected void applyDataLoadingScreenSettings(Collection<Component> components)

saveScreenSettings

protected void saveScreenSettings(Collection<Component> components)

isSettingsEnabled

protected boolean isSettingsEnabled()

filterByManagedComponents

protected Collection<Component> filterByManagedComponents(Collection<Component> components)

checkAttachedFrame

protected void checkAttachedFrame()

fillComponents

protected Collection<Component> fillComponents(Collection<Component> components)

fillWithInnerComponents

protected Collection<Component> fillWithInnerComponents(Collection<Component> components,
 HasInnerComponents hasInnerComponents)