Package io.jmix.flowui.xml.layout.loader.component

Class AbstractGridLoader<T extends com.vaadin.flow.component.grid.Grid<?> & EnhancedDataGrid<?> & HasActions>

java.lang.Object

io.jmix.flowui.xml.layout.loader.AbstractComponentLoader<T>

io.jmix.flowui.xml.layout.loader.component.AbstractGridLoader<T>

All Implemented Interfaces:

ComponentLoader<T>

Direct Known Subclasses:

DataGridLoader, TreeDataGridLoader

public abstract class AbstractGridLoader<T extends com.vaadin.flow.component.grid.Grid<?> & EnhancedDataGrid<?> & HasActions>
extends AbstractComponentLoader<T>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractGridLoader.GridDataHolder	Contains information about metaClass, data container, loader, fetch plan.

Nested classes/interfaces inherited from interface io.jmix.flowui.xml.layout.ComponentLoader

ComponentLoader.ComponentContext, ComponentLoader.Context, ComponentLoader.InitTask

Field Summary

Fields

Modifier and Type	Field	Description
protected ActionLoaderSupport	actionLoaderSupport
protected FetchPlanRepositoryImpl	fetchPlanRepository
protected Subscription	masterDataLoaderPostLoadListener
protected MetadataTools	metaDataTools

Fields inherited from class io.jmix.flowui.xml.layout.loader.AbstractComponentLoader

applicationContext, componentLoaderSupport, context, element, environment, factory, loaderResolver, loaderSupport, resultComponent

Constructor Summary

Constructors

Constructor	Description
AbstractGridLoader()

Method Summary

Modifier and Type	Method	Description
protected ActionLoaderSupport	getActionLoaderSupport()
protected Collection<String>	getAppliedProperties(org.dom4j.Element columnsElement, FetchPlan fetchPlan, MetaClass metaClass)
protected FetchPlanRepositoryImpl	getFetchPlanRepository()
protected MetadataTools	getMetaDataTools()
protected org.dom4j.Element	getOverriddenColumn(List<org.dom4j.Element> columns, String property)
protected AbstractGridLoader.GridDataHolder	initDataGridDataHolder()
protected void	initMasterDataLoaderListener(CollectionPropertyContainer<?> collectionContainer)
protected void	loadColumn(T component, org.dom4j.Element element, MetaClass metaClass)
protected void	loadColumns(T resultComponent, org.dom4j.Element columnsElement, MetaClass metaClass, FetchPlan fetchPlan)
protected void	loadColumnsByInclude(T component, org.dom4j.Element columnsElement, MetaClass metaClass, FetchPlan fetchPlan)
void	loadComponent()	Loads component properties by XML definition.
protected void	loadData()
protected void	loadMetaClass(org.dom4j.Element element, Consumer<MetaClass> setter)
protected void	onMasterDataLoaderPostLoad(Object o)
protected abstract void	setupDataProvider(AbstractGridLoader.GridDataHolder holder)

Methods inherited from class io.jmix.flowui.xml.layout.loader.AbstractComponentLoader

componentLoader, createComponent, getComponentContext, getContext, getElement, getFactory, getLayoutLoader, getLoaderResolver, getLoaderSupport, getResultComponent, initComponent, loadBoolean, loadBoolean, loadDouble, loadDouble, loadEnum, loadEnum, loadId, loadInteger, loadInteger, loadResourceString, loadResourceString, loadString, loadString, loadVisible, setApplicationContext, setContext, setElement, setEnvironment, setFactory, setLoaderResolver, setLoaderSupport

Methods inherited from class java.lang.Object

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

Field Details

actionLoaderSupport

protected ActionLoaderSupport actionLoaderSupport

metaDataTools

protected MetadataTools metaDataTools

masterDataLoaderPostLoadListener

protected Subscription masterDataLoaderPostLoadListener

fetchPlanRepository

protected FetchPlanRepositoryImpl fetchPlanRepository

Constructor Details

AbstractGridLoader

public AbstractGridLoader()

Method Details

loadComponent

public void loadComponent()

Description copied from interface: ComponentLoader

Loads component properties by XML definition.

See Also:

• ComponentLoader.getElement(Element)

loadData

protected void loadData()

loadColumns

protected void loadColumns(T resultComponent,
 org.dom4j.Element columnsElement,
 MetaClass metaClass,
 FetchPlan fetchPlan)

loadColumnsByInclude

protected void loadColumnsByInclude(T component,
 org.dom4j.Element columnsElement,
 MetaClass metaClass,
 FetchPlan fetchPlan)

loadColumn

protected void loadColumn(T component,
 org.dom4j.Element element,
 MetaClass metaClass)

getAppliedProperties

protected Collection<String> getAppliedProperties(org.dom4j.Element columnsElement,
 @Nullable
 FetchPlan fetchPlan,
 MetaClass metaClass)

getOverriddenColumn

@Nullable
protected org.dom4j.Element getOverriddenColumn(List<org.dom4j.Element> columns,
 String property)

loadMetaClass

protected void loadMetaClass(org.dom4j.Element element,
 Consumer<MetaClass> setter)

initMasterDataLoaderListener

protected void initMasterDataLoaderListener(CollectionPropertyContainer<?> collectionContainer)

initDataGridDataHolder

protected AbstractGridLoader.GridDataHolder initDataGridDataHolder()

onMasterDataLoaderPostLoad

protected void onMasterDataLoaderPostLoad(Object o)

getFetchPlanRepository

protected FetchPlanRepositoryImpl getFetchPlanRepository()

getActionLoaderSupport

protected ActionLoaderSupport getActionLoaderSupport()

getMetaDataTools

protected MetadataTools getMetaDataTools()

setupDataProvider

protected abstract void setupDataProvider(AbstractGridLoader.GridDataHolder holder)