io.jmix.ui.settings.facet

Interface ScreenSettingsFacet

All Superinterfaces:

Facet

All Known Implementing Classes:

ScreenSettingsFacetImpl

@StudioFacet(xmlElement="screenSettings",
             caption="ScreenSettings",
             category="Facets",
             description="Provides ability to save and apply component settings",
             defaultProperty="auto",
             icon="io/jmix/ui/icon/facet/screenSettings.svg")
public interface ScreenSettingsFacet
extends Facet

Provides ability to save and apply component settings.

See Also:

ComponentSettings, ComponentSettingsBinder

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ScreenSettingsFacet.SettingsContext Provides information about source component and its child components.

Method Summary

Modifier and Type	Method and Description
void	addComponentIds(java.lang.String... ids) Adds component ids that should be handled when isAuto() returns false.
void	applyDataLoadingSettings() Applies data loading settings.
void	applyDataLoadingSettings(java.util.Collection<Component> components) Applies data loading settings for the components collection.
void	applySettings() Applies screen settings.
void	applySettings(java.util.Collection<Component> components) Applies screen settings for the components collection.
java.util.function.Consumer<ScreenSettingsFacet.SettingsContext>	getApplyDataLoadingSettingsDelegate()
java.util.function.Consumer<ScreenSettingsFacet.SettingsContext>	getApplySettingsDelegate()
java.util.Set<java.lang.String>	getComponentIds()
java.util.Collection<Component>	getComponents() Collection depends on isAuto() property.
java.util.function.Consumer<ScreenSettingsFacet.SettingsContext>	getSaveSettingsDelegate()
ScreenSettings	getSettings()
boolean	isAuto()
void	saveSettings() Saves and persist settings.
void	saveSettings(java.util.Collection<Component> components) Saves and persist settings for the components collection.
void	setApplyDataLoadingSettingsDelegate(java.util.function.Consumer<ScreenSettingsFacet.SettingsContext> delegate) Sets apply data loading settings delegate.
void	setApplySettingsDelegate(java.util.function.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	setSaveSettingsDelegate(java.util.function.Consumer<ScreenSettingsFacet.SettingsContext> delegate) Set save settings delegate.

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

getId, getOwner, setId, setOwner

Method Detail

isAuto

boolean isAuto()

Returns:

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

setAuto

@StudioProperty(defaultValue="false",
                initialValue="true")
void setAuto(boolean auto)

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

Parameters:

auto - whether facet should include all components for saving settings

addComponentIds

void addComponentIds(java.lang.String... ids)

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

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

Parameters:

ids - component ids

getComponentIds

java.util.Set<java.lang.String> getComponentIds()

Returns:

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

getComponents

java.util.Collection<Component> getComponents()

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

Returns:

components collection that is used for applying and saving settings.

getSettings

@Nullable
ScreenSettings getSettings()

Returns:

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

applySettings

void applySettings()

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

applySettings

void applySettings(java.util.Collection<Component> components)

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

Parameters:

components - components to apply

applyDataLoadingSettings

void applyDataLoadingSettings()

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

applyDataLoadingSettings

void applyDataLoadingSettings(java.util.Collection<Component> components)

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

Parameters:

components - components to apply

saveSettings

void saveSettings()

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

saveSettings

void saveSettings(java.util.Collection<Component> components)

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

Parameters:

components - components to save

getApplySettingsDelegate

@Nullable
java.util.function.Consumer<ScreenSettingsFacet.SettingsContext> getApplySettingsDelegate()

Returns:

apply settings delegate or null if not set

setApplySettingsDelegate

void setApplySettingsDelegate(java.util.function.Consumer<ScreenSettingsFacet.SettingsContext> delegate)

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 onApplySetting(SettingsSet settings) {
          settingsFacet.applySettings(settings);
      }
 

Parameters:

delegate - apply settings delegate

getApplyDataLoadingSettingsDelegate

@Nullable
java.util.function.Consumer<ScreenSettingsFacet.SettingsContext> getApplyDataLoadingSettingsDelegate()

Returns:

apply data loading settings delegate or null if not set

setApplyDataLoadingSettingsDelegate

void setApplyDataLoadingSettingsDelegate(java.util.function.Consumer<ScreenSettingsFacet.SettingsContext> delegate)

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 onApplyDataLoadingSetting(SettingsSet settings) {
          settingsFacet.applyDataLoadingSettings(settings);
      }
 

Parameters:

delegate - apply settings delegate

getSaveSettingsDelegate

@Nullable
java.util.function.Consumer<ScreenSettingsFacet.SettingsContext> getSaveSettingsDelegate()

Returns:

save settings delegate or null if not set

setSaveSettingsDelegate

void setSaveSettingsDelegate(java.util.function.Consumer<ScreenSettingsFacet.SettingsContext> delegate)

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 onSaveSetting(SettingsSet settings) {
          settingsFacet.saveSettings(settings);
      }
 

Parameters:

delegate - save settings delegate