Package io.jmix.flowui.xml.facet

Class SettingsFacetProvider

java.lang.Object

io.jmix.flowui.xml.facet.SettingsFacetProvider

All Implemented Interfaces:

FacetProvider<SettingsFacet>

@Deprecated(since="2.8",
            forRemoval=true)
@Component("flowui_SettingsFacetProvider")
public class SettingsFacetProvider
extends Object
implements FacetProvider<SettingsFacet>

Deprecated, for removal: This API element is subject to removal in a future version.

use FacetRegistrationBuilder instead

Field Summary

Fields

Modifier and Type	Field	Description
protected LoaderSupport	loaderSupport	Deprecated, for removal: This API element is subject to removal in a future version.
protected ReflectionCacheManager	reflectionCacheManager	Deprecated, for removal: This API element is subject to removal in a future version.
protected SettingsFacetUrlQueryParametersHelper	settingsHelper	Deprecated, for removal: This API element is subject to removal in a future version.
protected ComponentSettingsManager	settingsManager	Deprecated, for removal: This API element is subject to removal in a future version.
protected UserSettingsCache	userSettingsCache	Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Summary

Constructors

Constructor	Description
SettingsFacetProvider(LoaderSupport loaderSupport, SettingsFacetUrlQueryParametersHelper settingsHelper, ReflectionCacheManager reflectionCacheManager, UserSettingsCache userSettingsCache, ComponentSettingsManager settingsManager, UserSettingsService userSettingsService)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
SettingsFacet	create()	Deprecated, for removal: This API element is subject to removal in a future version.
protected List<String>	filterExcludedIds(Map<String,Boolean> components)	Deprecated, for removal: This API element is subject to removal in a future version.
protected List<String>	filterIncludedIds(Map<String,Boolean> components)	Deprecated, for removal: This API element is subject to removal in a future version.
Class<SettingsFacet>	getFacetClass()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getFacetTag()	Deprecated, for removal: This API element is subject to removal in a future version.
protected Map<String,Boolean>	loadComponents(ComponentLoader.ComponentContext context, org.dom4j.Element root)	Deprecated, for removal: This API element is subject to removal in a future version.
void	loadFromXml(SettingsFacet facet, org.dom4j.Element element, ComponentLoader.ComponentContext context)	Deprecated, for removal: This API element is subject to removal in a future version. Loads properties of the facet from XML.

Methods inherited from class java.lang.Object

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

Field Details

loaderSupport

protected LoaderSupport loaderSupport

Deprecated, for removal: This API element is subject to removal in a future version.

settingsHelper

protected SettingsFacetUrlQueryParametersHelper settingsHelper

Deprecated, for removal: This API element is subject to removal in a future version.

reflectionCacheManager

protected ReflectionCacheManager reflectionCacheManager

Deprecated, for removal: This API element is subject to removal in a future version.

settingsManager

protected ComponentSettingsManager settingsManager

Deprecated, for removal: This API element is subject to removal in a future version.

userSettingsCache

protected UserSettingsCache userSettingsCache

Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Details

SettingsFacetProvider

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

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

getFacetClass

public Class<SettingsFacet> getFacetClass()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getFacetClass in interface FacetProvider<SettingsFacet>

Returns:

facet interface

create

public SettingsFacet create()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

create in interface FacetProvider<SettingsFacet>

Returns:

new instance of the facet class

getFacetTag

public String getFacetTag()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getFacetTag in interface FacetProvider<SettingsFacet>

Returns:

facet XML tag

loadFromXml

public void loadFromXml(SettingsFacet facet,
 org.dom4j.Element element,
 ComponentLoader.ComponentContext context)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: FacetProvider

Loads properties of the facet from XML.

Specified by:

loadFromXml in interface FacetProvider<SettingsFacet>

Parameters:

facet - facet

element - XML element

context - loading context

filterIncludedIds

protected List<String> filterIncludedIds(Map<String,Boolean> components)

Deprecated, for removal: This API element is subject to removal in a future version.

filterExcludedIds

protected List<String> filterExcludedIds(Map<String,Boolean> components)

Deprecated, for removal: This API element is subject to removal in a future version.

loadComponents

protected Map<String,Boolean> loadComponents(ComponentLoader.ComponentContext context,
 org.dom4j.Element root)

Deprecated, for removal: This API element is subject to removal in a future version.