Package io.jmix.ui.sys.registration

Class CustomComponentsLoaderConfig

java.lang.Object

io.jmix.ui.sys.registration.CustomComponentsLoaderConfig

All Implemented Interfaces:

LoaderConfig

@Order(110)
@Component("ui_CustomComponentsLoaderConfig")
public class CustomComponentsLoaderConfig
extends Object
implements LoaderConfig

Contains UI component loaders from add-ons and project configurations.

See Also:

• CustomComponentsRegistry

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Class<? extends ComponentLoader>>	loaders

Constructor Summary

Constructors

Constructor	Description
CustomComponentsLoaderConfig()

Method Summary

Modifier and Type	Method	Description
Class<? extends ComponentLoader>	getFragmentLoader(org.dom4j.Element root)
Class<? extends ComponentLoader>	getLoader(org.dom4j.Element element)
Class<? extends ComponentLoader>	getWindowLoader(org.dom4j.Element root)
protected void	registerLoader(String tagName, Class<? extends ComponentLoader> loaderClass)
boolean	supports(org.dom4j.Element element)	Checks whether the config contains a loader that supports the given element.

Methods inherited from class java.lang.Object

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

Field Details

loaders

protected Map<String,Class<? extends ComponentLoader>> loaders

Constructor Details

CustomComponentsLoaderConfig

public CustomComponentsLoaderConfig()

Method Details

supports

public boolean supports(org.dom4j.Element element)

Description copied from interface: LoaderConfig

Checks whether the config contains a loader that supports the given element.

Specified by:

supports in interface LoaderConfig

Parameters:

element - element

Returns:

true if the config contains suitable loader, of false otherwise

getLoader

public Class<? extends ComponentLoader> getLoader(org.dom4j.Element element)

Specified by:

getLoader in interface LoaderConfig

Parameters:

element - element to load

Returns:

ComponentLoader instance

getFragmentLoader

@Nullable
public Class<? extends ComponentLoader> getFragmentLoader(org.dom4j.Element root)

Specified by:

getFragmentLoader in interface LoaderConfig

Parameters:

root - fragment's root element

Returns:

loader class for fragment or null if config does not support given root

getWindowLoader

@Nullable
public Class<? extends ComponentLoader> getWindowLoader(org.dom4j.Element root)

Specified by:

getWindowLoader in interface LoaderConfig

Parameters:

root - window's root element

Returns:

loader class for window or null if config does not support given root

registerLoader

protected void registerLoader(String tagName,
 Class<? extends ComponentLoader> loaderClass)